Aanvraag Service - Complexe Types

Uit DSP
Ga naar: navigatie, zoeken

De AanvraagService bevat 30 complexe types. Deze worden hieronder per type toegelicht.

AansluitObjectBase

De complexe entiteit AansluitObjectBase bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
Adres Adres De waarde voor adres Ja
BagObjectCode Integer16 De waarde voor bag object code Nee
Coordinaten Coordinaten De waarde voor coordinaten Nee
HeeftMeerdereBAGIds boolean Indicator dat er meerdere BAG IDs voor een AansluitObject gevonden zijn. Als true, dan ja. Ja
IsPostcodeBijBenadering boolean Bij true is de postcode bij benadering. Ja
LocatieOmschrijving Tekst35 Veel gebruikt voor omschrijving van een punt tegenover een bestaande locatie voor bijvoorbeeld palen en objecten die geen BAG nummer hebben Nee
ObjectID Integer10 De waarde voor object ID Ja
ObjectType ObjectType De waarde voor object type Ja

AansluitObjecten

De complexe entiteit AansluitObjecten bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
AansluitObjectArray AanvraagAansluitObject De waarde voor aansluit object Ja

Aanvraag

De complexe entiteit Aanvraag bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
Aanleveringswijze Aanleveringswijze Analoog of Digitaal Ja
AanmaakDatum dateTime Datum waarop de aanvraag door de aanvrager is gestart. Ja
AansluitObjecten AansluitObjecten De waarde voor aansluit objecten Ja
AantalBijlagen Integer2 De waarde voor aantal bijlagen Ja
AanvraagDatum dateTime BDatum waarop de aanvraag op het LIP is afgerond en wordt aangeboden aan de netbeheerder(s) en de aanvraag status 3a krijgt. Ja
AanvraagID Integer10 De waarde voor aanvraag ID Ja
AanvraagVersie Integer2 Versie van de aanvraag. Deze is standaard '1' en kan alleen worden opgehoogd door het aanpassen van een offerte (UC018). Ja
Aanvrager Aanvrager De waarde voor aanvrager Ja
AanvragerReferentie Tekst35 De aanvrager kan optioneel een projectnaam en/of dossiernummer invoeren. Dit veld dient als referentie voor de aanvrager zelf en wordt vermeld bij alle gegevensuitwisseling met de aanvrager over deze aanvraag Nee
Bijlagen Bijlagen De waarde voor bijlagen Nee
ContactPersoon ContactPersoon De waarde voor contact persoon Nee
Coordinerende Coordinerende De waarde voor coordinerende Nee
CorrespondentieAdres CorrespondentieAdres De waarde voor correspondentie adres Nee
FactuurOntvanger FactuurOntvanger De waarde voor factuur ontvanger Ja
IsCluster boolean false als sprake van 1 enkel object, true bij 2 of meer objecten. Ja
IsMix boolean Indicator of er verschillende subdienstcodes in de aanvraag zitten. Indien true, dan ja. Ja
IsNamensAanvragende boolean false, als zelf aangevraagd en true als door helpdesk medewerker. Ja
VerkoopDocumenten Integer10 De waarde voor verkoop documenten Nee
WijzigingsDatum dateTime Datum waarop de aanvraag is gewijzigd ivm het aanpassen van een offerte (UC018). Nee

AanvraagAansluitObject

De complexe entiteit AanvraagAansluitObject is een implementatie van AansluitObjectBase

Zie : AansluitObjectBase

Naam Type Toelichting Verplicht
Produkten Produkten De waarde voor Produkten Ja
ToekomstigeGebruiker ToekomstigeGebruiker De waarde voor ToekomstigeGebruiker Ja
WensJaar Year De waarde voor WensJaar Ja
WensWeek Integer12 De waarde voor WensWeek Ja

AanvraagProduct

De complexe entiteit AanvraagProduct is een implementatie van ProductBase

Zie : ProductBase

Naam Type Toelichting Verplicht
ProcesStatus ProcesStatus De waarde voor ProcesStatus Ja
ProcesVariant ProcesVariant De waarde voor ProcesVariant Ja

Aanvrager

De complexe entiteit Aanvrager bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
AanvragerID Integer10 De waarde voor aanvrager ID Ja
IsProfessioneel boolean false = eenmalig. true = professioneel. Ja
NotificatieNiveau NotificatieNiveau De frequentie waarop de aanvrager Track & Trace informatie wenst te ontvangen. Nee
NotificatieVoorkeur NotificatieVoorkeur De manier waarop de aanvrager Track & Trace informatie wenst te ontvangen. Ja
RelatieGegevens Relatie De waarde voor relatie gegevens Ja

