Ga naar inhoud

Uitwisselmodel

Inleiding

De uitwisselspecificatie specificeert welke gegevens en in welke vorm de gegevens aan het CBS aangeleverd dienen te worden. Hiertoe is een specificatie in JSON-schema gespecificeerd. De inhoud van deze JSON-schema is afgeleid van het informatiemodel schuldhulpverlening.

De uitwisselspecificatie kent de volgende opbouw:

  1. Op het hoofdniveau is het Uitwisselmodel gedefinieerd. Dit met een aantal attributen die informatie geven over de levering: start- en einddatum van de levering en de aanleverdattum en tijd;
  2. Op het tweede niveau is het mogelijk gemaakt meerdere leveringen in te voegen. Dit maakt het mogelijk voor cloud-leveranciers voor meerdere schuldhulpverlenende organisaties in 1 bestand aan te leveren, mits daar natuurlijk toestemming voor is afgegeven.
  3. Op het derde niveau wordt per levering de aanleverende schuldhulporganisatie met de bijbehorende schuldhultrajecten aangeleverd. Er wordt vanuit gegaan dat er per levering steeds door precies één schuldhulporganisatie gegevens worden aangeleverd. Steeds worden alle lopende trajecten met overlap met de periode tussen startdatum en einddatum van de uitvraag aangeboden.
  4. Op detailniveau wordt een aantal schuldhulptrajecten aangeleverd. Dit met de verschillende fases die de trajecten hebben doorlopen volgens het procesmodel, en de client(en) die het betreft. Per schuldhulptraject worden de schulden opgegeven die binnen de scope van het traject vallen. Per traject wordt ook de gemeente opgegeven die verantwoordelijk is voor het schuldhulptraject.

Vanuit verschillende aanleveringen kunnen gegevens worden aangeleverd die hetzelfde traject betreffen. De trajecten worden dan uitgebreid met de nieuwe gegevens. Het gaat om hetzelfde traject als:

  1. Er overlap is in de looptijd; EN
  2. Het dezelfde clienten betreft (clienten kunnen maar 1 traject tegelijk hebben gedurende 1 periode. Wel kunnen zij sequentieel meerdere trajecten hebben)

Aan het eind van de specficatie staan de gebruikte datatypes en waardenlijsten (enumeraties) die worden gebruikt opgenomen.

Encoding

Alle bestanden dienen te worden aangeleverd in UTF-8-formaat.

Uitwisselspecificatie

