Gebruikershandleiding e-invoicing/customerservice 01.00

Transcriptie

1 Coördinatiecel Vlaams e-government MAGDA-VSB documentatie Gebruikershandleiding e-invoicing/customerservice Versie: 1.0 Verspreiding: vertrouwelijk Web:

2 Inhoudstabel 1 INLEIDING DOEL OPBOUW DOCUMENT ALGEMEEN OMGEVINGSINFORMATIE FUNCTIONALITEITEN LEVERANCIER VAN DE GEGEVENS GEBRUIKSVOORWAARDEN INTERFACES HEADER Vraag Antwoord VRAAG SUBMITINBOXREQUEST Algemeen XSD Detail Voorbeeld ANTWOORD - SUBMITINBOXREQUEST Algemeen XSD Detail Voorbeeld VRAAG - RETRIEVEREQUEST Algemeen XSD Detail Voorbeeld ANTWOORD - RETRIEVEREQUEST Algemeen XSD Detail Voorbeeld VRAAG - MARKREQUEST Algemeen XSD Detail Voorbeeld ANTWOORD - MARKREQUEST Algemeen XSD Detail Voorbeeld VRAAG SUBMITAPPLICATIONRESPONSE Pagina 2 van 29

3 3.8.1 Algemeen XSD Detail Voorbeeld ANTWOORD - SUBMITAPPLICATIONRESPONSE Algemeen XSD Detail Voorbeeld CODETABELLEN WERKING OPVRAGING LOGGING BESCHIKBAARHEID CONTACTGEGEVENS DOCUMENT EIGENSCHAPPEN Pagina 3 van 29

4 1 Inleiding 1.1 Doel Dit document beschrijft het gebruik en de werking van de webservice e-invoicing/customerserivce 1.0 zoals deze door CORVE op het MAGDA-VSB platform aangeboden wordt. De webservice is in staat: Een inbox op te vragen Invoices en attachments uit de inbox op te vragen Een invoice of attachment te markeren als ontvangen Een applicatie response te sturen 1.2 Opbouw document Het algemeen overzicht van de functionaliteiten en het gebruik van deze webservice is opgenomen in hoofdstuk 2. Hoofdstuk 3 behandelt de interface van de webservice, zowel de Vraag als Antwoord inclusief voorbeelden en bevindingen. Hoofstuk 4 gaat over de codetabellen. Hoofdstuk 5 geeft meer informatie over de werking. Hierbij worden onder meer enkele aandachtspunten, de configuratieparameters, de beschikbaarheid en de gekende problemen aangehaald. Hoofdstuk 6 omvat alle informatie omtrent de beveiliging van de service. De contactgegevens zijn opgenomen in hoofdstuk 7. Pagina 4 van 29

5 2 Algemeen 2.1 Omgevingsinformatie Naam: E-Invoicing/CustomerService Versie: Classificatie: Vertrouwelijk Endpoints: zie Functionaliteiten De webservice e-invoicing/customerservice 1.0 laat de afnemer van het MAGDA-VSB platform toe, zijn e-invoices op te halen en te behandelen. De dienst bestaat uit 4 operaties: submitinboxrequest: Vraagt de inhoud van een inbox op. Een lijst van alle invoices en attachments met metadata wordt terug gestuurd. retrieverequest: Vraagt een invoice of attachment op. Er wordt een invoice of een attachment terug gestuurd markrequest: Markeert een invoice of attachment als ontvangen. Er wordt een ok of nok boodschap teruggestuurd. De desbetreffende invoice of attachment is niet meer zichtbaar in de inbox. submitapplicationresponse: Stuur een status update op een invoice of attachment. Er wordt een ok of nok boodschap teruggestuurd. 2.3 Leverancier van de gegevens De authentieke bron van de gegevens is de leverancier van het document. De documenten worden door de VSB opgehaald bij de FSB (Federale Service Bus). De VSB voert, buiten de autorisatie en validatie, geen enkele actie uit op de gegevens. Pagina 5 van 29

6 2.4 Gebruiksvoorwaarden Afnemers moeten aan volgende voorwaarden voldoen om deze webservice te kunnen gebruiken: Succesvol uitvoeren van het e-prior conformance test protocol Toelating tot het MAGDA-VSB platform Toelating tot de e-invoicing inbox Pagina 6 van 29