AdditioneleVraag

De complexe entiteit AdditioneleVraag bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
Antwoord string De waarde voor antwoord Nee
AntwoordCode Tekst10 Het veld antwoordCode wordt enkel gebruikt indien er door de beheerder een vaste set van antwoorden is gedefinieerd. Dit is enkel het geval bij de vraag types RadioButton en DropDown. Nee
NetbeheerderCode OrganisatieCode De waarde voor netbeheerder code Ja
Vraag string De waarde voor vraag Ja
VraagCode Tekst10 De waarde voor vraag code Ja
VraagType VraagType De waarde voor vraag type Ja

AdditioneleVragen

De complexe entiteit AdditioneleVragen bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
AdditioneleVraagArray AdditioneleVraag De waarde voor additionele vraag Ja

Adres

De complexe entiteit Adres bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
Huisnummer Integer5 De waarde voor huisnummer Nee
HuisnummerToevoeging Tekst10 De waarde voor huisnummer toevoeging Nee
Land Tekst2 Aangezien we er op dit moment enkel Nederlands adressen worden ondersteund, zal dit veld standaard met NL zijn gevuld. Nee
Plaats Tekst128 De waarde voor plaats Nee
PostbusNummer Integer5 De waarde voor postbus nummer Nee
PostbusPlaats Tekst25 De waarde voor postbus plaats Nee
PostbusPostcode Tekst6 De waarde voor postbus postcode Nee
Postcode Tekst6 De waarde voor postcode Nee
Straat Tekst50 De waarde voor straat Nee
StraatNEN Tekst25 Alleen in het geval wanneer het LIP hierover beschikt, zal deze worden gevuld en meegestuurd. Nee

Bedrijf

De complexe entiteit Bedrijf bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
Bedrijfsnaam Tekst50 De waarde voor bedrijfsnaam Ja
BTWNummer BTWNummer De waarde voor BTW nummer Nee
ContactPersoon Persoon De waarde voor contactpersoon Nee
IsBTWVerlegd boolean Als true, dan ja Nee
KvKNummer Integer8 De waarde voor KVK nummer Nee

Bijlage

De complexe entiteit Bijlage bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
Bestandsgrootte Integer10 In bytes. Ja
Bestandsnaam Tekst35 De bestandsnaam bevat zowel naam als extensie Ja
BijlageID Integer10 De waarde voor bijlage ID Ja
MimeType Tekst100 De waarde voor mime type Ja
NetbeheerderCode OrganisatieCode De waarde voor netbeheerder code Ja
Omschrijving Tekst100 De waarde voor omschrijving Nee
VraagCode Tekst10 Bijlagen worden geconfigureerd als vragen. Ja

Bijlagen

De complexe entiteit Bijlagen bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
Bijlage Array Bijlage De waarde voor bijlage Nee
Omschrijving Tekst1000 Omschrijving voor alle bijlagen Nee

BTWComponent

De complexe entiteit BTWComponent bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
BTWBedrag Bedrag De waarde voor BTW bedrag Ja
BTWPercentage Percentage Omschrijving voor BTW percentage Ja

Contact

De complexe entiteit Contact bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
Emailadres Emailadres De waarde voor emailadres Ja
Naam Tekst50 Omschrijving voor naam Ja
TelefoonnummerMobiel TelefoonNummer telefoonnummer mobiel Ja

ContactPersoon

De complexe entiteit ContactPersoon is een implementatie van Contact

Zie : Contact

Naam Type Toelichting Verplicht
NotificatieVoorkeur NotificatieVoorkeur De manier waarop de aanvrager Track & Trace informatie wil ontvangen. Ja
ContactKenmerk string Vaste waarde : Contactpersoon Uitvoering Ja

Coordinaten

De complexe entiteit Coordinaten bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
Breedtegraad decimal De waarde voor breedtegraad Ja
Codestelsel string De waarde voor codestelsel Ja
Lengtegraad decimal De waarde voor lengtegraad Ja

Coordinerende

De complexe entiteit Coordinerende bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
HeeftMeerdereCoordinerenden boolean De waarde voor heeft meerdere coordinerenden Ja
OrganisatieCode OrganisatieCode De waarde voor organisatie code Ja
RelatieGegevens Relatie De waarde voor relatie gegevens Ja
VerzorgingsgebiedContractCode VerzorgingsgebiedContractCode De waarde voor verzorgingsgebied contract code Ja