Onderstaand de definitie van de uitwisselspecificatie. Van deze definitie is ook een downloadversie beschikbaar.

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://raw.githubusercontent.com/VNG-Realisatie/ddas/main/v1.0/json_schema_Uitwisselmodel.json",
    "title": "Uitwisselmodel",
    "type": "object",
    "description": "Het uitwisselmodel is een model dat de gegevens bevat die uitgewisseld worden tussen de verschillende partijen.",
    "properties": {
        "startdatumLevering": {
            "$ref": "#/$defs/datum"
        },
        "einddatumLevering": {
            "$ref": "#/$defs/datum"
        },
        "aanleverdatumEnTijd": {
            "$ref": "#/$defs/datum-tijd"
        },
        "codeGegevensleverancier": {
            "description": "Code van de gegevensleverancier (softwareleverancier of hosting partij) die de gegevens voor 1 of meer partijen levert.",
            "type": "string"
        },
        "leveringen": {
            "type": "array",
            "minItems": 1,
            "items": {
                "type": "object",
                "description": "Een levering is steeds een schuldhulporganisatie met daarbij een verzameling van schuldhulptrajecten die op een bepaald moment worden aangeleverd.",
                "properties": {
                    "teller": {
                        "description": "Teller van het aantal leveringen dat in het bestand is opgenomen.",
                        "type": "integer"
                    },
                    "aanleverende_organisatie": {
                        "type": "object",
                        "description": "Een schuldhulporganisatie is een instantie die individuen en gezinnen helpt met het beheren, verminderen en oplossen van hun schulden door middel van advies, begeleiding en bemiddeling.\nHet betreft een gemeenten of een SHV-organisatie die de gemeentelijke schuldhulpverleningstaak vanuit een gemeente gemandateerd of gedelegeerd heeft. \n",
                        "properties": {
                            "(Statutaire) Naam": {
                                "description": "Naam van de niet-natuurlijke persoon zoals deze is vastgelegd in de statuten (rechtspersoon) of in de vennootschapsovereenkomst is overeengekomen (Vennootschap onder firma of Commanditaire vennootschap).",
                                "type": "string"
                            },
                            "KvK-nummer": {
                                "description": "Landelijk uniek identificerend administratienummer van een MAATSCHAPPELIJKE ACTIVITEIT behorend bij een SUBJECT zoals toegewezen door de Kamer van Koophandel (KvK).",
                                "type": "string"
                            },
                            "postcode": {
                                "type": "string"
                            },
                            "gemeentecode": {
                                "description": "De gemeentecode als de aanleverende organisatie een gemeente is.",
                                "type": "string"
                            },
                            "contactpersonen": {
                                "type": "array",
                                "minItems": 1,
                                "items": {
                                    "type": "object",
                                    "description": "Contactpersoon van de organisatie waarvan de gegevens worden aangeleverd.",
                                    "properties": {
                                        "email": {
                                            "$ref": "#/$defs/email"
                                        },
                                        "functietitel": {
                                            "type": "string"
                                        },
                                        "naam": {
                                            "type": "string"
                                        },
                                        "telefoonnummer": {
                                            "type": "string"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "schuldhulptrajecten": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "description": "Samenstel van achtereenvolgens uit te voeren en onderling samenhangende deelhandelingen of van opeenvolgende stadia in een proces, voorgesteld als een route die via opeenvolgende bestemmingen naar de eindbestemming voert.",
                            "properties": {
                                "einddatum": {
                                    "$ref": "#/$defs/datum"
                                },
                                "omschrijving": {
                                    "type": "string"
                                },
                                "startdatum": {
                                    "$ref": "#/$defs/datum"
                                },
                                "toekenningsdatum": {
                                    "$ref": "#/$defs/datum"
                                },
                                "totaalSchuldbedragBijAanvangSchuld": {
                                    "description": "Bedrag in hele euro's nauwkeurig voor elke schuld die meegaat in de schuldregeling. Per schuldeiser kunnen er meerdere openstaande schulden zijn. Deze afzonderlijk meenemen.",
                                    "$ref": "#/$defs/bedrag"
                                },
                                "gemeentecode": {
                                    "description": "De gemeentecode van de gemeente onder wiens verantwoordelijkheid het schuldhulptraject wordt uitgevoerd.",
                                    "type": "string"
                                },
                                "aanmelding": {
                                    "type": "object",
                                    "description": "Moment dat een persoon met een hulpvraag komt rondom (dreigende) schulden. Dit kan een persoonlijke, schriftelijke, digitale of telefonische vraag zijn. ",
                                    "properties": {
                                        "crisisinterventie": {
                                            "description": "Is er sprake van een crisisinterventie? Indicator crisisinterventie. \"Het afwenden van een crisis- of dreigende situatie om zo de mogelijkheid te creëren om de klant te helpen via de reguliere schuldhulpverlening.\nVolgens de Wgs gaat het in elk geval om de volgende situaties:\n\u25a0 gedwongen woningontruiming;\n\u25a0 beëindiging van de levering van gas, water, elektriciteit of stadsverwarming;\n\u25a0 opzegging of ontbinding van de zorgverzekering.\nGemeenten kunnen extra situaties toevoegen aan hun crisisprotocol, zoals:\n\u25a0 aangekondigde boedelverkoop of verkoop van de eigen woning;\n\u25a0 loon- of bankbeslag;\n\u25a0 een faillissementsaanvraag.\nEn voor ondernemers:\n\u25a0 beslag op (on)roerende zaken dat het voortbestaan van de onderneming bedreigt;\n\u25a0 opzegging van het bankkrediet.\"",
                                            "type": "boolean"
                                        },
                                        "einddatum": {
                                            "$ref": "#/$defs/datum"
                                        },
                                        "startdatum": {
                                            "description": "Datum waarop een persoon met een hulpvraag komt rondom (dreigende) schulden. Dit kan een persoonlijke, schriftelijke, digitale of telefonische vraag zijn. ",
                                            "$ref": "#/$defs/datum"
                                        }
                                    }
                                },
                                "begeleiding": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "description": "Begeleiding voor clienten in het kader van schuldhulpdienstverlening, die kan bestaan uit:\n1. budgetbeheer\n2. beschermingsbewind\n3. budgetcoaching\n",
                                        "properties": {
                                            "einddatum": {
                                                "$ref": "#/$defs/datum"
                                            },
                                            "soort": {
                                                "$ref": "#/$defs/EnumBegeleidingssoort"
                                            },
                                            "startdatum": {
                                                "$ref": "#/$defs/datum"
                                            }
                                        }
                                    }
                                },
                                "client": {
                                    "type": "array",
                                    "minItems": 1,
                                    "maxItems": 2,
                                    "items": {
                                        "type": "object",
                                        "description": "Een ingeschreven persoon die gebruik maakt van producten en diensten van de gemeente binnen de sociaal domein.",
                                        "properties": {
                                            "Burgerservicenummer": {
                                                "type": "string"
                                            },
                                            "Geboortedatum": {
                                                "description": "De datum waarop de ander natuurlijk persoon is geboren.",
                                                "type": "string"
                                            },
                                            "Geslachtsaanduiding": {
                                                "description": "Een aanduiding die aangeeft dat de ingeschrevene een man of een vrouw is, of dat het geslacht (nog) onbekend is.",
                                                "type": "string"
                                            },
                                            "Postcode": {
                                                "type": "string"
                                            },
                                            "Huisnummer": {
                                                "type": "string"
                                            },
                                            "Huisnummertoevoeging": {
                                                "type": "string"
                                            }
                                        }
                                    }
                                },
                                "crisisinterventies": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "description": "Het afwenden van een crisis- of dreigende situatie om zo de mogelijkheid te creëren om de klant te helpen via de reguliere schuldhulpverlening.\nVolgens de Wgs gaat het in elk geval om de volgende situaties:\n\u25a0 gedwongen woningontruiming;\n\u25a0 beëindiging van de levering van gas, water, elektriciteit of stadsverwarming;\n\u25a0 opzegging of ontbinding van de zorgverzekering.\nGemeenten kunnen extra situaties toevoegen aan hun crisisprotocol, zoals:\n\u25a0 aangekondigde boedelverkoop of verkoop van de eigen woning;\n\u25a0 loon- of bankbeslag;\n\u25a0 een faillissementsaanvraag.\nEn voor ondernemers:\n\u25a0 beslag op (on)roerende zaken dat het voortbestaan van de onderneming bedreigt;\n\u25a0 opzegging van het bankkrediet.\n",
                                        "properties": {
                                            "einddatum": {
                                                "$ref": "#/$defs/datum"
                                            },
                                            "startdatum": {
                                                "$ref": "#/$defs/datum"
                                            }
                                        }
                                    }
                                },
                                "informatieEnAdvies": {
                                    "type": "object",
                                    "properties": {
                                        "einddatum": {
                                            "$ref": "#/$defs/datum"
                                        },
                                        "startdatum": {
                                            "$ref": "#/$defs/datum"
                                        }
                                    }
                                },
                                "intake": {
                                    "type": "object",
                                    "description": "Dit is de fase tussen het eerste gesprek en het Plan van Aanpak. Tijdens de\nintakefase wordt geinventariseerd welke instrumenten, ondersteuning, activiteiten en gegevens nodig zijn om een duurzaam financieel\nevenwicht te bereiken.",
                                    "properties": {
                                        "beschikkingsdatum": {
                                            "description": "De datum waarop de beschikking is afgegeven. Het kan hierom verschillende typen beschikking gaan, zoals: afwijzings- toewijsings- of beeindigingsbeschikking. ",
                                            "$ref": "#/$defs/datum"
                                        },
                                        "beschikkingssoort": {
                                            "$ref": "#/$defs/EnumBeschikkingssoort"
                                        },
                                        "einddatum": {
                                            "description": "De datum van afronding van de intake. Een klant ontvangt een gemotiveerde afwijzing of een toelatingsbeschikking. ",
                                            "$ref": "#/$defs/datum"
                                        },
                                        "startdatum": {
                                            "description": "Het gesprek dat plaatsvindt na aanmelding of na ontvangst hulpvraag (bijv. bij doorverwijzing vanuit vroegsignalering). Doel van dit gesprek is om de hulpvraag vast te stellen en te beoordelen welke instrumenten, ondersteuning, activiteiten en gegevens nodig zijn om een persoon te helpen om een duurzaam financieel evenwicht te bereiken. \n\n",
                                            "$ref": "#/$defs/datum"
                                        }
                                    }
                                },
                                "moratoria": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "description": "Het gaat hier om de datum waarop een verzoek tot een moratorium (ex art. 287 b Fw) is ingediend bij de rechter.\n\nEr kan een verzoek tot een moratorium bij de rechter worden gedaan om te voorkomen dat een schuldeiser zijn specifieke inningsmogelijkheden gebruikt, terwijl een aanvraag voor een minnelijke schuldregeling in behandeling is. Het moratorium is bedoeld om het minnelijke traject te kunnen voortzetten.\n\nHet moratorium kan in de volgende situaties worden ingezet:\n- gedwongen woningontruiming;\n- beëindiging van de levering van gas, water elektriciteit of stadsverwarming;\n- opzegging dan wel ontbinding van de zorgverzekering.\n\nHet moratorium duurt maximaal zes maanden.",
                                        "properties": {
                                            "datumAanvraag": {
                                                "$ref": "#/$defs/datum"
                                            },
                                            "datumGoedkeuring": {
                                                "$ref": "#/$defs/datum"
                                            },
                                            "einddatum": {
                                                "$ref": "#/$defs/datum"
                                            },
                                            "startdatum": {
                                                "$ref": "#/$defs/datum"
                                            }
                                        }
                                    }
                                },
                                "nazorg": {
                                    "type": "object",
                                    "description": "Ondersteuning die een persoon ontvangt ná een schuldhulptraject, om zo bij de start van een schuldenvrij leven zelfredzaamheid verder te bevorderen én recidive (terugval) te voorkomen.",
                                    "properties": {
                                        "einddatum": {
                                            "$ref": "#/$defs/datum"
                                        },
                                        "startdatum": {
                                            "$ref": "#/$defs/datum"
                                        }
                                    }
                                },
                                "oplossing": {
                                    "type": "object",
                                    "description": "De Oplossing beschrijft in 5 submodules wat de schuldhulpverlener doet om een oplossing te realiseren, en kent de volgende submodules: \n- submodule Herfinanciering;\n- submodule Betalingsregeling;\n- submodule Saneringskrediet;\n- submodule Schuldbemiddeling.\nHet kan ook gaan om een 0%-aanbod",
                                    "properties": {
                                        "einddatum": {
                                            "description": "Het gaat om het moment dat een schuldregeling (saneringskrediet/schuldbemiddeling) of volledige afbetalingsregeling (betalingsregeling/herfinanciering) daadwerkelijk eindigt. Dit kan zijn na de formele afgesproken periode of een voortijdige beeindiging.",
                                            "$ref": "#/$defs/datum"
                                        },
                                        "soort": {
                                            "$ref": "#/$defs/EnumOplossingssoort"
                                        },
                                        "startdatum": {
                                            "description": "Het gaat om het moment dat een schuldregeling (saneringskrediet/schuldbemiddeling) of volledige afbetalingsregeling (betalingsregeling/herfinanciering) daadwerkelijk start na goedkeuring van de aanvraag.",
                                            "$ref": "#/$defs/datum"
                                        },
                                        "vtlb": {
                                            "description": "Het \u201cVrij te laten bedrag\u201d (VTLB) is het bedrag (in hele euro's per maand) dat een persoon of huishouden met schulden mag behouden om in de basisbehoeften te voorzien. Dit bedrag wordt vastgesteld tijdens schuldhulpverleningstrajecten. Het VTLB zorgt ervoor dat iemand niet verder in de problemen komt door schulden af te lossen en tegelijkertijd nog kan voorzien in noodzakelijke kosten van levensonderhoud.",
                                            "$ref": "#/$defs/bedrag"
                                        }
                                    }
                                },
                                "planVanAanpak": {
                                    "type": "object",
                                    "description": "Een document waarin in elk geval het volgende staat:\n\u25a0 de hulpvraag van de persoon;\n\u25a0 de voorgestelde ondersteuning;\n\u25a0 eventueel de organisatie(s) waarnaar je hebt doorverwezen;\n\u25a0 de voorwaarden voor schuldhulpverlening (bijvoorbeeld dat de persoon geen nieuwe schulden mag maken).\n\nDe hoogte van beslagvrije voet voor de persoon (zie artikel 4a:5 van de Wgs) moet in acht worden genomen.",
                                    "properties": {
                                        "datumAfronding": {
                                            "$ref": "#/$defs/datum"
                                        }
                                    }
                                },
                                "schulden": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "description": "Een schuld is een financiële verplichting waarbij een persoon nu of in de toekomst een bedrag moet betalen aan een derde. In het kader van schuldhulpverlening wordt over een schuld gesproken als de persoon niet aan deze verplichting kan voldoen. . ",
                                        "properties": {
                                            "bedrag": {
                                                "description": "Bedrag in hele euro's nauwkeurig",
                                                "$ref": "#/$defs/bedrag"
                                            },
                                            "peildatum": {
                                                "description": "Peildatum dat de schuld is vastgesteld.",
                                                "$ref": "#/$defs/datum"
                                            },
                                            "schuldsoort": {
                                                "$ref": "#/$defs/EnumSchuldensoort"
                                            },
                                            "zakelijkeSchuld": {
                                                "description": "Betreft het een zakelijke schuld",
                                                "type": "boolean"
                                            },
                                            "schuldeiser": {
                                                "type": "object",
                                                "description": "Een schuldeiser is bedrijf of persoon die recht heeft op een prestatie van een ander, de schuldenaar. In de meeste gevallen is de prestatie het betalen van geld. Dit geldbedrag is dan de schuld die de schuldenaar aan de schuldeiser moet betalen. De schuld is meestal het gevolg van het niet nakomen van een verplichting uit een overeenkomst tussen de partijen. De schuldeiser kan de schuldenaar dwingen om de schuld te voldoen.",
                                                "properties": {
                                                    "naam": {
                                                        "type": "string"
                                                    },
                                                    "kvknummer": {
                                                        "type": "string"
                                                    },
                                                    "Naam": {
                                                        "description": "De benaming van het SUBJECT",
                                                        "type": "string"
                                                    },
                                                    "postcode": {
                                                        "type": "string"
                                                    },
                                                    "privepersoon": {
                                                        "type": "boolean"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "schuldregeling": {
                                    "type": "object",
                                    "description": "De schuldregeling heeft als doel een overeenkomst te sluiten tussen iemand met problematische schulden en zijn schuldeisers. Op basis van eventueel ingezet vermogen en de berekende afloscapaciteit (of op andere wijze vastgestelde minimale afdracht) lost de schuldenaar in maximaal 18 maanden zo veel mogelijk van de schuld af. Daarna schelden de schuldeisers de rest van hun vordering kwijt. Voordat de schuldregeling start, sluit je een schuldregelingsovereenkomst met de schuldenaar. Daarin staan de rechten en plichten van beide partijen. Een schuldregeling kan met een saneringskrediet of een schuldbemiddeling gerealiseerd worden. Als een of meer schuldeisers blijven weigeren in te stemmen met de minnelijke schuldregeling, informeer je de schuldenaar over mogelijke vervolgstappen, zoals het aanvragen van een dwangakkoord (artikel 287a Fw) of toelating tot de Wsnp.",
                                    "properties": {
                                        "afgewezen": {
                                            "description": "Datum waarop afwijzingheeft plaatgevonden. Leeg betekent: (nog) geen afwijzing plaatgevonden \n",
                                            "$ref": "#/$defs/datum"
                                        },
                                        "datum": {
                                            "description": "Datum dat schuldregeling is ingediend.",
                                            "$ref": "#/$defs/datum"
                                        },
                                        "datumVerzoekDwangakkoord": {
                                            "$ref": "#/$defs/datum"
                                        },
                                        "dwangakkoord": {
                                            "description": "Een vervolgstap die mogelijk is als een of meer schuldeisers blijven weigeren in te stemmen met de minnelijke schuldregelingaanvragen. Dit verzoek wordt ingediend bij de rechtbank (artikel 287a Fw).",
                                            "type": "boolean"
                                        },
                                        "ingetrokken": {
                                            "description": "Datum waarop schuldregeling is ingetrokken. Leeg betekent: (nog) geen intrekking plaatgevonden \n",
                                            "$ref": "#/$defs/datum"
                                        },
                                        "toegekend": {
                                            "description": "Datum waarop toekenning heeft plaatgevonden. Leeg betekent: (nog) geen toekenning plaatgevonden ",
                                            "$ref": "#/$defs/datum"
                                        }
                                    }
                                },
                                "voorlopigeVoorzieningen": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "properties": {
                                            "einddatum": {
                                                "$ref": "#/$defs/datum"
                                            },
                                            "startdatum": {
                                                "$ref": "#/$defs/datum"
                                            }
                                        }
                                    }
                                },
                                "uitstroom": {
                                    "type": "object",
                                    "description": "Motivatie voor uitstroom",
                                    "properties": {
                                        "datum": {
                                            "description": "Datum dat clienten uit het schuldhulptraject zijn uitgestroomd",
                                            "$ref": "#/$defs/datum"
                                        },
                                        "datumBeeindigingsbeschikking": {
                                            "description": "Datum dat de Beëindigingsbeschikking is afgegeven.",
                                            "$ref": "#/$defs/datum"
                                        },
                                        "omschrijving": {
                                            "type": "string"
                                        },
                                        "reden": {
                                            "description": "Reden dat de hulpverlening op enig moment na aanmelding bij schuldhulpverlening eindigt.  ",
                                            "$ref": "#/$defs/EnumUitstroomreden"
                                        }
                                    }
                                },
                                "stabilisatie": {
                                    "type": "object",
                                    "description": "Fase van het schuldhulpverleningstraject met als doel de inkomsten en uitgaven van een persoon in evenwicht te brengen. De stabilisatie van inkomen en uitgaven is een resultaat van\nwerkzaamheden uit het integrale plan van aanpak. Als stabilisatie bereikt is kan een betalingsregeling, herfinanciering of schuldregeling worden opgezet. Een belangrijk tweede doel is om de hulpvrager hierbij schuldenrust te bieden: stress wegnemen en tijd maken voor oplossingen naar een schuldenzorgvrije toekomst. In de stabilisatiefase kan een schuldhulpverlener andere instrumenten, activiteiten of ondersteuning inzetten, die bijdragen aan de duurzame oplossing van het financiële probleem, zoals budgetcoaching, budgetbeheer, beschermingsbewind of flankerende hulp.",
                                    "properties": {
                                        "einddatum": {
                                            "$ref": "#/$defs/datum"
                                        },
                                        "startdatum": {
                                            "$ref": "#/$defs/datum"
                                        }
                                    }
                                }
                            },
                            "required": [
                                "gemeentecode"
                            ],
                            "additionalProperties": false
                        }
                    }
                },
                "required": [
                    "teller",
                     "aanleverende_organisatie"
                ],
                "additionalProperties": false
            }
        }
    },
    "required": [
        "startdatumLevering",
        "einddatumLevering",
        "aanleverdatumEnTijd",
        "codeGegevensleverancier",
        "leveringen"
    ],        
    "additionalProperties": false,
    "$defs": {
        "datum": {
            "type": "string",
            "format": "date",
            "description": "Een datum in het formaat YYYY-MM-DD."
        },
        "email": {
            "type": "string",
            "format": "email",
            "description": "Een emailadres."
        },
        "tijd": {
            "type": "string",
            "format": "time",
            "description": "De tijd in het formaat HH:MM:SS (ISO 8601)."
        },
        "datum-tijd": {
            "type": "string",
            "format": "date-time",
            "description": "Datum en tijd in het formaat YYYY-MM-DDTHH:MM:SSZ (ISO 8601)."
        },
        "bedrag": {
            "type": "integer",
            "description": "Een geldbedrag in hele euros nauwkweurig."
        },
        "EnumBeschikkingssoort": {
            "type": "string",
            "enum": [
                "Afwijzingsbeschikking",
                "Toelatingsbeschikking"
            ]
        },
        "geslacht": {
            "type": "string",
            "enum": [
                "Man",
                "Vrouw",
                "Onbekend",
                "Leeg"
            ]
        },
        "EnumBegeleidingssoort": {
            "type": "string",
            "enum": [
                "Budgetcoaching",
                "Budgetbeheer",
                "Beschermingsbewind",
                "Lange Termijn Begeleiding (DFD)",
                "Budgetbegeleiding"
            ]
        },
        "EnumUitstroomreden": {
            "type": "string",
            "enum": [
                "Overleden",
                "Verhuisd",
                "Nietverschenen",
                "Ingetrokken",
                "Niet passend",
                "Overig",
                "Voldoet niet",
                "Afgerond",
                "Zelf"
            ]
        },
        "EnumSchuldensoort": {
            "type": "string",
            "enum": [
                "Zorg",
                "Publiek",
                "Nuts",
                "Overig"
            ]
        },
        "EnumOplossingssoort": {
            "type": "string",
            "enum": [
                "Betalingsregeling",
                "Herfinanciering",
                "Saneringskrediet",
                "Schuldbemiddeling",
                "0%-aanbod"
            ]
        }
    }
}