7 3 Interfaces Aangezien de grote mogelijkheden van de UBL standaard, zal hieronder enkel de data beschreven worden, die gebruikt wordt door de VSB. Meer informatie kan je halen uit <info pakket>/e-invoicing Customer Service/WSDL/e-Invoicing/FSB/customerServiceMessages.xsd. Alle operaties gebruiken dezelfde request- en response header. De headers zullen appart beschreven worden. Het inbox ID staat steeds gelijk aan het KBO nummer van de eigenaar van de inbox. 3.1 Header Per synchrone communicatie blijft de consumer steeds de consumer, de afnemer van de dienst van de VSB, en de provider blijft de provider, de leverancier van de achterliggende dienst Vraag Element Cardinaliteit Extra ApplicationID Verplicht URI van de afnemer, die gelijk moet zijn aan de CN op het certificaat. Hierop wordt gecontroleerd of er toegang is tot de desbtreffende web service, versie en inbox. MessageID Verplicht Uniek ID van het bericht van de afnemer. Dit wordt bijgehouden als referentie punt voor de tracing van berichten. Pagina 7 van 29

8 3.1.2 Antwoord Het is mogelijk voor de provider om ook zijn achterliggende dienst bekend te maken via een extra provider element. Element Cardinaliteit Extra Consumer/ApplicationID Verplicht URI van de afnemer. Consumer/MessageID Verplicht Uniek ID van het bericht van de afnemer. ServiceBus/ApplicationID Verplicht URI van de VSB. ServiceBus/MessageID Verplicht Uniek ID van het bericht van de VSB. Wordt bijgehouden als referentie punt voor tracing van messages. Provider/ApplicationID Verplicht URI van de leverancier. Provider/MessageID Verplicht Uniek ID van het bericht van de leverancier. Wordt bijgehouden als referentie punt voor tracing van messages. 3.2 Vraag submitinboxrequest Algemeen De vraag bestaat uit: De request header Het inbox ID van de inbox die opgevraagd wordt. Pagina 8 van 29

9 3.2.2 XSD Header: zie Body: + zie <info pakket>/e-invoicing Customer Service/WSDL/e-Invoicing/FSB/customerServiceMessages.xsd Detail Element Cardinaliteit Extra ReceiverParty PartyIdentification ID Verplicht Het ID van de inbox. Het inbox ID is gelijk aan het KBO nummer van de eigenaar van de inbox Voorbeeld <soapenv:envelope xmlns:soapenv=" xmlns:ns=" xmlns:v1=" xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2" xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2"> <soapenv:header> <ns:syncheader> <ns:consumer> <ns:applicationid>orafin</ns:applicationid> <ns:messageid>123</ns:messageid> </ns:consumer> </ns:syncheader> </soapenv:header> <soapenv:body> <v1:submitinboxrequestrequest> <urn:receiverparty> <urn:partyidentification> <urn1:id> </urn1:id> </urn:partyidentification> </urn:receiverparty> </v1:submitinboxrequestrequest> </soapenv:body> </soapenv:envelope> 3.3 Antwoord - submitinboxrequest Algemeen Het antwoord bestaat uit: De response header De inhoud van de gevraagd inbox Invoices of attachments die als ontvangen gemarkeerd zijn, zijn nog wel beschikbaar, maar niet meer zichtbaar in de inbox. Pagina 9 van 29

10 3.3.2 XSD Header: zie Body: zie <info pakket>/e-invoicing Customer Service/WSDL/e-Invoicing/FSB/customerServiceMessages.xsd Detail Niet van toepassing Voorbeeld <soapenv:envelope xmlns:soapenv=" <soapenv:header> <ns:syncresponseheader xmlns:ns=" <ns:consumer> <ns:applicationid>orafin</ns:applicationid> <ns:messageid>123</ns:messageid> </ns:consumer> <ns:servicebus> <ns:applicationid>vsb</ns:applicationid> <ns:messageid>37cfab0f-3fd9-45c6-b7fd-fffe3e9b2320</ns:messageid> </ns:servicebus> <ns:provider> <ns:applicationid>fsb</ns:applicationid> <ns:messageid>816ab2ce-aafe-4b8d-8421-a6e7e1ee7c23</ns:messageid> </ns:provider> </ns:syncresponseheader> </soapenv:header> <soapenv:body> <v1:submitinboxrequestresponse xmlns:v1=" <v1:documentgroup> <v1:document> <urn:status xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2"> <urn1:statusreasoncode xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2">1</urn1:statusreasoncode> </urn:status> <urn:documentreference xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2"> <urn1:id xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2">att_vsb_001</urn1:id> <urn1:issuedate xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2"> :00</urn1:issuedate> <urn1:documenttypecode xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2">916</urn1:documenttypecode> </urn:documentreference> <urn:senderparty xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2"> <urn:partyidentification> <urn1:id xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents- 2"> </urn1:ID> </urn:partyidentification> </urn:senderparty> </v1:document> <v1:parentdocument> <urn:status xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2"> <urn1:statusreasoncode xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2">1</urn1:statusreasoncode> </urn:status> <urn:documentreference Pagina 10 van 29

