Ga naar hoofdinhoud

Financial claims information document v2.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 wordt 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 groep heeft een eigen kenmerk (bijv. zaakkenmerk en verplichtingskenmerk) en in sommige gevallen wordt er ook naar kenmerken verwezen (zoals een achterstand die verwijst naar een betalingsverplichting).

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.

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

Indien een array niet verplicht is, dan wordt de er een lege lijst in het bericht opgenomen.

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
bodyJa (max 1)objectBevat 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.
financiele_zakenNee (0..n)arrayDe groep voor financiële zaken.
Zie financiele_zaken hieronder voor de specificatie.

financiele_zaken

Zie Financiële zaak voor de definitie en meer informatie.

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.
omschrijvingJastring"Verkeersboete"Omschrijving van de financiële zaak, gelijk aan de omschrijving van de primaire financiële verplichting.
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.
financiele_verplichtingenNee (0..n)arrayDe lijst van individuele financiële verplichtingen. Er dient minimaal 1 financiële verplichting te zijn.
Zie financiele_verplichtingen hieronder voor de specificatie.
betalingsverplichtingenNee (0..n)arrayDe lijst van individuele betalingsverplichtingen.
Zie betalingsverplichtingen hieronder voor de specificatie.
betalingenNee (0..n)arrayDe lijst van individuele betalingen.
Zie betalingen hieronder voor de specificatie.
achterstandenNee(0..n)arrayDe lijst van individuele betalingsachterstanden.
Zie achterstanden hieronder voor de specificatie.

financiele_verplichtingen

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

AttribuutVerplichtTypeVoorbeeldOmschrijving
gebeurtenisJastring"FinancieleVerplichtingOpgelegd"Het type gebeurtenis die heeft geleid tot de financiële verplichting.
Dit is een beperkte lijst van mogelijke gebeurtenissen:
- "FinancieleVerplichtingOpgelegd"
Zie pagina Gebeurtenissen voor meer informatie
verplichtingskenmerkJastring"81029991234567891-1"Uniek en constant kenmerk van de financiële verplichting.
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.
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.
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 het type verplichting zoals gespecificeerd in Zie pagina Typen financiële verplichtingen voor de lijst.
TODO: Hebben we het hier over de naam vordering? Kijken of we hier een afkorting voor moeten toevoegen.
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.

betalingsverplichtingen

Zie pagina Terminologie voor meer informatie over de betalingsverplichting.

AttribuutVerplichtTypeVoorbeeldOmschrijving
gebeurtenisJastring"BetalingsVerplichtingOpgelegd"Het type gebeurtenis die heeft geleid tot de betalingsverplichting.
Dit is een beperkte lijst van mogelijke gebeurtenissen:
- "BetalingsVerplichtingOpgelegd"
Zie pagina Gebeurtenissen voor meer informatie
betalingsverplichtingkenmerkJastring"81029991234567891-3"Uniek en constant kenmerk van de betalingsverplichting
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. Deze moet gelijk zijn als het BSN in het oorspronkelijke verzoek. Zie pagina Terminologie voor meer informatie over de Burger.
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.

betalingen

Zie pagina Terminologie voor meer informatie over de betaling.

AttribuutVerplichtTypeVoorbeeldOmschrijving
gebeurtenisJastring"BetalingVerwerkt"Het type gebeurtenis die heeft geleid tot de betaling.
Dit is een beperkte lijst van mogelijke gebeurtenissen:
- "BetalingVerwerkt"
Zie pagina Gebeurtenissen voor meer informatie
verwerktebetalingkenmerkJastring"81029991234567891-4"Uniek en constant kenmerk van de betalingsverplichting.
datumtijd_verwerktJastring"2022-07-21T00:00:00+00:00"De datum en tijd waarop de betaling is verwerkt.
betalingskenmerkJastring"81029991234567891"Het betalingskenmerk wat 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.

TODO: nog een definitie op de terminologie pagina?

AttribuutMandatoryTypeVoorbeeldOmschrijving
achterstandenNeearray/string"81029991234567891-4"Verwijzing naar de betalingsverplichtingkenmerk waarvoor een achterstand geldt.

Example

{
"type": "FINANCIAL_CLAIMS_INFORMATION_DOCUMENT",
"version": "2", //Integer
"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",
"financiele_verplichtingen": [
{
"gebeurtenis": "FinancieleVerplichtingOpgelegd",
"verplichtingskenmerk": "81029991234567891-1",
"datumtijd_opgelegd": "2022-07-12T00:00:00+00:00",
"zaakkenmerk": "81029991234567891",
"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": "FinancieleVerplichtingOpgelegd",
"verplichtingskenmerk": "81029991234567891-2",
"datumtijd_opgelegd": "2022-07-12T00:00:00+00:00",
"zaakkenmerk": "81029991234567891",
"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"
}
],
"betalingsverplichtingen": [
{
"gebeurtenis": "BetalingsVerplichtingOpgelegd",
"betalingsverplichtingkenmerk": "81029991234567891-3",
"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"
}
],
"betalingen": [
{
"gebeurtenis": "BetalingVerwerkt",
"verwerktebetalingkenmerk": "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"]
/* "possible_actions": [
{
// TODO: nader uitwerken
"action_type": [
"payment",
"mijn-omgeving",
"email",
"bellen",
"..."
]
}
]*/
}
]
}
}