Voorbeelden

Enkelvoudig voorbeeld

Onderstaand een voorbeeld JSON-bestand conform de uitwisselspecificatie, waarbij slechts 1 traject wordt aangeleverd. Dit voorbeeld kun je ook downloaden.

{
    "startdatumLevering": "2024-01-01",
    "einddatumLevering": "2024-12-31",
    "aanleverdatumEnTijd": "2024-12-31T23:59:59Z",
    "codeGegevensleverancier": "GL987654",
    "leveringen": [
      {
        "teller": 1,
        "aanleverende_organisatie": {
          "(Statutaire) Naam": "Schuldhulporganisatie X",
          "KvK-nummer": "12345678",
          "postcode": "1234AB",
          "gemeentecode": "GM001",
          "contactpersonen": [
            {
              "email": "jan.jansen@schuldhulporganisatiex.nl",
              "functietitel": "Schuldhulpverlener",
              "naam": "Jan Jansen",
              "telefoonnummer": "0612345678"
            }
          ]
        },
        "schuldhulptrajecten": [
          {
            "einddatum": "2024-12-31",
            "omschrijving": "Traject om schulden af te lossen",
            "startdatum": "2024-01-10",
            "toekenningsdatum": "2024-01-05",
            "totaalSchuldbedragBijAanvangSchuld": 10000,
            "gemeentecode": "GM001",
            "aanmelding": {
              "crisisinterventie": true,
              "einddatum": "2024-01-15",
              "startdatum": "2024-01-01"
            },
            "begeleiding": [
              {
                "einddatum": "2024-11-30",
                "soort": "Budgetbeheer",
                "startdatum": "2024-02-01"
              }
            ],
            "client": [
              {
                "Burgerservicenummer": "987654321",
                "Geboortedatum": "1980-05-01",
                "Geslachtsaanduiding": "Man",
                "Postcode": "5678CD",
                "Huisnummer": "10",
                "Huisnummertoevoeging": "A"
              }
            ],
            "schuldregeling": {
              "datum": "2024-06-01",
              "datumVerzoekDwangakkoord": "2024-06-10",
              "dwangakkoord": true,
              "toegekend": "2024-06-20"
            }
          }
        ]
      }
    ]
  }