11 xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2"> <urn1:id xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2">inv_vsb_002</urn1:id> <urn1:issuedate xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2"> :00</urn1:issuedate> <urn1:documenttypecode xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2">380</urn1:documenttypecode> </urn:documentreference> <urn:senderparty xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2"> <urn:partyidentification> <urn1:id xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents- 2"> </urn1:ID> </urn:partyidentification> </urn:senderparty> <urn:receiverparty xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2"> <urn:partyidentification> <urn1:id xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents- 2"> </urn1:ID> </urn:partyidentification> </urn:receiverparty> </v1:parentdocument> </v1:documentgroup> <v1:documentgroup> <v1:document> <urn:status xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2"> <urn1:statusreasoncode xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2">1</urn1:statusreasoncode> </urn:status> <urn:documentreference xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2"> <urn1:id xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2">inv_vsb_002</urn1:id> <urn1:issuedate xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2"> :00</urn1:issuedate> <urn1:documenttypecode xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2" xmlns:ec="ec:schema:xsd:commonaggregatecomponents-2">380</urn1:documenttypecode> </urn:documentreference> <urn:senderparty xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2"> <urn:partyidentification> <urn1:id xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents- 2"> </urn1:ID> </urn:partyidentification> </urn:senderparty> </v1:document> </v1:documentgroup> </v1:submitinboxrequestresponse> </soapenv:body> </soapenv:envelope> Pagina 11 van 29

12 3.4 Vraag - retrieverequest Algemeen De vraag bestaat uit: De request header Het inbox ID waarin de invoice of attachtment zit. Het inbox ID van de leverancier van de invoice of attachment. Het ID van de invoice of attachment. De code van het type document dat opgevraagd wordt XSD Header: zie Body: + zie <info pakket>/e-invoicing Customer Service/WSDL/e-Invoicing/FSB/customerServiceMessages.xsd Detail Element Cardinaliteit Extra SenderParty PartyIdentification ID ReceiverParty PartyIdentification ID Verplicht Verplicht ID Verplicht Het ID van de invoice of attachment. Het ID van de inbox van de leverancier van de invoice of attachment. Dit ID vindt men terug bij het opvragen van de eigen inbox, bij de invoice of attachment. Het ID van de inbox waarin de invoice of attachtment zit. Het inbox ID is gelijk aan het KBO nummer van de eigenaar van de inbox. DocumentTypeCode Verplicht De code van het type document. Bijvoorbeeld 380 voor een invoice en 916 voor een attachment Voorbeeld <soapenv:envelope xmlns:soapenv=" xmlns:ns=" xmlns:v1=" xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecomponents-2" xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents-2"> <soapenv:header> <ns:syncheader> <ns:consumer> <ns:applicationid>orafin</ns:applicationid> <ns:messageid>123</ns:messageid> </ns:consumer> </ns:syncheader> Pagina 12 van 29

13 </soapenv:header> <soapenv:body> <v1:retrieverequestrequest> <urn:senderparty> <urn:partyidentification> <urn1:id> </urn1:id> </urn:partyidentification> </urn:senderparty> <urn:receiverparty> <urn:partyidentification> <urn1:id> </urn1:id> </urn:partyidentification> </urn:receiverparty> <urn1:id>inv_vsb_001</urn1:id> <urn1:documenttypecode>380</urn1:documenttypecode> </v1:retrieverequestrequest> </soapenv:body> </soapenv:envelope> 3.5 Antwoord - retrieverequest Algemeen Het antwoord bestaat uit: De response header De inhoud van de gevraagde invoice of attachment XSD Header: zie Body: zie <info pakket>/e-invoicing Customer Service/WSDL/e-Invoicing/FSB/customerServiceMessages.xsd Detail Niet van toepassing Voorbeeld <soapenv:envelope xmlns:soapenv=" <soapenv:header> <ns:syncresponseheader xmlns:ns=" <ns:consumer> <ns:applicationid>orafin</ns:applicationid> <ns:messageid>123</ns:messageid> </ns:consumer> <ns:servicebus> <ns:applicationid>vsb</ns:applicationid> <ns:messageid>319c9ebd-b b4aa-d3a6914e255e</ns:messageid> </ns:servicebus> <ns:provider> <ns:applicationid>fsb</ns:applicationid> <ns:messageid>e8f5e26e-43f8-4dc f0902ee1669e</ns:messageid> </ns:provider> </ns:syncresponseheader> </soapenv:header> <soapenv:body> <v1:retrieverequestresponse xmlns:v1=" <urn:ublextensions Pagina 13 van 29

