HANDLEIDING WEBSERVICES DICOS NETWERK VERSIE 1.6

HANDLEIDING WEBSERVICES DICOS NETWERK VERSIE 1.6 Copyright Kred it B.V. Eindhoven Niets uit deze publicatie mag worden verveelvoudigd en/of openbaar gemaakt door middel van druk, fotokopie, microfilm, geluidsband, elektronisch of op welke andere wijze dan ook en evenmin in een retrieval systeem worden opgeslagen, zonder voorafgaande schriftelijke toestemming van Kred'it B.V.

0 Inhoudsopgave INHOUDSOPGAVE Inhoudsopgave... 1 1 Inleiding... 4 1.1 Algemeen... 4 1.2 Terminologie... 4 1.3 Techniek... 4 1.4 Versie... 5 2 DICOSCentrale Server... 6 2.1 Inleiding... 6 2.1.1 Algemeen... 6 2.2 LoginService... 7 2.2.1 Algemeen... 7 2.2.2 DICOSCentraleLoginAanmeldNaam... 7 2.2.3 LoginService.DICOSCentraleLoginEmail... 7 2.2.4 DICOSCentraleLogout... 8 2.2.5 VerzoekNieuwWachtwoord... 8 2.2.5 ImAlive... 8 2.3 BeheerService... 8 2.3.1 Algemeen... 10 2.3.2 GetMedewerkerOverzicht... 10 2.3.3 GetMedewerker... 10 2.3.4 WijzigMedewerker... 11 2.3.5 NieuweMedewerker... 11 2.3.6 VerwijderMedewerker... 12 2.3.7 GetMeldingOverzicht... 13 2.3.8 GetMelding... 13 2.3.9 WijzigMedewerkerWachtwoord... 13 2.3.10 ZoekMedewerker... 14 2.3.11 AbonnementOpzeggen... 14 2.4 SchuldhulpService... 15 2.4.1 Algemeen... 15 2.4.2 GetSaldoVraagOverzicht... 15 2.4.3 GetSaldoVraag... 15 2.4.4 WijzigSaldoVraag... 16 2.4.5 NieuweSchuld... 17 2.4.6 GetSaldoVoorstelOverzicht... 18 2.4.7 GetSaldoVoorstel... 18 2.4.8 WijzigSaldoVoorstel... 19 2.4.9 GetAankondigingEindeOverzicht... 20 2.4.10 GetAankondigingEinde... 20 2.4.11 WijzigAankondigingEinde... 21 2.4.12 GetMeldingOverzicht... 22 2.4.13 GetMelding... 22 2.4.14 WijzigMelding... 23 2.4.15 GetKlantnummer... 24 2.4.16 GetKlant... 24 2.4.17 GetKlantSchuld... 25 2.4.18 GetAlleKlanten... 25 2.4.19 GetManagementInfo... 26 2.5 BBRService... 27 Versie: 16 september 2012 Blz.: 2 van 66

0 Inhoudsopgave 2.5.1 Algemeen... 27 2.5.2 GetBBRAanmeldingOverzicht... 27 2.5.3 GetBBRAanmelding... 27 2.5.4 VerwerkBBRAanmelding... 28 2.5.5 GetBBROpdrachtOverzicht... 29 2.5.6 GetBBROpdracht... 29 2.5.7 VerwerkBBROpdracht... 30 2.5.8 GetBBROpdrachtCSV... 30 2.5.9 PutBBROpdrachtCSV... 31 2.5.10 GetBBRAfmeldingOverzicht... 32 2.5.11 GetBBRAfmelding... 32 2.5.12 VerwerkBBRAfmelding... 33 2.5.13 GetKlantnummer... 34 2.5.14 GetKlant... 34 2.5.15 GetKlantOpdracht... 35 2.5.16 GetAlleKlanten... 35 2.5.17 GetManagementInfo... 36 2.6 BerekeningService... 37 2.6.1 Algemeen... 37 2.6.2 GetVTLB... 37 3 DICOSAllegro Server... 36 4 Bijlage 1 - Structures van de webservices... 38 4.1 Inleiding... 39 4.2 AWUserInfo... 39 4.3 TMedewerker-Header en -Detail... 40 4.4 TMelding... 42 4.5 TKlantMelding-Header en -Detail... 42 4.6 TKlantGegevens... 44 4.7 TKlantGegevensAdres... 44 4.8 TKlantNummer... 44 4.9 TSchuldSharedHeader... 45 4.10 TSaldoVraag-Header en -Detail... 46 4.11 TDossierMedewerker... 46 4.12 TSaldoVoorstel-Header en -Detail... 47 4.13 TAankondigingEinde-Header en -Detail... 48 4.14 TKlantSchuld-Header en -Detail... 50 4.15 TOpdrachtSharedHeader... 53 4.16 TBBRAanmelding-Header en -Detail... 54 4.17 TBBROpdracht-Header en -Detail... 55 4.18 TBBRAfmelding-Header en -Detail... 56 4.19 TKlantOpdracht-Header en -Detail... 56 4.20 TFiltersettings... 56 4.21 TPaginaInfo... 57 4.22 TSorteerInfo... 57 4.23 Esortering(Enumerated type)... 57 4.24 TSRInfo... 57 4.25 TSRInfoCentrale... 60 4.26 TBBRInfoCentrale... 62 4.27 TDICOSGUID... 63 5 Bijlage 2 Foutmeldingen van de webservices... 65 5.1 Inleiding... 65 5.2 Meldingen... 65 Versie: 16 september 2012 Blz.: 3 van 66