Meervoudig voorbeeld

Onderstaand een voorbeeld JSON-bestand conform de uitwisselspecificatie, waarbij meerdere trajecten worden aangeleverd. Dit voorbeeld kun je ook downloaden.

{
    "startdatumLevering": "2024-01-01",
    "einddatumLevering": "2024-12-31",
    "aanleverdatumEnTijd": "2024-12-31T23:59:59Z",
    "codeGegevensleverancier": "GL123456",
    "leveringen": [
      {
        "teller": 1,
        "aanleverende_organisatie": {
          "(Statutaire) Naam": "Schuldhulporganisatie Z",
          "KvK-nummer": "87654321",
          "postcode": "5678EF",
          "gemeentecode": "GM002",
          "contactpersonen": [
            {
              "email": "info@schuldhulporganisatiez.nl",
              "functietitel": "Coördinator",
              "naam": "Klaas de Vries",
              "telefoonnummer": "0623456789"
            }
          ]
        },
        "schuldhulptrajecten": [
          {
            "einddatum": "2024-09-30",
            "omschrijving": "Traject 1",
            "startdatum": "2024-01-10",
            "toekenningsdatum": "2024-01-05",
            "totaalSchuldbedragBijAanvangSchuld": 12000,
            "gemeentecode": "GM002",
            "client": [
              {
                "Burgerservicenummer": "987654321",
                "Geboortedatum": "1980-01-01",
                "Geslachtsaanduiding": "Man",
                "Postcode": "5678CD",
                "Huisnummer": "10"
              }
            ]
          },
          {
            "einddatum": "2024-08-31",
            "omschrijving": "Traject 2",
            "startdatum": "2024-02-15",
            "toekenningsdatum": "2024-02-10",
            "totaalSchuldbedragBijAanvangSchuld": 15000,
            "gemeentecode": "GM002",
            "client": [
              {
                "Burgerservicenummer": "123456789",
                "Geboortedatum": "1990-02-10",
                "Geslachtsaanduiding": "Vrouw",
                "Postcode": "1234AB",
                "Huisnummer": "25"
              }
            ]
          },
          {
            "einddatum": "2024-10-31",
            "omschrijving": "Traject 3",
            "startdatum": "2024-03-20",
            "toekenningsdatum": "2024-03-15",
            "totaalSchuldbedragBijAanvangSchuld": 18000,
            "gemeentecode": "GM003",
            "client": [
              {
                "Burgerservicenummer": "234567890",
                "Geboortedatum": "1985-03-15",
                "Geslachtsaanduiding": "Man",
                "Postcode": "2345CD",
                "Huisnummer": "15"
              }
            ]
          },
          {
            "einddatum": "2024-11-30",
            "omschrijving": "Traject 4",
            "startdatum": "2024-04-10",
            "toekenningsdatum": "2024-04-05",
            "totaalSchuldbedragBijAanvangSchuld": 21000,
            "gemeentecode": "GM004",
            "client": [
              {
                "Burgerservicenummer": "345678901",
                "Geboortedatum": "1975-07-20",
                "Geslachtsaanduiding": "Vrouw",
                "Postcode": "3456DE",
                "Huisnummer": "20"
              }
            ]
          },
          {
            "einddatum": "2024-12-31",
            "omschrijving": "Traject 5",
            "startdatum": "2024-05-05",
            "toekenningsdatum": "2024-05-01",
            "totaalSchuldbedragBijAanvangSchuld": 25000,
            "gemeentecode": "GM005",
            "client": [
              {
                "Burgerservicenummer": "456789012",
                "Geboortedatum": "1988-08-25",
                "Geslachtsaanduiding": "Man",
                "Postcode": "4567EF",
                "Huisnummer": "30"
              }
            ]
          },
          {
            "einddatum": "2024-07-31",
            "omschrijving": "Traject 6",
            "startdatum": "2024-06-15",
            "toekenningsdatum": "2024-06-10",
            "totaalSchuldbedragBijAanvangSchuld": 30000,
            "gemeentecode": "GM006",
            "client": [
              {
                "Burgerservicenummer": "567890123",
                "Geboortedatum": "1995-09-05",
                "Geslachtsaanduiding": "Vrouw",
                "Postcode": "5678GH",
                "Huisnummer": "40"
              }
            ]
          },
          {
            "einddatum": "2024-09-30",
            "omschrijving": "Traject 7",
            "startdatum": "2024-07-10",
            "toekenningsdatum": "2024-07-05",
            "totaalSchuldbedragBijAanvangSchuld": 35000,
            "gemeentecode": "GM007",
            "client": [
              {
                "Burgerservicenummer": "678901234",
                "Geboortedatum": "1980-10-20",
                "Geslachtsaanduiding": "Man",
                "Postcode": "6789IJ",
                "Huisnummer": "50"
              }
            ]
          },
          {
            "einddatum": "2024-06-30",
            "omschrijving": "Traject 8",
            "startdatum": "2024-05-01",
            "toekenningsdatum": "2024-04-25",
            "totaalSchuldbedragBijAanvangSchuld": 10000,
            "gemeentecode": "GM008",
            "client": [
              {
                "Burgerservicenummer": "789012345",
                "Geboortedatum": "1970-12-15",
                "Geslachtsaanduiding": "Vrouw",
                "Postcode": "7890KL",
                "Huisnummer": "60"
              }
            ]
          },
          {
            "einddatum": "2024-05-31",
            "omschrijving": "Traject 9",
            "startdatum": "2024-02-20",
            "toekenningsdatum": "2024-02-15",
            "totaalSchuldbedragBijAanvangSchuld": 17000,
            "gemeentecode": "GM009",
            "client": [
              {
                "Burgerservicenummer": "890123456",
                "Geboortedatum": "1990-11-25",
                "Geslachtsaanduiding": "Man",
                "Postcode": "8901MN",
                "Huisnummer": "70"
              }
            ]
          },
          {
            "einddatum": "2024-10-31",
            "omschrijving": "Traject 10",
            "startdatum": "2024-09-15",
            "toekenningsdatum": "2024-09-10",
            "totaalSchuldbedragBijAanvangSchuld": 22000,
            "gemeentecode": "GM010",
            "client": [
              {
                "Burgerservicenummer": "901234567",
                "Geboortedatum": "1982-05-30",
                "Geslachtsaanduiding": "Vrouw",
                "Postcode": "9012OP",
                "Huisnummer": "80"
              }
            ]
          }
        ]
      }
    ]
  }