14 xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonextensioncomponents-2"> <ext:ublextension xmlns:ec="ec:services:wsdl:retrieverequest-2" > <ext:extensioncontent> <cbc:receiveddate > </cbc:ReceivedDate> </ext:extensioncontent> </ext:ublextension> <ext:ublextension xmlns:ec="ec:services:wsdl:retrieverequest-2" > <ext:extensioncontent> <cac:partylegalentity > <cbc:companyid xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponents- 2"> </cbc:CompanyID> </cac:partylegalentity> </ext:extensioncontent> </ext:ublextension> </urn:ublextensions> <urn:invoice xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> <urn1:ublextensions xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> <urn1:ublextension> <urn2:id>zfbdt</urn2:id> <urn1:extensioncontent> <ec:entrydate> </ec:entrydate> </urn1:extensioncontent> </urn1:ublextension> <urn1:ublextension> <urn2:id>dispatch</urn2:id> <urn1:extensioncontent> <ec:dispatch>lvl</ec:dispatch> </urn1:extensioncontent> </urn1:ublextension> </urn1:ublextensions> <urn2:ublversionid xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2">2.0</urn2:ublversionid> <urn2:customizationid xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice- Pagina 14 van 29

15 2">urn: <urn2:profileid xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice- 2">urn: <urn2:id xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2">inv_vsb_001</urn2:id> <urn2:issuedate xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> </urn2:issuedate> <urn2:documentcurrencycode xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2">eur</urn2:documentcurrencycode> <urn3:accountingsupplierparty xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> <urn3:party> <urn3:partyidentification> <urn2:id schemeid="be:vat"> </urn2:id> </urn3:partyidentification> <urn3:partyname> <urn2:name>electrabel-test</urn2:name> </urn3:partyname> Pagina 15 van 29

16 <urn3:postaladdress> <urn2:streetname>rue du Fond des Fourches 20</urn2:StreetName> <urn2:cityname>vottem</urn2:cityname> <urn2:postalzone>4041</urn2:postalzone> <urn3:country> <urn2:identificationcode>be</urn2:identificationcode> </urn3:country> </urn3:postaladdress> <urn3:contact> <urn2:telephone>04/ </urn2:telephone> <urn2:telefax>04/ </urn2:telefax> </urn3:contact> </urn3:party> </urn3:accountingsupplierparty> <urn3:accountingcustomerparty xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> <urn3:party> <urn3:partyidentification> <urn2:id schemeid="be:vat"> </urn2:id> </urn3:partyidentification> <urn3:partyname> <urn2:name>ministerie van de Vlaamse Gemeenschap - CORVE</urn2:Name> </urn3:partyname> <urn3:postaladdress> <urn2:streetname>boudewijnlaan 30 bus 35</urn2:StreetName> <urn2:cityname>brussel</urn2:cityname> <urn2:postalzone>1000</urn2:postalzone> <urn3:country> <urn2:identificationcode>be</urn2:identificationcode> </urn3:country> </urn3:postaladdress> </urn3:party> </urn3:accountingcustomerparty> <urn3:delivery xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> <urn3:deliverylocation> <urn3:address> <urn2:streetname>fritiof Nilsson Piratenstraat</urn2:StreetName> <urn2:cityname>desteldonk</urn2:cityname> <urn2:postalzone>9042</urn2:postalzone> <urn3:country> <urn2:identificationcode>be</urn2:identificationcode> </urn3:country> </urn3:address> </urn3:deliverylocation> </urn3:delivery> <urn3:paymentmeans Pagina 16 van 29