CorrespondentieAdres

De complexe entiteit CorrespondentieAdres bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
isAanvrager boolean Als true, dan ja. Ja
isAfwijkendAdres boolean Indien adres afwijkt van adres aanvrager, dan true. Ja
relatieGegevens Relatie De waarde voor relatie gegevens Ja

FactuurOntvanger

De complexe entiteit FactuurOntvanger bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
isAanvrager boolean Als true, dan ja. Ja
isAfwijkendAdres boolean Indien adres afwijkt van adres aanvrager, dan true. Ja
relatieGegevens Relatie De waarde voor relatie gegevens Ja

GeaccepteerdeVoorwaarden

De complexe entiteit GeaccepteerdeVoorwaarden bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
GeaccepteerdeVoorwaardeArray De waarde voor geaccepteerde voorwaarde Nee

Persoon

De complexe entiteit Persoon bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
Aanhef Tekst6 De waarde voor aanhef Ja
Achternaam Tekst35 De waarde voor achternaam Ja
Tussenvoegsels Tekst10 De waarde voor tussenvoegsels Nee
Voorletters Tekst10 De waarde voor voorletters Ja

PrijscomponentRegel

De complexe entiteit PrijscomponentenRegel is een implementatie van RegelBase

Zie : RegelBase

Naam Type Toelichting Verplicht
PrijscomponentCode Text10 LIP prijscomponentcode die hoort bij de geldigheidsperiode van de betreffende prijscomponent. Ja
Aantal Integer10 De waarde voor aantal Ja
PrijsPerEenheid Bedrag De waarde voor Prijspereenheid Ja
Bedrag Bedrag Bevat het berekende bedrag ex-BTW van deze prijscomponent. Ja
BtwPercentage Percentage Het BTW percentage Ja

ProductBase

De complexe entiteit ProductBase bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
AdditioneleVragen AdditioneleVragen De waarde voor additionele vragen Nee
BedrijfseigenKenmerk Tekst10 Kenmerk waaraan het gekozen product kan worden gekoppeld in het bedrijfseigensysteem van de netbeheerder Nee
DienstCode Tekst2 De waarde voor dienst code Ja
DisciplineCode DisciplineCode De waarde voor discipline code Ja
DisciplineID Integer10 Het discipline ID is een unieke code. Middels deze code kan je de aanvraag (het werk), het object, maar ook de discipline herleiden. Als voorbeeld; stel er is een serie aanvraag met 3 disciplines (E, G en W) voor 6 objecten (woningen), dan zijn er 18 unieke discipline ID's. Er is ook 1 aanvraag ID. Het is overigens een unieke code en dus geen samengestelde code uit bijvoorbeeld het Aanvraag ID en de discipline (E, G, W). In geval van discipline Media kunnen er geen producten worden geselecteerd en wordt er een dummy productID per media-NBH gegenereerd dat wordt gebruikt als het disciplineID. Dat betekent dat de discipline Media meerdere keren in het bericht kan voorkomen (namelijk 1x per gevonden media-NBH). Ja
EANCode Integer18 De waarde voor EAN code Nee
HeeftOverlap boolean Indien er meer dan 1 netbeheerder gevonden wordt, dan true. Ja
IsEANHandmatig boolean Indicator of de aanvrager de EAN code zelf ingegeven heeft. Indien true, dan ja. Nee
IsEANKeuze boolean Indicator of de aanvrager de EAN code zelf gekozen heeft uit een lijst. Indien true, dan ja. Nee
NetbeheerderCode OrganisatieCode De waarde voor netbeheerder code Ja
PrijsIndicatieEenmalig Bedrag Indicatie van de eenmalige aansluitkosten. Nee
PrijsIndicatieMaandelijks Bedrag Indicatie van de maandelijkse transportkosten. Nee
ProductCode Tekst10 LIP productcode die hoort bij de geldigheidsperiode van het gekozen product. In geval van discipline Media wordt dit verplichte element gevuld met dummy-waarden Ja
Specificatie Tekst25 Bevat de korte product titel van het gekozen product. In geval van discipline Media wordt dit verplichte element gevuld met dummy-waarden. Ja
SubdienstCode Tekst4 De waarde voor subdienst code Ja
TariefCode Tekst10 Tariefcode waaraan het gekozen product kan worden gekoppeld in het bedrijfseigensysteem van de netbeheerder Nee