Samenloop voorbeeld

Het komt voor dat gemeenten een deel van de dienstverlening aan een schuldhulpverlenende partij heeft uitbesteed. In een dergelijk geval worden er door meerdere schuldhulpverleners aanleveringen gedaan over dezelfde clienten in dezelfde periode. Onderstaand twee voorbeeld JSON-bestanden conform de uitwisselspecificatie, waarbij meerdere trajecten worden aangeleverd. Deze voorbeeld kun je ook downloaden deel 1 en downloaden deel 2.

Samenloop bestand 1

{
    "startdatumLevering": "2024-01-01",
    "einddatumLevering": "2024-12-31",
    "aanleverdatumEnTijd": "2024-12-31T23:59:59Z",
    "codeGegevensleverancier": "SL001",
    "leveringen": [
      {
        "teller": 1,
        "aanleverende_organisatie": {
          "(Statutaire) Naam": "Samenloop Organisatie X",
          "KvK-nummer": "11112222",
          "postcode": "1111AA",
          "gemeentecode": "GM111",
          "contactpersonen": [
            {
              "email": "contact@organisatiex.nl",
              "functietitel": "Schuldhulpverlener",
              "naam": "John Doe",
              "telefoonnummer": "0612345678"
            }
          ]
        },
        "schuldhulptrajecten": [
          {
            "einddatum": "2024-07-31",
            "omschrijving": "Traject 1",
            "startdatum": "2024-01-01",
            "toekenningsdatum": "2023-12-15",
            "totaalSchuldbedragBijAanvangSchuld": 15000,
            "gemeentecode": "GM111",
            "client": [
              {
                "Burgerservicenummer": "123456789",
                "Geboortedatum": "1980-01-01",
                "Geslachtsaanduiding": "Man",
                "Postcode": "1234AB",
                "Huisnummer": "12"
              }
            ]
          },
          {
            "einddatum": "2024-06-30",
            "omschrijving": "Traject 2",
            "startdatum": "2024-02-01",
            "toekenningsdatum": "2024-01-25",
            "totaalSchuldbedragBijAanvangSchuld": 10000,
            "gemeentecode": "GM111",
            "client": [
              {
                "Burgerservicenummer": "987654321",
                "Geboortedatum": "1975-02-15",
                "Geslachtsaanduiding": "Vrouw",
                "Postcode": "5678CD",
                "Huisnummer": "34"
              }
            ]
          },
          {
            "einddatum": "2024-08-31",
            "omschrijving": "Traject 3",
            "startdatum": "2024-03-15",
            "toekenningsdatum": "2024-02-25",
            "totaalSchuldbedragBijAanvangSchuld": 20000,
            "gemeentecode": "GM111",
            "client": [
              {
                "Burgerservicenummer": "654321987",
                "Geboortedatum": "1988-03-20",
                "Geslachtsaanduiding": "Man",
                "Postcode": "7890EF",
                "Huisnummer": "56"
              }
            ]
          },
          {
            "einddatum": "2024-09-30",
            "omschrijving": "Traject 4",
            "startdatum": "2024-04-10",
            "toekenningsdatum": "2024-03-25",
            "totaalSchuldbedragBijAanvangSchuld": 12000,
            "gemeentecode": "GM111",
            "client": [
              {
                "Burgerservicenummer": "543219876",
                "Geboortedatum": "1995-05-25",
                "Geslachtsaanduiding": "Vrouw",
                "Postcode": "1234GH",
                "Huisnummer": "78"
              }
            ]
          },
          {
            "einddatum": "2024-12-31",
            "omschrijving": "Traject 5",
            "startdatum": "2024-05-05",
            "toekenningsdatum": "2024-04-25",
            "totaalSchuldbedragBijAanvangSchuld": 25000,
            "gemeentecode": "GM111",
            "client": [
              {
                "Burgerservicenummer": "432198765",
                "Geboortedatum": "1983-06-30",
                "Geslachtsaanduiding": "Man",
                "Postcode": "3456IJ",
                "Huisnummer": "90"
              }
            ]
          }
        ]
      }
    ]
  }