17 xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> <urn2:paymentmeanscode>42</urn2:paymentmeanscode> <urn2:paymentchannelcode>iban</urn2:paymentchannelcode> <urn2:instructionnote> </urn2:instructionnote> <urn3:payeefinancialaccount> <urn2:id>be </urn2:id> <urn3:financialinstitutionbranch> <urn3:financialinstitution> <urn2:id>bbrubebb400</urn2:id> <urn2:name>ing</urn2:name> </urn3:financialinstitution> </urn3:financialinstitutionbranch> </urn3:payeefinancialaccount> </urn3:paymentmeans> <urn3:paymentterms xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> <urn2:note>echeance 13/04/2013</urn2:Note> </urn3:paymentterms> <urn3:taxtotal xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> <urn2:taxamount currencyid="eur">6.35</urn2:taxamount> <urn3:taxsubtotal> <urn2:taxableamount currencyid="eur">30.23</urn2:taxableamount> <urn2:taxamount currencyid="eur">6.35</urn2:taxamount> <urn3:taxcategory> <urn2:id>s</urn2:id> <urn2:percent>21</urn2:percent> <urn3:taxscheme> <urn2:id>vat</urn2:id> </urn3:taxscheme> </urn3:taxcategory> </urn3:taxsubtotal> </urn3:taxtotal> <urn3:legalmonetarytotal xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> Pagina 17 van 29

18 <urn2:lineextensionamount currencyid="eur">30.23</urn2:lineextensionamount> <urn2:taxexclusiveamount currencyid="eur">30.23</urn2:taxexclusiveamount> <urn2:taxinclusiveamount currencyid="eur">36.58</urn2:taxinclusiveamount> <urn2:payableamount currencyid="eur">36.58</urn2:payableamount> </urn3:legalmonetarytotal> <urn3:invoiceline xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> <urn2:id>1</urn2:id> <urn2:invoicedquantity>5</urn2:invoicedquantity> <urn2:lineextensionamount currencyid="eur">12.9</urn2:lineextensionamount> <urn3:taxtotal> <urn2:taxamount currencyid="eur">2.71</urn2:taxamount> <urn3:taxsubtotal> <urn2:taxableamount currencyid="eur">12.9</urn2:taxableamount> <urn2:taxamount currencyid="eur">2.71</urn2:taxamount> <urn3:taxcategory> <urn2:id>s</urn2:id> <urn2:percent>21</urn2:percent> <urn3:taxscheme> <urn2:id>vat</urn2:id> <urn2:name>value Added Tax</urn2:Name> </urn3:taxscheme> </urn3:taxcategory> </urn3:taxsubtotal> </urn3:taxtotal> <urn3:item> <urn2:description>lyreco plakb houder kantoor 19mmx33m</urn2:Description> <urn2:name> </urn2:name> <urn3:classifiedtaxcategory> <urn2:id>s</urn2:id> <urn2:percent>21</urn2:percent> <urn3:taxscheme> <urn2:id>vat</urn2:id> </urn3:taxscheme> </urn3:classifiedtaxcategory> </urn3:item> <urn3:price> <urn2:priceamount currencyid="eur">2.58</urn2:priceamount> </urn3:price> </urn3:invoiceline> <urn3:invoiceline xmlns:ec="urn:oasis:names:specification:ubl:schema:xsd:invoice-2"> <urn2:id>2</urn2:id> <urn2:invoicedquantity>1</urn2:invoicedquantity> <urn2:lineextensionamount currencyid="eur">17.33</urn2:lineextensionamount> <urn3:taxtotal> <urn2:taxamount currencyid="eur">3.64</urn2:taxamount> <urn3:taxsubtotal> <urn2:taxableamount currencyid="eur">17.33</urn2:taxableamount> <urn2:taxamount currencyid="eur">3.64</urn2:taxamount> <urn3:taxcategory> <urn2:id>s</urn2:id> Pagina 18 van 29