1 Inleiding 1 INLEIDING 1.1 ALGEMEEN Deze handleiding heeft betrekking op het communicatie netwerk DICOS van Kred it. DICOS is een communicatie netwerk tussen schuldeisers (debiteuren, waaronder bijvoorbeeld ook allerlei organisaties vallen die in het budgetplan van klanten van schuldhulpverlenende instanties voorkomen) en schuldhulpverlenende organisaties (Allegro organisatie). DICOS staat voor Digitale communicatie met schuldeisers/schuldhulpverleners. Met behulp van DICOS kunnen gegevens digitaal, middels webservices, worden uitgewisseld. Voor de schuldhulpverlening betekent dit bijvoorbeeld het digitaal uitwisselen van verzoeken om en antwoorden met saldo-opgaaf van schulden. Voor budgetbeheer betekent dit bijvoorbeeld de aanlevering van maandelijkse facturen van klanten aan schuldhulpverlenende instanties. DICOS wordt uitgebreid beschreven in onder meer de 'Informatie analyse website DICOS'. In deze handleiding worden uitsluitend de te gebruiken webservices beschreven. Het onttrekken uit en aanleveren van gegevens aan Allegro, via de DICOS Centrale, wordt gerealiseerd met webservices. Het verwerken van gegevens gebeurt in Allegro via Allegro Portier. Daarnaast zijn enige andere functionaliteiten in Allegro van belang. Deze functionaliteiten worden in deze handleiding niet beschreven. DICOS is uitsluitend beschikbaar voor Allegro 3.0 en hoger. 1.2 TERMINOLOGIE In deze beschrijving wordt de volgende terminologie gebruikt: Allegro organisatie = een organisatie die met Allegro werkt (en dus schuldhulpverleningstrajecten en/of budgetbeheer uitvoert) Relatie = een persoon of organisatie die als relatie in Allegro is opgenomen. Schuldeiser = een organisatie die als schuldeiser of debiteur voorkomt in schuldhulpverleningstrajecten en/of budgetplannen. 1.3 TECHNIEK Voor de communicatie wordt gebruik gemaakt van SOAP-webservices, met in de header een zogenaamde 'sessionguid'. Bij aanmelden bij het DICOS netwerk (zie paragraaf 0) wordt een 'session-id' terug gegeven, die vervolgens weer meegegeven moet worden in de header van de daaropvolgende aanroepen van webservices. De webservices kunnen in 2 groepen worden gesplitst: De webservices die door de schuldeisers worden aangeroepen en beschikbaar zijn in de DICOS Centrale. Deze webservices vormen samen de DICOSCentrale Server. Deze webservices worden ook aangeroepen vanuit de website DICOS. Versie: 16 september 2012 Blz.: 4 van 66

1 Inleiding De webservices die door de Centrale worden aangeroepen bij de diverse Allegro organisaties en beschikbaar zijn in Allegro (module DICOS). Deze webservices vormen samen de DICOSAllegro Server. Schuldeiser Schuldeiser Website DICOS Centrale DICOSCentrale Server Allegroorganisatie DICOSAllegro Server Allegroorganisatie DICOSAllegro Server 1.4 VERSIE Versie 1.6 van deze handleiding is de juni 2013- versie van dit document, waarin zowel de SRals BBR-communicatie zijn getoetst en aangepast aan de ontwerpen voor Allegro DICOS en DICOS Beheer. Versie: 16 september 2012 Blz.: 5 van 66