Samenloop bestand 2

{
    "startdatumLevering": "2024-01-01",
    "einddatumLevering": "2024-12-31",
    "aanleverdatumEnTijd": "2024-12-31T23:59:59Z",
    "codeGegevensleverancier": "SL002",
    "leveringen": [
      {
        "teller": 1,
        "aanleverende_organisatie": {
          "(Statutaire) Naam": "Samenloop Organisatie Y",
          "KvK-nummer": "22223333",
          "postcode": "2222BB",
          "gemeentecode": "GM222",
          "contactpersonen": [
            {
              "email": "contact@organisatiey.nl",
              "functietitel": "Coördinator",
              "naam": "Piet Pietersen",
              "telefoonnummer": "0623456789"
            }
          ]
        },
        "schuldhulptrajecten": [
          {
            "einddatum": "2024-10-31",
            "omschrijving": "Traject 1",
            "startdatum": "2024-01-20",
            "toekenningsdatum": "2024-01-10",
            "totaalSchuldbedragBijAanvangSchuld": 14000,
            "gemeentecode": "GM222",
            "client": [
              {
                "Burgerservicenummer": "234567890",
                "Geboortedatum": "1978-07-12",
                "Geslachtsaanduiding": "Man",
                "Postcode": "2345KL",
                "Huisnummer": "45"
              }
            ]
          },
          {
            "einddatum": "2024-11-30",
            "omschrijving": "Traject 2",
            "startdatum": "2024-02-05",
            "toekenningsdatum": "2024-01-30",
            "totaalSchuldbedragBijAanvangSchuld": 18000,
            "gemeentecode": "GM222",
            "client": [
              {
                "Burgerservicenummer": "345678901",
                "Geboortedatum": "1992-03-15",
                "Geslachtsaanduiding": "Vrouw",
                "Postcode": "3456MN",
                "Huisnummer": "67"
              }
            ]
          },
          {
            "einddatum": "2024-12-31",
            "omschrijving": "Traject 3",
            "startdatum": "2024-03-01",
            "toekenningsdatum": "2024-02-20",
            "totaalSchuldbedragBijAanvangSchuld": 20000,
            "gemeentecode": "GM222",
            "client": [
              {
                "Burgerservicenummer": "456789012",
                "Geboortedatum": "1990-04-20",
                "Geslachtsaanduiding": "Man",
                "Postcode": "4567OP",
                "Huisnummer": "89"
              }
            ]
          },
          {
            "einddatum": "2024-08-31",
            "omschrijving": "Traject 4",
            "startdatum": "2024-04-15",
            "toekenningsdatum": "2024-04-05",
            "totaalSchuldbedragBijAanvangSchuld": 16000,
            "gemeentecode": "GM222",
            "client": [
              {
                "Burgerservicenummer": "567890123",
                "Geboortedatum": "1985-05-10",
                "Geslachtsaanduiding": "Vrouw",
                "Postcode": "5678QR",
                "Huisnummer": "56"
              }
            ]
          },
          {
            "einddatum": "2024-09-30",
            "omschrijving": "Traject 5",
            "startdatum": "2024-05-20",
            "toekenningsdatum": "2024-05-10",
            "totaalSchuldbedragBijAanvangSchuld": 13000,
            "gemeentecode": "GM222",
            "client": [
              {
                "Burgerservicenummer": "678901234",
                "Geboortedatum": "1975-06-30",
                "Geslachtsaanduiding": "Man",
                "Postcode": "6789ST",
                "Huisnummer": "78"
              }
            ]
          }
        ]
      }
    ]
  }