19 <urn2:percent>21</urn2:percent> <urn3:taxscheme> <urn2:id>vat</urn2:id> <urn2:name>value Added Tax</urn2:Name> </urn3:taxscheme> </urn3:taxcategory> </urn3:taxsubtotal> </urn3:taxtotal> <urn3:item> <urn2:description>durable klembord 22.8x34CM ALU</urn2:Description> <urn2:name> </urn2:name> <urn3:classifiedtaxcategory> <urn2:id>s</urn2:id> <urn2:percent>21</urn2:percent> <urn3:taxscheme> <urn2:id>vat</urn2:id> </urn3:taxscheme> </urn3:classifiedtaxcategory> </urn3:item> <urn3:price> <urn2:priceamount currencyid="eur">17.33</urn2:priceamount> </urn3:price> </urn3:invoiceline> </urn:invoice> </v1:retrieverequestresponse> </soapenv:body> </soapenv:envelope> 3.6 Vraag - markrequest Algemeen De vraag bestaat uit: De request header Het inbox ID waarin de invoice of attachtment zit. Het inbox ID van de leverancier van de invoice of attachment. Het ID van de invoice of attachment. De code van het type document dat opgevraagd wordt XSD Header: zie Body: zie <info pakket>/e-invoicing Customer Service/WSDL/e-Invoicing/FSB/customerServiceMessages.xsd Detail Element Cardinaliteit Extra SenderParty PartyIdentification ID ReceiverParty PartyIdentification ID Verplicht Verplicht ID Verplicht Het ID van de invoice of attachment. Het ID van de inbox van de leverancier van de invoice of attachment. Dit ID vindt men terug bij het opvragen van de eigen inbox, bij de invoice of attachment. Het ID van de inbox waarin de invoice of attachtment zit. Het inbox ID is gelijk aan het KBO nummer van de eigenaar van de inbox. DocumentTypeCode Verplicht De code van het type document. Bijvoorbeeld 380 voor een invoice en 916 voor een attachment. Pagina 19 van 29

20 3.6.4 Voorbeeld <soapenv:envelope xmlns:soapenv=" xmlns:ns=" xmlns:v1=" xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:commonaggregatecompon ents-2" xmlns:urn1="urn:oasis:names:specification:ubl:schema:xsd:commonbasiccomponent s-2"> <soapenv:header> <ns:syncheader> <ns:consumer> <ns:applicationid>orafin</ns:applicationid> <ns:messageid>123</ns:messageid> </ns:consumer> </ns:syncheader> </soapenv:header> <soapenv:body> <v1:markrequestrequest> <urn:senderparty> <urn:partyidentification> <urn1:id> </urn1:id> </urn:partyidentification> </urn:senderparty> <urn:receiverparty> <urn:partyidentification> <urn1:id> </urn1:id> </urn:partyidentification> </urn:receiverparty> <urn1:id>inv_vsb_001</urn1:id> <urn1:documenttypecode>380</urn1:documenttypecode> </v1:markrequestrequest> </soapenv:body> </soapenv:envelope> 3.7 Antwoord - markrequest Algemeen Het antwoord bestaat uit: De response header Een acknowledgement XSD Header: zie Body: + zie <info pakket>/e-invoicing Customer Service/WSDL/e-Invoicing/FSB/customerServiceMessages.xsd Pagina 20 van 29

21 3.7.3 Detail Element Cardinaliteit Extra acknowledgement Verplicht OK of NOK Voorbeeld <soapenv:envelope xmlns:soapenv=" <soapenv:header> <ns:syncresponseheader xmlns:ns=" <ns:consumer> <ns:applicationid>orafin</ns:applicationid> <ns:messageid>123</ns:messageid> </ns:consumer> <ns:servicebus> <ns:applicationid>vsb</ns:applicationid> <ns:messageid>2608e910-0b12-4a3e-9ce3-1a1a8d74bdb1</ns:messageid> </ns:servicebus> <ns:provider> <ns:applicationid>fsb</ns:applicationid> <ns:messageid>93564c15-ab65-475d-8691-f0ace3ad03a0</ns:messageid> </ns:provider> </ns:syncresponseheader> </soapenv:header> <soapenv:body> <v1:markrequestresponse xmlns:v1=" <v1:acknowledgement>ok</v1:acknowledgement> </v1:markrequestresponse> </soapenv:body> </soapenv:envelope> 3.8 Vraag submitapplicationresponse Algemeen De vraag bestaat uit: De request header Het ID van de applicatie response De datum van het aanmaken van de applicatie response Het inbox ID van de verzender van de applicatie response Het inbox ID van de leverancier van het document Het ID van het document De response code die aan het document wordt gegeven Het ID van het document De code van het type documen XSD Header: zie Body: zie <info pakket>/e-invoicing Customer Service/WSDL/e-Invoicing/FSB/customerServiceMessages.xsd Pagina 21 van 29