ProductRegel

De complexe entiteit ProductRegel is een extensie van RegelBase

Zie : RegelBase

Naam Type Toelichting Verplicht
ObjectID Integer10 Verwijzing naar het aansluitobject waarop deze regel van toepassing is Ja
DisciplineID Integer10 Verwijzing naar de discipline waarop deze regel van toepassing is Ja
ProductCode Tekst10 Verwijzing naar het product waarop de regel is gebaseerd Ja
PrijscomponentRegels PrijscomponentRegels De Prijscomponenten regels Ja

ProductRegels

De complexe entiteit ProductRegels bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
ProductRegelArray ProductRegel De waarde voor product regel Ja

RegelBase

De complexe entiteit RegelBase bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
BedrijfseigenKenmerk Tekst10 Kenmerk waaraan de betreffende prijscomponent kan worden gekoppeld in het bedrijfseigensysteem van de netbeheerder. Nee
IndicatieBezwaar boolean Indien de offerte is geweigerd, kan de aanvrager per verkoopdocumentregel (zowel voor product als prijscomponent) aangegeven waarop hij bewaart heeft. Nee
Omschrijving Tekst256 De daadwerkelijke tekst van de regel in de offerte. Ja
RegelNummer Integer5 Unieke referentie voor deze regel in de offerte. Ja
TariefCode Tekst10 Tariefcode waaraan de betreffende prijscomponent kan worden gekoppeld in het bedrijfseigensysteem van de netbeheerder. Nee

Relatie

De complexe entiteit Relatie bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
Adres Adres De waarde voor adres Nee
Bedrijfsgegevens Bedrijf De waarde voor bedrijfsgegevens Nee
Emailadres Emailadres De waarde voor emailadres Ja
Faxnummer Tekst25 De waarde voor faxnummer Ja
IsBedrijf boolean false = particulier. true = bedrijf. Nee
Persoonsgegevens Persoon De waarde voor persoonsgegevens Ja
Telefoonnummer TelefoonNummer De waarde voor telefoonnummer Ja
TelefoonnummerMobiel TelefoonNummer De waarde voor telefoonnummer mobiel Nee

ToekomstigeGebruiker

De complexe entiteit ToekomstigeGebruiker bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
RelatieGegevens Relatie Alleen adres gegevens gevuld indien soortCode niet onbekend is. Contact gegevens wel. Nee
SoortCode SoortGebruiker De waarde voor soort code Ja

VerkoopDocument

De complexe entiteit VerkoopDocument bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
AanmaakDatum dateTime Datum waarop de offerte is aangemaakt. Ja
AanvraagID Integer10 De waarde voor aanvraag ID Ja
AcceptatieDatum dateTime Datum waarop de offerte is geaccepteerd door de aanvrager. Nee
AnnuleringsDatum dateTime Datum waarop de offerte is geannuleerd door de aanvrager. Nee
BTWPerTariefSoort Opbouw van het totaal BTW bedrag. Ja
GeaccepteerdeVoorwaarden GeaccepteerdeVoorwaarden De voorwaarden die zijn geaccepteerd door de aanvrager Ja
NetbeheerderCode OrganisatieCode De waarde voor netbeheerder code Ja
ProcesStatus ProcesStatus De waarde voor proces status Ja
ProcesVariant Integer2 De waarde voor proces variant Ja
ProductRegels ProductRegels De waarde voor product regels Ja
TotaalBedragExBtw Bedrag De waarde voor totaal bedrag ex btw Ja
TotaalBedragIncBtw Bedrag De waarde voor totaal bedrag inc btw Ja
TotaalBTWBedrag Bedrag De waarde voor totaal b t w bedrag Ja
VerkoopDocumentNummer Integer10 Bevat het offertenummer. Ja
VervalDatum dateTime Datum waarop de offerte vervalt. Ja
WeigeringsDatum dateTime Datum waarop de offerte is geweigerd door de aanvrager. Nee
WijzigingsDatum dateTime Datum waarop de offerte is gewijzigd. Nee

VerkoopDocumenten

De complexe entiteit VerkoopDocumenten bevat de volgende entiteit(en):

Naam Type Toelichting Verplicht
VerkoopDocumentArray VerkoopDocument De waarde voor verkoop document Ja
Overgenomen van "https://wiki.dsplatform.nl/index.php?title=Aanvraag_Service_-_Complexe_Types&oldid=3473"