2 DICOSCentrale Server 2 DICOSCENTRALE SERVER 2.1 INLEIDING 2.1.1 Algemeen In dit hoofdstuk wordt een opsomming gegeven van de beschikbare webservices in de DICOS Centrale Server. Dit zijn de webservices die door schuldeisers en door de website DICOS aangeroepen kunnen worden. Van iedere webservice is een korte beschrijving opgenomen. Voor uitgebreide informatie over de webservices kan de WSDL worden geraadpleegd. Bij verschillende webservices wordt ook verwezen naar de structures. De structures zijn als bijlage opgenomen. Het betreft SOAP-webservices, met in de header een zogenaamde 'sessionguid'. Bij aanmelden bij DICOS wordt een 'session-id' terug gegeven, die vervolgens weer meegegeven moet worden in de header van de daaropvolgende aanroepen van webservices. Voorbeeld (C#): if (bgelukt) -- als de login gelukt is { Session["LoggedIn"] = true; Session.Timeout = 60; Session["SessionID"] = usr.sessionid; Session["Relatie"] = usr.relatie; Session["LastLogin"] = usr.laatstelogin; } Response.Redirect("AW_Home.aspx"); en dan vervolgens: protected void Page_Load(object sender, EventArgs e) { XService svcx = new XService(); svcx.url = DICOSWebSite.Properties.Settings.Default.DICOSWebSite_WRXService_XService; } ROClientIDHeader hdrroclientid = new ROClientIDHeader(); hdrroclientid.id = Convert.ToString(Session["SessionID"]); svcx.roclientidheadervalue = hdrroclientid; Versie: 16 september 2012 Blz.: 6 van 66

2 DICOSCentrale Server 2.2 LOGINSERVICE 2.2.1 Algemeen De LoginService bevat alle methoden die te maken hebben met het aanmelden bij de DICOS Centrale. 2.2.2 DICOSCentraleLoginAanmeldNaam De service LoginService.DICOSCentraleLoginAanmeldNaam controleert of een persoon (medewerker bij een schuldeiser), door middel van ingegeven organisatienummer, aanmeldnaam en wachtwoord, toegang heeft tot de DICOS Centrale. De service vult ook, indien de persoon bekend is bij de Centrale, diverse gegevens bij de medewerker in de Centrale (zoals bijvoorbeeld datum en tijdstip laatste aanmelding bij de Centrale). Deze service dient dus gebruikt te worden indien een persoon zich aanmeldt bij de centrale. Output: Organisatienummer, aanmeldnaam en wachtwoord Gegevens van de persoon in de AWUserInfo (Organisatienaam, Achternaam medewerker, Voornaam medewerker, Geslacht medewerker, Telefoonnummer medewerker, E-mailadres medewerker, laatste aanmelddatum bij de Centrale, Indicatie Schuldhulpverlening, Indicatie Budgetbeheer, Indicatie Beheerder, Blokkering) (Zie ook paragraaf 4.2). - 1002 Wachtwoord niet juist - 1003 Geen gebruiker met deze aanmeldnaam - 1004 Geen toegang (geblokkeerd) 2.2.3 DICOSCentraleLoginEmail De service LoginService.DICOSCentraleLoginEmail controleert of een persoon (medewerker bij een schuldeiser), door middel van een ingegeven E-mail adres en wachtwoord toegang heeft tot de DICOS Centrale. De service vult ook, indien de persoon bekend is bij de Centrale, diverse gegevens bij de medewerker in de Centrale (zoals bijvoorbeeld datum en tijdstip laatste aanmelding bij de Centrale). Deze service dient dus gebruikt te worden indien een persoon zich aanmeldt bij de centrale. Output: E-mail adres en wachtwoord. Gegevens van de persoon in de AWUserInfo (Organisatienaam, Achternaam medewerker, Voornaam medewerker, Geslacht medewerker, Telefoonnummer medewerker, E-mailadres medewerker, laatste aanmelddatum bij de Centrale, Versie: 16 september 2012 Blz.: 7 van 66

2 DICOSCentrale Server Indicatie Schuldhulpverlening, Indicatie Budgetbeheer, Indicatie Beheerder, Blokkering) (Zie ook paragraaf 4.2). En daarnaast wordt de boolean ( true of false ) bwachtwoordwijzigen meegegeven om aan te geven of het wachtwoord gewijzigd dient te worden. - 1002 Wachtwoord niet juist - 1003 Geen gebruiker met deze aanmeldnaam - 1004 Geen toegang (geblokkeerd) - 1030 Email adres niet gevuld - 1031 Geen gebruiker met dit email adres 2.2.4 DICOSCentraleLogout Door de service LoginService.DICOSCentraleLogout aan te roepen wordt de huidige gebruiker uitgelogd uit de Centrale. - Output : - -1034 Sessie niet gevonden 2.2.5 VerzoekNieuwWachtwoord Door het aanroepen van de service LoginService.VerzoekNieuwWachtwoord wordt een E-mail verstuurd door de Centrale naar het opgegeven E-mail adres, mits bekend bij de Centrale. E-mail Output: - -1003 Geen gebruiker met deze aanmeldnaam 2.2.6 ImAlive Door het aanroepen van de service LoginService.ImAlive wordt als resultaat een boolean teruggeven die aangeeft of de gebruikerssessie nog actief is - Versie: 16 september 2012 Blz.: 8 van 66

2 DICOSCentrale Server Output: - ExtraInfoOmschrijving, wanneer het resultaat van de aanroep false is. Versie: 16 september 2012 Blz.: 9 van 66

2 DICOSCentrale Server 2.3 BEHEERSERVICE 2.3.1 Algemeen De BeheerService bevat alle methoden die te maken hebben met het beheer van de diverse gegevens van de schuldeiser, zoals het beheer van medewerkers bij de schuldeiser die toegang moeten krijgen tot de DICOS Centrale. 2.3.2 GetMedewerkerOverzicht De service BeheerService.GetMedewerkerOverzicht geeft de gegevens van alle medewerkers van een schuldeiser (uniek organisatienummer), met uitzondering van de gegevens van de beheerder. Deze service kan gebruikt worden om gegevens op te halen van medewerkers. Output: Organisatienummer Gegevens van de medewerkers (Achternaam, voornaam, aanmeldnaam, wachtwoord, geslacht, telefoonnummer, etc.) in een array van de structure TMedewerkerDetail (zie paragraaf 4.3). 2.3.3 GetMedewerker De service BeheerService.GetMedewerker geeft de gegevens van een specifieke medewerker van een schuldeiser (uniek organisatienummer). Deze service kan gebruikt worden om gegevens op te halen van één specifieke medewerker. Gegevens van de beheerder worden niet via deze service gegeven. Output: Organisatienummer, aanmeldnaam medewerker Gegevens van de medewerker (Achternaam, voornaam, aanmeldnaam, wachtwoord, geslacht, telefoonnummer, etc.) in de structure TMedewerkerDetail (zie paragraaf 4.3). - 1003 Geen gebruiker met deze aanmeldnaam - 1005 Dit betreft beheerder gegevens Versie: 16 september 2012 Blz.: 10 van 66

2 DICOSCentrale Server 2.3.4 WijzigMedewerker De service BeheerService.WijzigMedewerker stuurt gewijzigde gegevens van een specifieke medewerker naar de DICOS Centrale. Deze service kan gebruikt worden wanneer de beheerder gegevens van een specifieke medewerker wilt wijzigen. Gegevens van de beheerder mogen niet via deze service gewijzigd worden (wijzigingen moeten op een andere wijze worden doorgegeven aan de DICOS Centrale). Gegevens die via deze webservice gewijzigd kunnen worden zijn: o Achternaam o Voornaam o Wachtwoord o Geslacht o Telefoonnummer o E-mail adres o Indicatie Schuldhulpverlening o Indicatie Budgetbeheer o Blokkering. Gegevens van de medewerker (Achternaam, voornaam, aanmeldnaam, wachtwoord, geslacht, telefoonnummer, etc.) in de structure TMedewerkerDetail (zie paragraaf 4.3). Output: - N.B. eventueel via deze webservice doorgegeven wijzigingen in de gegevens 'Aanmeldnaam', 'Laatste aanmelddatum' en 'Indicatie Beheerder' zullen door de DICOS Centrale nooit worden doorgevoerd. - 1003 Geen gebruiker met deze aanmeldnaam - 1005 Dit betreft beheerder gegevens 2.3.5 NieuweMedewerker De service BeheerService.NieuweMedewerker stuurt nieuwe gegevens van een specifieke medewerker naar de DICOS Centrale. Deze service kan gebruikt worden wanneer de beheerder gegevens van een nieuwe medewerker wilt toevoegen. Gegevens die, voor het toevoegen van een medewerker, via deze webservice gevuld kunnen worden zijn: o Achternaam o Voornaam o Aanmeldnaam o Wachtwoord o Geslacht Versie: 16 september 2012 Blz.: 11 van 66

2 DICOSCentrale Server o Telefoonnummer o E-mail adres o Indicatie Schuldhulpverlening o Indicatie Budgetbeheer o Blokkering. Voor het succesvol toevoegen van een nieuwe medewerker zijn minimaal 'Aanmeldnaam' en 'Wachtwoord' noodzakelijk. Gegevens van de medewerker (Achternaam, voornaam, aanmeldnaam, wachtwoord, geslacht, telefoonnummer, etc.) in de structure TMedewerkerDetail (zie paragraaf 4.3). Output: - N.B. eventueel via deze webservice doorgegeven wijzigingen in de gegevens 'Aanmeldnaam', 'Laatste aanmelddatum' en 'Indicatie Beheerder' zullen door de DICOS Centrale nooit worden doorgevoerd. - 1006 Aanmeldnaam niet gevuld - 1007 Wachtwoord niet gevuld - 1008 Deze aanmeldnaam komt al voor 2.3.6 VerwijderMedewerker De service BeheerService.VerwijderMedewerker verwijdert gegevens van een specifieke medewerker van de DICOS Centrale. Deze service kan gebruikt worden wanneer de beheerder gegevens van een medewerker wilt verwijderen. Gegevens van de beheerder mogen niet via deze service verwijderd worden Organisatienummer, aanmeldnaam medewerker Output: - - 1003 Geen gebruiker met deze aanmeldnaam - 1005 Dit betreft beheerder gegevens Versie: 16 september 2012 Blz.: 12 van 66

2 DICOSCentrale Server 2.3.7 GetMeldingOverzicht De service BeheerService.GetMeldingOverzicht geeft de gegevens van alle meldingen van de DICOS Centrale vanaf een bepaalde datum. Deze service kan gebruikt worden om nieuwe meldingen op te halen. Dit kunnen bijvoorbeeld meldingen zijn over gepland onderhoud op de Centrale, of wijzigingen aan de website, of wijzigingen aan de webservices. Datum vanaf Output: Gegevens van diverse meldingen (datum melding, volgnummer melding, soort melding, tekst) in een array van de structure TMelding (zie paragraaf 4.4). ExtraInfoOmschrijving, wanneer het resultaat van de aanroep false is. 2.3.8 GetMelding De service BeheerService.GetMelding geeft de gegevens van een specifieke melding. Deze service kan gebruikt worden om gegevens op te halen van een specifieke melding. Output: Datum melding, volgnummer melding Gegevens van de melding (datum melding, volgnummer melding, soort melding, tekst) in de structure TMelding (zie paragraaf 4.4). - 1009 Geen melding van deze datum - 1010 Geen melding met dit volgnummer 2.3.9 WijzigMedewerkerWachtwoord De service Beheerservice.WijzigMedewerkerWachtwoord wijzigt, mits het correcte huidige medewerker wachtwoord is ingegeven, het huidige medewerker wachtwoord. Organisatienummer, Medewerkercode, WachtwoordOud, WachtwoordNieuw Output: - - 1002 Wachtwoord niet juist - 1005 Dit betreft beheerder gegevens - 1029 Geen toegang tot deze organisatie - 1038 Medewerker onbekend Versie: 16 september 2012 Blz.: 13 van 66

2 DICOSCentrale Server 2.3.10 ZoekMedewerker De service Beheerservice.ZoekMedewerker geeft de gegevens van alle medewerkers van de organisatie terug die voldoen aan het zoekcriterium. Output: OrganisatieNummer, Naam(zoek criteria) Gegevens van de medewerkers die voldoen aan het zoekcriterium (Achternaam, voornaam, aanmeldnaam, wachtwoord, geslacht, telefoonnummer, etc.) in een array van de structure TMedewerkerHeader (zie paragraaf 4.3). -1029 Geen toegang tot deze organisatie 2.3.11 AbonnementOpzeggen Met de service Beheerservice.abonnementOpzeggen kan de organisatie zijn/haar DICOS abonnement opzeggen. De service verzend na akkoord een bevestiging per e-mail naar de organisatie. Organisatienummer, Opzegdatum, OpzeggingsReden Output: - ExtraInfoOmschrijving, wanneer het resultaat van de aanroep false is. Versie: 16 september 2012 Blz.: 14 van 66

2 DICOSCentrale Server 2.4 SCHULDHULPSERVICE 2.4.1 Algemeen De SchuldhulpService bevat alle methoden die te maken hebben met schuldhulpverlening. Of een medewerker deze webservices mag aanroepen, kan, desgewenst, afgevraagd worden middels de indicatie Schuldhulpverlening bij de aangemelde medewerker (zie LoginService). 2.4.2 GetSaldoVraagOverzicht De service SchuldhulpService.GetSaldoVraagOverzicht kan worden gebruikt om alle klaarstaande verzoeken tot saldo opgaaf van de aangesloten Allegro organisaties voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Output: Organisatienummer, Filter gegevens in de structure TFilterSettings(zie Paragraaf 4.20), Sortering gegevens in de structure TSorteerInfo(zie Paragraaf 4.22), Pagina gegevens in de structure TPaginaInfo(zie Paragraaf 4.21) De gegevens van alle verzoeken tot saldo opgaaf in een array van de structure TSaldoVraagHeader (zie paragraaf 4.10). De DICOS Centrale zal, voor afhandeling van deze service, met alle aangesloten Allegro organisaties contact maken en de daar klaarstaande verzoeken tot saldo opgaaf ophalen via de DICOSAllegro Server. Afhankelijk van de Filter, Sortering en Pagina gegevens zullen de gegevens in een array van de structure TSaldoVraagHeader worden teruggegeven. - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening 2.4.3 GetSaldoVraag De service SchuldhulpService.GetSaldoVraag kan worden gebruikt om één specifiek verzoek tot saldo opgaaf van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Output: Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Allegro schuld relatiecode, Allegro schuld volgnummer (identificerende gegevens juiste schuld, kunnen worden gehaald uit de eerder opgehaalde array). De gegevens van het verzoek tot saldo opgaaf in de structure TSaldoVraagDetail (zie paragraaf 4.10). Versie: 16 september 2012 Blz.: 15 van 66

2 DICOSCentrale Server De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en het specifieke verzoek tot saldo opgaaf ophalen via de DICOSAllegro Server. - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend - 1013 Schuld onbekend - 1014 Saldo opgaaf is reeds gedaan - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening - 1028 Maximale tijd voor tot stand brengen verbinding met schuldhulpverlenende organisatie is verstreken. 2.4.4 WijzigSaldoVraag De service SchuldhulpService.WijzigSaldoVraag kan worden gebruikt om één specifiek verzoek tot saldo opgaaf van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser af te handelen. Ter identificatie van de juiste schuld: Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Allegro schuld relatiecode en Allegro schuld volgnummer uit de structure TSaldoVraagHeader (zie paragraaf 4.10). Wijzigingen: klantnummer (verplicht te vullen), bedrag (saldo), referentie, overgedragen aan incassobureau (indicatie ja/nee), overgedragen aan incassobureau (tekstveld), opmerkingen (tekstveld) Output: - De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en de wijzigingen én verwerken in de Centrale (klantnummer) én in een mutatie plaatsen in Allegro Portier, zodat de wijzigingen verder in Allegro afgehandeld kunnen worden (teruggemeld bedrag, teruggemelde referentie, overgedragen aan incassobureau en opmerkingen). Bij het plaatsen van de mutatie in Allegro Portier zullen ook de datum en gegevens van de medewerker van de schuldeiser die de saldo opgaaf heeft afgehandeld worden meegegeven (voornaam en achternaam medewerker, telefoonnummer en e-mail adres). Afhankelijk van welke gegevens wel of niet gevuld zijn (gewijzigd zijn) kunnen hierdoor verschillende soorten mutaties in Allegro Portier ontstaan. - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend Versie: 16 september 2012 Blz.: 16 van 66

2 DICOSCentrale Server - 1013 Schuld onbekend - 1014 Saldo opgaaf is reeds gedaan - 1015 Teruggemeld bedrag niet gevuld - 1016 Klantnummer niet gevuld - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening - 1028 Maximale tijd voor tot stand brengen verbinding met schuldhulpverlenende organisatie is verstreken 2.4.5 NieuweSchuld De service SchuldhulpService.NieuweSchuld kan worden gebruikt om een extra schuld aan te melden bij een specifiek contract (aanvraag) van een aangesloten Allegro organisatie. De gegevens die nodig zijn ter identificatie van het juiste contract (aanvraag) en de juiste relatie (klantnummer schuldeiser kunnen worden gehaald uit een eerdere opvraag van, bijvoorbeeld GetSaldoVraag: voor deze klant wordt om saldo-opgaaf verzocht, maar van die klant hebben we nog een schuld openstaan. Het is wel noodzakelijk dat het klantnummer van de schuldeiser dan reeds bekend is in de DICOS Centrale. Ter identificatie van de juiste relatie: Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Klantnummer, Wijzigingen: nieuw bedrag (verplicht te vullen), nieuwe referentie (verplicht te vullen), opmerkingen (tekstveld) Output: - De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en de nieuwe schuld (bedrag, referentie, opmerkingen) in een mutatie plaatsen van Allegro Portier, zodat de toevoeging verder in Allegro afgehandeld kan worden. Bij het plaatsen van de mutatie in Allegro Portier zullen ook de datum en gegevens van de medewerker van de schuldeiser die de schuld heeft gemeld worden meegegeven (voornaam en achternaam medewerker, telefoonnummer en e-mail adres). - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend - 1017 Klantnummer onbekend - 1018 Bedrag niet gevuld - 1019 Referentie niet gevuld - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening - 1028 Maximale tijd voor tot stand brengen verbinding met schuldhulpverlenende organisatie is verstreken - 1029 Klantnummer in deze SR-aanvraag onbekend Versie: 16 september 2012 Blz.: 17 van 66

2 DICOSCentrale Server 2.4.6 GetSaldoVoorstelOverzicht De service SchuldhulpService.GetSaldoVoorstelOverzicht kan worden gebruikt om alle klaarstaande voorstellen tot saldo terugbetaling van de aangesloten Allegro organisaties voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Organisatienummer, Filter gegevens in de structure TFilterSettings(zie Paragraaf 4.20), Sortering gegevens in de structure TSorteerInfo(zie Paragraaf 4.22), Pagina gegevens in de structure TPaginaInfo(zie Paragraaf 4.21) Output: De gegevens van alle verzoeken tot saldo terugbetaling in een array van de structure TSaldoVoorstelHeader (zie paragraaf 4.12). De DICOS Centrale zal, voor afhandeling van deze service, met alle aangesloten Allegro organisaties contact maken en de daar klaarstaande voorstellen tot saldo terugbetaling ophalen via de DICOSAllegro Server. Afhankelijk van de Filter, Sortering en Pagina gegevens zullen de gegevens in een array van de structure TSaldoVoorstelHeader worden teruggegeven. - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening 2.4.7 GetSaldoVoorstel De service SchuldhulpService.GetSaldoVoorstel kan worden gebruikt om één specifiek voorstel tot saldo terugbetaling van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Output: Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Allegro schuld relatiecode, Allegro schuld volgnummer (identificerende gegevens juiste schuld, kunnen worden gehaald uit de eerder opgehaalde array) De gegevens van het voorstel tot saldo terugbetaling in de structure TSaldoVoorstelDetail (zie paragraaf 4.12). De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en het specifieke voorstel tot saldo terugbetaling ophalen via de DICOSAllegro Server. Versie: 16 september 2012 Blz.: 18 van 66

2 DICOSCentrale Server ExtraInfoOmschrijving: - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend - 1013 Schuld onbekend - 1020 Saldo voorstel is reeds beantwoord - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening - 1028 Maximale tijd voor tot stand brengen verbinding met schuldhulpverlenende organisatie is verstreken 2.4.8 WijzigSaldoVoorstel De service SchuldhulpService.WijzigSaldoVoorstel kan worden gebruikt om één specifiek voorstel tot saldo terugbetaling van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser af te handelen. Ter identificatie van de juiste schuld: Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Allegro schuld relatiecode en Allegro schuld volgnummer uit de structure TSaldoVoorstelHeader (zie paragraaf 4.12). Wijzigingen: akkoord (ja/nee verplicht te vullen), overgedragen aan incassobureau (boolean( true of false )), overgedragen aan incassobureau omschrijving (tekstveld), opmerkingen (tekstveld) Output: - De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en de wijzigingen (akkoord ja/nee, overgedragen aan incassobureau, overgedragen aan incassobureau omschrijving, opmerkingen) in een mutatie plaatsen van Allegro Portier, zodat de wijzigingen verder in Allegro afgehandeld kunnen worden. Bij het plaatsen van de mutatie in Allegro Portier zullen ook de datum en gegevens van de medewerker van de schuldeiser die het saldo voorstel heeft afgehandeld worden meegegeven (voornaam en achternaam medewerker, telefoonnummer en e-mail adres). Afhankelijk van welke gegevens wel of niet gevuld zijn (gewijzigd zijn) kunnen hierdoor verschillende soorten mutaties in Allegro Portier ontstaan. Indien ook een wijziging in het klantnummer is doorgegeven, zal deze wijziging verwerkt worden in de Centrale. Het kan zijn dat het klantnummer nu pas initieel wordt doorgegeven (de schuldeiser is pas opgenomen in DICOS nadat de aanmelding al heeft plaats gevonden of de SHV is pas gestart met DICOS nadat de aanmelding al heeft plaats gevonden). - 1011 Allegro organisatienummer onbekend Versie: 16 september 2012 Blz.: 19 van 66

2 DICOSCentrale Server - 1012 Contract onbekend - 1013 Schuld onbekend - 1020 Saldo voorstel is reeds beantwoord - 1021 Akkoord ja/nee niet gevuld - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening - 1028 Maximale tijd voor tot stand brengen verbinding met schuldhulpverlenende organisatie is verstreken 2.4.9 GetAankondigingEindeOverzicht De service SchuldhulpService.GetAankondigingEindeOverzicht kan worden gebruikt om alle klaarstaande aankondigingen beëindiging SR(-NPS) waarop gereageerd moet worden van de aangesloten Allegro organisaties voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Organisatienummer, Filter gegevens in de structure TFilterSettings(zie Paragraaf 4.20), Sortering gegevens in de structure TSorteerInfo(zie Paragraaf 4.22), Pagina gegevens in de structure TPaginaInfo(zie Paragraaf 4.21) Output: De gegevens van alle aankondigingen beëindiging in een array van de structure TAankondigingEindeHeader (zie paragraaf 4.13). De DICOS Centrale zal, voor afhandeling van deze service, met alle aangesloten Allegro organisaties contact maken en de daar klaarstaande voorstellen tot saldo terugbetaling ophalen via de DICOSAllegro Server. Afhankelijk van de Filter, Sortering en Pagina gegevens zullen de gegevens in een array van de structure TAankondigingEindeHeader worden teruggegeven. - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening 2.4.10 GetAankondigingEinde De service SchuldhulpService.GetAankondigingEinde kan worden gebruikt om één specifieke aankondiging beëindiging van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Allegro schuld relatiecode, Allegro schuld volgnummer (identificerende gegevens juiste schuld, kunnen worden gehaald uit de eerder opgehaalde array) Versie: 16 september 2012 Blz.: 20 van 66

2 DICOSCentrale Server Output: De gegevens van de aankondiging beëindiging in de structure TAankondigingEindeDetail (zie paragraaf 4.13). De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en de specifieke aankondiging beëindiging ophalen via de DICOSAllegro Server. - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend - 1013 Schuld onbekend - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening - 1028 Maximale tijd voor tot stand brengen verbinding met schuldhulpverlenende organisatie is verstreken - 1030 Aankondiging beëindiging is reeds afgehandeld 2.4.11 WijzigAankondigingEinde De service SchuldhulpService.WijzigAankondigingEinde kan worden gebruikt om één specifieke aankondiging beëindiging van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser af te handelen. Ter identificatie van de juiste schuld: Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Allegro schuld relatiecode en Allegro schuld volgnummer uit de structure TAankondigingEindeHeader (zie paragraaf 4.13). Wijzigingen: akkoord (ja/nee verplicht te vullen), klantnummer, opmerkingen (tekstveld) Output: - De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en de wijzigingen (akkoord ja/nee en opmerkingen) in een mutatie plaatsen van Allegro Portier, zodat de wijzigingen verder in Allegro afgehandeld kunnen worden. Bij het plaatsen van de mutatie in Allegro Portier zullen ook de datum en gegevens van de medewerker van de schuldeiser die het saldo voorstel heeft afgehandeld worden meegegeven (voornaam en achternaam medewerker, telefoonnummer en e-mail adres). Indien ook een wijziging in het klantnummer is doorgegeven, zal deze wijziging verwerkt worden in de Centrale. Het kan zijn dat het klantnummer nu pas initieel wordt doorgegeven (de schuldeiser is pas later opgenomen in DICOS of de SHV is pas later gestart met DICOS). Versie: 16 september 2012 Blz.: 21 van 66

2 DICOSCentrale Server - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend - 1013 Schuld onbekend - 1021 Akkoord ja/nee niet gevuld - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening - 1028 Maximale tijd voor tot stand brengen verbinding met schuldhulpverlenende organisatie is verstreken - 1030 Aankondiging beëindiging is reeds afgehandeld 2.4.12 GetMeldingOverzicht De service SchuldhulpService.GetMeldingOverzicht kan worden gebruikt om alle klaarstaande meldingen van de aangesloten Allegro organisaties betreffende schuldhulpverlening voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Organisatienummer, Filter gegevens in de structure TFilterSettings(zie Paragraaf 4.20), Sortering gegevens in de structure TSorteerInfo(zie Paragraaf 4.22), Pagina gegevens in de structure TPaginaInfo(zie Paragraaf 4.21) Output: De gegevens van alle meldingen in een array van de structure TKlantMeldingHeader (zie paragraaf 4.5). De DICOS Centrale zal, voor afhandeling van deze service, met alle aangesloten Allegro organisaties contact maken en de daar klaarstaande meldingen voor schuldhulpverlening ophalen via de DICOSAllegro Server. Afhankelijk van de Filter, Sortering en Pagina gegevens zullen de gegevens in een array van de structure TKlantMeldingHeader worden teruggegeven. - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening 2.4.13 GetMelding De service SchuldhulpService.GetMelding kan worden gebruikt om één specifieke melding van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Organisatienummer, Allegro organisatienummer, Allegro Melding Volgnummer (identificerende gegevens juiste melding, kunnen worden gehaald uit de eerder opgehaalde array) Output: De gegevens van de melding in de structure TKlantMeldingDetail (zie paragraaf 4.5). Versie: 16 september 2012 Blz.: 22 van 66

2 DICOSCentrale Server De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en de specifieke melding ophalen via de DICOSAllegro Server. - 1011 Allegro organisatienummer onbekend - 1022 Melding onbekend - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening - 1028 Maximale tijd voor tot stand brengen verbinding met schuldhulpverlenende organisatie is verstreken - 1031 Geen Schuldhulpverlening melding 2.4.14 WijzigMelding De service SchuldhulpService.WijzigMelding kan worden gebruikt om één specifieke melding van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser af te handelen ('gelezen'). Organisatienummer, Allegro organisatienummer, Allegro Melding Volgnummer (identificerende gegevens juiste melding, kunnen worden gehaald uit de eerder opgehaalde array) Wijzigingen: klantnummer Output: - De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en daar de juiste service aanroepen. Indien ook een wijziging in het klantnummer is doorgegeven, zal deze wijziging verwerkt worden in de Centrale. Het kan zijn dat het klantnummer nu pas initieel wordt doorgegeven (de schuldeiser is pas later opgenomen in DICOS of de SHV is pas later gestart met DICOS). - 1011 Allegro organisatienummer onbekend - 1022 Melding onbekend - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening - 1028 Maximale tijd voor tot stand brengen verbinding met schuldhulpverlenende organisatie is verstreken - 1031 Geen Schuldhulpverlening melding Versie: 16 september 2012 Blz.: 23 van 66

2 DICOSCentrale Server 2.4.15 GetKlantnummer De service SchuldhulpService.GetKlantNummer kan worden gebruikt om aan de hand van een ingegeven klantnummer de Allegro organisaties te achterhalen waar voor deze klant voor de, bij de DICOS Centrale aangemelde, schuldeiser schuldhulpverlening wordt uitgevoerd. Output: Organisatienummer, klantnummer De gegevens van de gevonden Allegro organisaties in de structure TKlantNummer (zie paragraaf 4.8). De DICOS Centrale zal, voor afhandeling van deze service, gegevens gebruiken uit de Centrale. - 1023 Klantnummer onbekend - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening 2.4.16 GetKlant De service SchuldhulpService.GetKlant kan worden gebruikt om gegevens van de schuldhulpverlening van één specifieke klant van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Output: Organisatienummer, Allegro organisatienummer (kan worden gehaald uit de eerder opgehaalde array van GetKlantNummer), klantnummer De gegevens in een array (er kunnen immers meerdere schulden van één klant zijn voor deze schuldeiser bij dezelfde Allegro organisatie) van de structure TKlantSchuldHeader (zie paragraaf 4.14). De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en de gegevens ophalen via de DICOSAllegro Server. - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend - 1013 Schuld onbekend - 1023 Klantnummer onbekend - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening - 1028 Maximale tijd voor tot stand brengen verbinding met Versie: 16 september 2012 Blz.: 24 van 66

2 DICOSCentrale Server schuldhulpverlenende organisatie is verstreken 2.4.17 GetKlantSchuld De service SchuldhulpService.GetKlantSchuld kan worden gebruikt om alle gegevens van één specifieke schuld van één specifieke klant van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Allegro schuld relatiecode, Allegro schuld volgnummer (identificerende gegevens juiste schuld, kunnen worden gehaald uit de eerder opgehaalde array) Output: De gegevens van de schuld in de structure TKlantSchuldDetail (zie paragraaf 4.14). De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en daar de juiste service aanroepen. - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend - 1013 Schuld onbekend - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening - 1028 Maximale tijd voor tot stand brengen verbinding met schuldhulpverlenende organisatie is verstreken 2.4.18 GetAlleKlanten De service SchuldhulpService.GetAlleKlanten kan worden gebruikt om alle klanten van de aangesloten Allegro organisaties op te halen waar voor de, bij de DICOS Centrale aangemelde, schuldeiser schuldhulpverlening wordt uitgevoerd. Organisatienummer, Filter gegevens in de structure TFilterSettings(zie Paragraaf 4.20), Sortering gegevens in de structure TSorteerInfo(zie Paragraaf 4.22), Pagina gegevens in de structure TPaginaInfo(zie Paragraaf 4.21) Output: De gegevens in een array van de structure TKlantSchuldHeader (zie paragraaf 4.14). De DICOS Centrale zal, voor afhandeling van deze service, met alle aangesloten Allegro organisaties contact maken en de daar bekende schulden ophalen via de DICOSAllegroServer. Afhankelijk van de Filter, Sortering en Pagina gegevens zullen de gegevens in een array van de structure TKlantSchuldHeader worden teruggegeven. Versie: 16 september 2012 Blz.: 25 van 66

2 DICOSCentrale Server - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening 2.4.19 GetManagementInfo De service SchuldhulpService.GetManagementInfo kan worden gebruikt om een managementinformatie op te halen voor de, bij de DICOS Centrale aangemelde, schuldeiser. Organisatienummer Output: ManagementInfo (In de structure TSRInfoCentrale zie paragraaf 4.25), ManagementInfoOnvolledig (Boolean( true of false ) De boolean ManagementInfoOnvolledig geeft aan of alle schuldhulpverlenende instanties konden worden bereikt, en zodoende dus een volledig overzicht aan managementinfo. Kan worden gegeven. Waarbij geldt true = onvolledig en false =volledig. - 1026 Organisatie geen toegang tot schuldhulpverlening - 1027 Medewerker geen toegang tot schuldhulpverlening Versie: 16 september 2012 Blz.: 26 van 66

2 DICOSCentrale Server 2.5 BBRSERVICE 2.5.1 Algemeen De BBRService bevat alle methoden die te maken hebben met budgetbeheer. Of een medewerker deze webservices mag aanroepen, kan, desgewenst, afgevraagd worden middels de indicatie Budgetbeheer bij de aangemelde medewerker (zie o.a. LoginService). 2.5.2 GetBBRAanmeldingOverzicht De service BBRService.GetBBRAanmeldingOverzicht kan worden gebruikt om alle klaarstaande aanmeldingen voor budgetbeheer van de aangesloten Allegro organisaties voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Organisatienummer, Filter gegevens in de structure TFilterSettings(zie Paragraaf 4.20), Sortering gegevens in de structure TSorteerInfo(zie Paragraaf 4.22), Pagina gegevens in de structure TPaginaInfo(zie Paragraaf 4.21) Output: De gegevens van alle aanmeldingen voor budgetbeheer in een array van de structure TBBRAanmeldingHeader (zie paragraaf 4.16). De DICOS Centrale zal, voor afhandeling van deze service, met alle aangesloten Allegro organisaties contact maken en de daar klaarstaande aanmeldingen voor budgetbeheer ophalen via de DICOSAllegro Server. Afhankelijk van de Filter, Sortering en Pagina gegevens zullen de gegevens in een array van de structure TBBRAanmeldingHeader worden teruggegeven. - 1029 Organisatie geen toegang tot budgetbeheer - 1030 Medewerker geen toegang tot budgetbeheer 2.5.3 GetBBRAanmelding De service BBRService.GetBBRAanmelding kan worden gebruikt om één specifieke aanmelding voor budgetbeheer van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Output: Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Allegro opdracht soort, Allegro opdracht reservering, Allegro opdracht relatiecode, Allegro opdracht volgnummer (identificerende gegevens juiste opdracht, kunnen worden gehaald uit de eerder opgehaalde array). De gegevens van de aanmelding in de structure TBBRAanmeldingDetail (zie paragraaf 4.16). Versie: 16 september 2012 Blz.: 27 van 66

2 DICOSCentrale Server De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en de specifieke aanmelding voor budgetbeheer ophalen via de DICOSAllegro Server. - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend - 1024 Opdracht onbekend - 1029 Organisatie geen toegang tot budgetbeheer - 1030 Medewerker geen toegang tot budgetbeheer 2.5.4 VerwerkBBRAanmelding De service BBRService.VerwerkBBRAanmelding kan worden gebruikt om één specifieke aanmelding voor budgetbeheer van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser af te handelen ( gelezen ). Ter identificatie van de juiste opdracht: Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Allegro opdracht soort, Allegro opdracht reservering, Allegro opdracht relatiecode en Allegro opdracht volgnummer uit de structure TOpdrachtSharedHeader (zie paragraaf 4.15). Wijzigingen: klantnummer (verplicht te vullen) Output: - De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en de wijzigingen én verwerken in de Centrale (klantnummer) én in Allegro. - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend - 1024 Opdracht onbekend - 1026 Klantnummer niet gevuld - 1029 Organisatie geen toegang tot budgetbeheer - 1030 Medewerker geen toegang tot budgetbeheer Versie: 16 september 2012 Blz.: 28 van 66

2 DICOSCentrale Server 2.5.5 GetBBROpdrachtOverzicht De service BBRService.GetBBROpdrachtOverzicht kan worden gebruikt om alle opdrachten voor budgetbeheer van de aangesloten Allegro organisaties voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Organisatienummer, Filter gegevens in de structure TFilterSettings(zie Paragraaf 4.20), Sortering gegevens in de structure TSorteerInfo(zie Paragraaf 4.22), Pagina gegevens in de structure TPaginaInfo(zie Paragraaf 4.21) Output: De gegevens van alle opdrachten voor budgetbeheer in een array van de structure TBBROpdrachtHeader(zie paragraaf 4.9). De DICOS Centrale zal, voor afhandeling van deze service, met alle aangesloten Allegro organisaties contact maken en de opdrachten voor budgetbeheer ophalen via de DICOSAllegro Server. Afhankelijk van de Filter, Sortering en Pagina gegevens zullen de gegevens in een array van de structure TBBRAanmeldingHeader worden teruggegeven. - 1029 Organisatie geen toegang tot budgetbeheer - 1030 Medewerker geen toegang tot budgetbeheer 2.5.6 GetBBROpdracht De service BBRService.GetBBROpdracht kan worden gebruikt om één specifieke opdracht voor budgetbeheer van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser op te halen. Output: 4.17). Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Allegro opdracht soort, Allegro opdracht reservering, Allegro opdracht relatiecode, Allegro opdracht volgnummer (identificerende gegevens juiste schuld, kunnen worden gehaald uit de eerder opgehaalde array). De gegevens van de opdracht in de structure TBBROpdrachtDetail (zie paragraaf De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en de specifieke opdracht voor budgetbeheer ophalen via de DICOSAllegro Server. Versie: 16 september 2012 Blz.: 29 van 66

2 DICOSCentrale Server - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend - 1024 Opdracht onbekend - 1029 Organisatie geen toegang tot budgetbeheer - 1030 Medewerker geen toegang tot budgetbeheer 2.5.7 VerwerkBBROpdracht De service BBRService.VerwerkBBROpdracht kan worden gebruikt om één specifieke opdracht voor budgetbeheer van een aangesloten Allegro organisatie voor de, bij de DICOS Centrale aangemelde, schuldeiser te wijzigen. Ter identificatie van de juiste opdracht: Organisatienummer, Allegro organisatienummer, Allegro contract relatiecode, Allegro contract volgnummer, Allegro opdracht soort, Allegro opdracht reservering, Allegro opdracht relatiecode en Allegro opdracht volgnummer uit de structure TOpdrachtSharedHeader(zie paragraaf 4.15). Wijzigingen: klantnummer, periodebedrag, referentie, opmerkingen (tekstveld) Output: - De DICOS Centrale zal, voor afhandeling van deze service, met de aangegeven Allegro organisatie contact maken en de wijzigingen én verwerken in de Centrale (klantnummer) én in een mutatie plaatsen in Allegro Portier, zodat de wijzigingen verder in Allegro afgehandeld kunnen worden (periode bedrag, referentie en opmerkingen). Bij het plaatsen van de mutatie in Allegro Portier zullen ook de datum en gegevens van de medewerker van de schuldeiser die de aanmelding heeft afgehandeld worden meegegeven (voornaam en achternaam medewerker, telefoonnummer en e-mail adres). Afhankelijk van welke gegevens wel of niet gevuld zijn (gewijzigd zijn) kunnen hierdoor verschillende soorten mutaties in Allegro Portier ontstaan. - 1011 Allegro organisatienummer onbekend - 1012 Contract onbekend - 1024 Opdracht onbekend - 1029 Organisatie geen toegang tot budgetbeheer - 1030 Medewerker geen toegang tot budgetbeheer 2.5.8 GetBBROpdrachtOverzichtCSV De service BBRService.GetBBROpdrachtOverzichtCSV kan worden gebruikt om een CSV te downloaden van de DICOS Centrale met daarin alle opdrachten voor budgetbeheer van de aangesloten Allegro organisaties voor de, bij de DICOS Centrale aangemelde, schuldeiser. Organisatienummer. Versie: 16 september 2012 Blz.: 30 van 66

2 DICOSCentrale Server Output: CSV Binary De DICOS Centrale zal, voor afhandeling van deze service, met alle aangesloten Allegro organisaties contact maken, de opdrachten voor budgetbeheer ophalen via de DICOSAllegro Server, verwerken in een CSV - bestand en dit versturen. Kolommen: AllegroOrganisatieNummer niet wijzigbaar - identificatie AllegroContractRelatieCode niet wijzigbaar - identificatie AllegroContractVolgnummer niet wijzigbaar - identificatie AllegroOpdrachtSoort niet wijzigbaar - identificatie AllegroOpdrachtReservering niet wijzigbaar - identificatie AllegroOpdrachtRelatiecode niet wijzigbaar - identificatie AllegroOpdrachtVolgnummer niet wijzigbaar identificatie AllegroOrganisatieNaam niet wijzigbaar KlantAchternaam niet wijzigbaar KlantVoorvoegsels niet wijzigbaar KlantVoorletters niet wijzigbaar KlantGeboortedatum niet wijzigbaar Klantnummer wijzigbaar OpdrachtReferentie wijzigbaar OpdrachtDatum niet wijzigbaar OpdrachtBedrag wijzigbaar Opmerkingen leeg, invulbaar. - 1029 Organisatie geen toegang tot budgetbeheer - 1030 Medewerker geen toegang tot budgetbeheer 2.5.9 PutBBROpdrachtOverzichtCSV De service BBRService.PutBBROpdrachtOverzichtCSV kan worden gebruikt om het aangepaste (klantnummer, bedrag, referentie) Excelbestand te uploaden naar de DICOS Centrale. Gebruiker(in de structure AWUserInfo zie paragraaf 4.1), Organisatienummer, CSV bestand, Output: Meldingen(StringArray), De DICOS Centrale zal, voor afhandeling van deze service, het Excelbestand verwerken en vervolgens de wijzigingen in mutaties laten plaatsen in Allegro Portier bij de juiste Allegro organisaties, zodat de wijzigingen verder in Allegro afgehandeld kunnen worden (periode bedrag, referentie en opmerkingen). Bij het plaatsen van de mutatie in Allegro Portier zullen ook de datum en gegevens van de medewerker van de schuldeiser die het bestand heeft ge-upload worden meegegeven (voornaam en achternaam medewerker, telefoonnummer en e-mail adres). Afhankelijk van Versie: 16 september 2012 Blz.: 31 van 66