22 3.8.3 Detail Opgelet: In deze operatie moet men anders kijken naar de SenderParty en ReceiverParty. In de vorige operaties is de Sender, de afzender van de invoice of attachment en de Receiver de ontvanger of opvrager. In deze operatie is de Sender de verzender van de applicatie response en de Receiver de ontvanger van die response. Element Cardinaliteit Extra ID Verplicht Een ID dat aan de applicatie response moet gegevens worden. IssueDate Verplicht De datum van het aanmaken van de applicatie response. SenderParty PartyIdentification ID ReceiverParty PartyIdentification ID Verplicht Verplicht Het ID van de inbox van de verzender van de applciatie. Het inbox ID is gelijk aan het KBO nummer van de eigenaar van de inbox. Het ID van de inbox van de leverancier van de invoice of attachment, waarop de applicatie response wordt gestuurd. Dit ID vindt men terug bij het opvragen van de eigen inbox, bij de invoice of attachment. ReferenceID Verplicht Identificatie voor de sectie, lijn, document,... waarop de applicatie response geldt. ResponseCode Verplicht De code voor het beschrijven van de response. DocumentReference ID Verplicht Het ID van de invoice of attachment. DocumentTypeCode Verplicht De code van het type document. Bijvoorbeeld 380 voor een invoice en 916 voor een attachment Voorbeeld <soapenv:envelope xmlns:soapenv=" xmlns:ns=" xmlns:v1=" xmlns:urn="urn:oasis:names:specification:ubl:schema:xsd:applicationresponse-2" > <soapenv:header> <ns:syncheader> <ns:consumer> <ns:applicationid>orafin</ns:applicationid> <ns:messageid>123</ns:messageid> </ns:consumer> </ns:syncheader> </soapenv:header> <soapenv:body> <v1:submitapplicationresponserequest> <urn:applicationresponse> <urn2:id>852</urn2:id> <urn2:issuedate> </urn2:issuedate> <urn3:senderparty> <urn3:partyidentification> <urn2:id> </urn2:id> </urn3:partyidentification> </urn3:senderparty> <urn3:receiverparty> <urn3:partyidentification> <urn2:id> </urn2:id> </urn3:partyidentification> </urn3:receiverparty> <urn3:documentresponse> <urn3:response> <urn2:referenceid>inv_vsb_001</urn2:referenceid> <urn2:responsecode>380:1</urn2:responsecode> </urn3:response> <urn3:documentreference> <urn2:id>inv_vsb_001</urn2:id> <urn2:documenttypecode>380</urn2:documenttypecode> </urn3:documentreference> </urn3:documentresponse> </urn:applicationresponse> </v1:submitapplicationresponserequest> Pagina 22 van 29

23 </soapenv:body> </soapenv:envelope> 3.9 Antwoord - submitapplicationresponse Algemeen Het antwoord bestaat uit: De response header Een acknowledgement XSD Header: zie Body: + zie <info pakket>/e-invoicing Customer Service/WSDL/e-Invoicing/FSB/customerServiceMessages.xsd Detail Element Cardinaliteit Extra acknowledgement Verplicht OK of NOK Voorbeeld <soapenv:envelope xmlns:soapenv=" <soapenv:header> <ns:syncresponseheader xmlns:ns=" <ns:consumer> <ns:applicationid>orafin</ns:applicationid> <ns:messageid>123</ns:messageid> </ns:consumer> <ns:servicebus> <ns:applicationid>vsb</ns:applicationid> <ns:messageid>59fc0579-7b86-43f a8367</ns:messageid> </ns:servicebus> <ns:provider> <ns:applicationid>fsb</ns:applicationid> <ns:messageid>72f0041c-f04b-441f-bab9-50a2360d33ac</ns:messageid> </ns:provider> </ns:syncresponseheader> </soapenv:header> <soapenv:body> <v1:submitapplicationresponseresponse xmlns:v1=" <v1:acknowledgement>ok</v1:acknowledgement> </v1:submitapplicationresponseresponse> </soapenv:body> </soapenv:envelope> Pagina 23 van 29

24 4 Codetabellen Voor alle code s verwijzen wij naar het document <info pakket>/ e-invoicing Functional Documentation/ EC_CodeList.xls. EC_CodeList.xls Pagina 24 van 29