Voorbeeld meerdere leveringen

Onderstaand een voorbeeld JSON-bestand conform de uitwisselspecificatie, waarbij meerdere leveringen in 1 bestand zitten. Dit voorbeeld kun je ook downloaden.

{
    "startdatumLevering": "2024-01-01",
    "einddatumLevering": "2024-12-31",
    "aanleverdatumEnTijd": "2024-12-31T23:59:59Z",
    "codeGegevensleverancier": "GL123456",
    "leveringen": [
      {
        "teller": 1,
        "aanleverende_organisatie": {
          "(Statutaire) Naam": "Schuldhulporganisatie A",
          "KvK-nummer": "11112222",
          "postcode": "1111AA",
          "gemeentecode": "GM111",
          "contactpersonen": [
            {
              "email": "contact@organisatiea.nl",
              "functietitel": "Coördinator",
              "naam": "Jan Jansen",
              "telefoonnummer": "0612345678"
            }
          ]
        },
        "schuldhulptrajecten": [
          {
            "einddatum": "2024-09-30",
            "omschrijving": "Traject A1",
            "startdatum": "2024-01-15",
            "toekenningsdatum": "2024-01-10",
            "totaalSchuldbedragBijAanvangSchuld": 15000,
            "gemeentecode": "GM111",
            "aanmelding": {
              "crisisinterventie": true,
              "einddatum": "2024-01-20",
              "startdatum": "2024-01-10"
            },
            "client": [
              {
                "Burgerservicenummer": "123456789",
                "Geboortedatum": "1980-01-01",
                "Geslachtsaanduiding": "Man",
                "Postcode": "1234AB",
                "Huisnummer": "12"
              }
            ]
          }
        ]
      },
      {
        "teller": 2,
        "aanleverende_organisatie": {
          "(Statutaire) Naam": "Schuldhulporganisatie B",
          "KvK-nummer": "22223333",
          "postcode": "2222BB",
          "gemeentecode": "GM222",
          "contactpersonen": [
            {
              "email": "contact@organisatienb.nl",
              "functietitel": "Schuldhulpverlener",
              "naam": "Piet Pietersen",
              "telefoonnummer": "0623456789"
            }
          ]
        },
        "schuldhulptrajecten": [
          {
            "einddatum": "2024-10-31",
            "omschrijving": "Traject B1",
            "startdatum": "2024-02-10",
            "toekenningsdatum": "2024-01-30",
            "totaalSchuldbedragBijAanvangSchuld": 18000,
            "gemeentecode": "GM222",
            "aanmelding": {
              "crisisinterventie": false,
              "einddatum": "2024-02-15",
              "startdatum": "2024-02-01"
            },
            "client": [
              {
                "Burgerservicenummer": "234567890",
                "Geboortedatum": "1990-02-15",
                "Geslachtsaanduiding": "Vrouw",
                "Postcode": "2345KL",
                "Huisnummer": "45"
              }
            ]
          }
        ]
      },
      {
        "teller": 3,
        "aanleverende_organisatie": {
          "(Statutaire) Naam": "Schuldhulporganisatie C",
          "KvK-nummer": "33334444",
          "postcode": "3333CC",
          "gemeentecode": "GM333",
          "contactpersonen": [
            {
              "email": "contact@organisatiec.nl",
              "functietitel": "Manager",
              "naam": "Klaas de Vries",
              "telefoonnummer": "0634567890"
            }
          ]
        },
        "schuldhulptrajecten": [
          {
            "einddatum": "2024-11-30",
            "omschrijving": "Traject C1",
            "startdatum": "2024-03-15",
            "toekenningsdatum": "2024-03-05",
            "totaalSchuldbedragBijAanvangSchuld": 20000,
            "gemeentecode": "GM333",
            "aanmelding": {
              "crisisinterventie": false,
              "einddatum": "2024-03-20",
              "startdatum": "2024-03-10"
            },
            "client": [
              {
                "Burgerservicenummer": "345678901",
                "Geboortedatum": "1985-03-25",
                "Geslachtsaanduiding": "Man",
                "Postcode": "3456MN",
                "Huisnummer": "78"
              }
            ]
          }
        ]
      },
      {
        "teller": 4,
        "aanleverende_organisatie": {
          "(Statutaire) Naam": "Schuldhulporganisatie D",
          "KvK-nummer": "44445555",
          "postcode": "4444DD",
          "gemeentecode": "GM444",
          "contactpersonen": [
            {
              "email": "contact@organisatied.nl",
              "functietitel": "Coördinator",
              "naam": "Anneke Janssen",
              "telefoonnummer": "0645678901"
            }
          ]
        },
        "schuldhulptrajecten": [
          {
            "einddatum": "2024-12-31",
            "omschrijving": "Traject D1",
            "startdatum": "2024-04-01",
            "toekenningsdatum": "2024-03-25",
            "totaalSchuldbedragBijAanvangSchuld": 25000,
            "gemeentecode": "GM444",
            "aanmelding": {
              "crisisinterventie": true,
              "einddatum": "2024-04-05",
              "startdatum": "2024-03-30"
            },
            "client": [
              {
                "Burgerservicenummer": "456789012",
                "Geboortedatum": "1990-04-20",
                "Geslachtsaanduiding": "Vrouw",
                "Postcode": "4567OP",
                "Huisnummer": "89"
              }
            ]
          }
        ]
      },
      {
        "teller": 5,
        "aanleverende_organisatie": {
          "(Statutaire) Naam": "Schuldhulporganisatie E",
          "KvK-nummer": "55556666",
          "postcode": "5555EE",
          "gemeentecode": "GM555",
          "contactpersonen": [
            {
              "email": "contact@organisatiee.nl",
              "functietitel": "Schuldhulpverlener",
              "naam": "Martijn de Boer",
              "telefoonnummer": "0656789012"
            }
          ]
        },
        "schuldhulptrajecten": [
          {
            "einddatum": "2024-07-31",
            "omschrijving": "Traject E1",
            "startdatum": "2024-05-10",
            "toekenningsdatum": "2024-04-30",
            "totaalSchuldbedragBijAanvangSchuld": 30000,
            "gemeentecode": "GM555",
            "aanmelding": {
              "crisisinterventie": false,
              "einddatum": "2024-05-15",
              "startdatum": "2024-05-01"
            },
            "client": [
              {
                "Burgerservicenummer": "567890123",
                "Geboortedatum": "1995-05-30",
                "Geslachtsaanduiding": "Man",
                "Postcode": "5678QR",
                "Huisnummer": "123"
              }
            ]
          }
        ]
      }
    ]
  }