25 5 Foutcodes Systeem Oorzaak Code Omschrijving Consumer Geen geldige XML/Soap Geen geldige XML / Soap message - Ongeldige XML Header validatiefout 1001 Header voldoet niet aan XML schema Body validatiefout 1002 Body voldoet niet aan XML schema Geen URI 1003 ApplicationID is leeg URI niet gekend 1004 ApplicationID is niet gekend URI geen toelating 1005 Er bestaat geen toelating voor de combinatie ApplicationID en PartyIdentification Operatie niet gekend 1007 Oproep van onbestaande operatie Geen message ID 1008 MessageID is leeg VSB Interne fout 9999 Interne fout Provider Geen geldige XML/Soap 2000 Provider stuurt geen geldige XML / Soap message Connection refused 2001 Connection timeout 2002 Fout (geen soap) 2003 Fout bij achterliggende dienst Provider fout Soapfault (geen FSB) 2004 Provider Soap fout FSB fout 2005 Connectie probleem naar FSB 2006 Achterliggende dienst kan niet bereikt worden HTTP 200 (geen XML) 2008 Provider-bericht is geen geldige XML / Soap message HTTP 200 XML, header ongeldig HTTP 200 XML, body ongeldig 2009 Provider header voldoet niet aan XML Schema 2010 Provider body voldoet niet aan XML Schema Geen message ID 2011 Provider MessageID is leeg Pagina 25 van 29

26 6 Werking 6.1 Opvraging Van zodra de vraag gesteld is wordt er een XSD-validatie uitgevoerd. Is de ontvangen vraag XML niet geldig tegenover het schema, dan stopt de verwerking en wordt een foutmelding aangemaakt, anders gaat de verwerking verder. Na de XSD-validatie vind de autorisatiecontrole plaats. 6.2 Logging De VSB logt de communicatie op 4 punten: Het inkomende bericht van de afnemer Het uigaande bericht naar de leverancier Het antwoord van de leverancier Het antwoord terug gestuurd naar de afnemer Deze data zal ongeveer 1 maand bijgehouden worden voor eventuele opvolging. De metadata wordt langer bijgehouden. 6.3 Beschikbaarheid De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. De beschikbaarheid van de gegevens is echter volledig afhankelijk van achterliggende diensten. Pagina 26 van 29

27 7 Beveiliging 7.1 Authenticatie via PEP Om te verbinding met de de VSB omgeving, moet er geconnecteerd worden met de Policy Enforcement Point (PEP, ook wel Datapower genoemd): Op transport-niveau wordt er gebruik gemaakt van HTTPS en two-way SSL. Op message-niveau wordt de Soap-body gesigned met het afnemer certificaat. 7.2 Autorisatie Als laatste stap controleert de VSB of de afnemer toegang heeft tot de service, versie en gebruikte inbox doormiddel van controle op het ApplicationID in de header en het inbox ID in de body van het Soap bericht. 7.3 Endpoints Omgeving Beveiliging Ontsloten via URL T&I Two-way SSL Internet PRD Two-way SSL Internet Pagina 27 van 29

28 8 Contactgegevens CORVE is elke werkdag bereikbaar van 9.00 tot uur. Postadres: Coördinatiecel Vlaams e-government Boudewijngebouw 4e verdieping toren B Boudewijnlaan 30 bus Brussel Tel: 02/ Fax: 02/ helpdesk.magda@vlaanderen.be Pagina 28 van 29

29 9 Document eigenschappen OPGESTELD DOOR: VERSIE DATUM WIE COMMENTAAR /03/2014 Wesley De Keirsmaeker Eerste versie /08/2014 Mathieu De Zutter Enkel nog ontsluiting via PEP GERELATEERDE DOCUMENTEN: VERSIE DATUM NAAM DOCUMENT OMSCHRIJVING GOEDGEKEURD DOOR: VERSIE DATUM WIE 1.0 VERSPREID ONDER RESTRICTIE: OPENBAAR VERTROUWELIJK GEHEIM = mag door iedereen gelezen en gebruikt worden, mag onbeperkt doorgegeven worden aan derden = mag enkel gelezen en gebruikt worden door personen voorafgaandelijk goedgekeurd door CORVE, mag enkel na voorafgaande goedkeuring door CORVE doorgegeven worden aan derden = mag enkel gelezen en gebruikt worden door CORVE medewerkers, mag in geen geval doorgegeven worden aan derden BESCHIKBAAR ONDER LICENTIE: Creative Commons: Naamsvermelding-Niet-commercieel-Gelijk delen 2.0 België Pagina 29 van 29