Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


version1.0
published
 

...

Detailed presentation of the service

Overview

...

Image Added

The following elements are used in the Simpl.ePRIOR interface. This is part of the required transmission items, on top of that the payload needs to contain a valid UBL document ( retrieve and submit document ). The Mercurius platform validates the UBL is correct based on the document type defined : this is a schematic and format validation against XSD and Schematron. The business content like PO, price, ... is not validated and must be checked by the consumer.

...

InputOutputException (*)
  • receiverID ( mandatory )
  • senderID
  • DocumentType
  • DocumentFormatIdentifier (new, only in TEST)
  • list of the unmarked documents ( 0..N ):
    • documentID
    • receiverID
    • senderID
    • DocumentType
    • DocumentFormatIdentifier (new, only in TEST)
  • No access allowed to inbox
(*) See SOAP Fault section for more details

Image RemovedImage Added

Code Block
languagexml
titleSubmitInboxRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:head=”http://fsb.belgium.be/header”  xmlns:v1="http://fsb.belgium.be/einvoicing/simpleprior/v1_00">
   <soapenv:Header>
      <head:fsbHeader>
         <head:messageId>9397cbe5-174f-479f-941d-2371129acb05</head:messageId>
      </head:fsbHeader>
   </soapenv:Header>
   <soapenv:Body>
      <v1:submitInboxRequest>
         <v1:receiverId>?</v1:receiverId>
         <v1:senderId>?</v1:senderId>
      </v1:submitInboxRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

Image RemovedImage Added

Code Block
languagexml
titleSubmitInboxResponse
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://fsb.belgium.be/einvoicing/simpleprior/v1_00>
   <soapenv:Header>
      <wsse:Security soap:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsu:Timestamp wsu:Id="Timestamp-HvumButHp993jGDym7t89Q22" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsu:Created>2018-10-03T10:07:55Z</wsu:Created>
            <wsu:Expires>2018-10-03T10:12:55Z</wsu:Expires>
         </wsu:Timestamp>
	<!—More elements on security and signature:-->
      </wsse:Security>    </soapenv:Header>
   <soapenv:Body>
      <v1:submitInboxRequestResponse>
         <v1:documentGroup>
            <!--Zero or more repetitions:-->
            <v1:documentReference>
               <v1:documentId>?</v1:documentId>
               <v1:documentTypeCode>?</v1:documentTypeCode>
               <v1:receiverId>?</v1:receiverId>
               <v1:senderId>?</v1:senderId>
            </v1:documentReference>
         </v1:documentGroup>
      </v1:submitInboxRequestResponse>
   </soapenv:Body>
</soapenv:Envelope>

...

InputOutputException(*)
  • receiverID
  • senderID
  • documentType
  • documentID
  • reception date
  • UBL Document
  • Document doesn't exist or is not accessible (unauthorized)
(*) See SOAP Fault section for more details

Request 


Image RemovedImage Added

Code Block
languagexml
titleSubmitInboxRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:head=”http://fsb.belgium.be/header”  xmlns:v1="http://fsb.belgium.be/einvoicing/simpleprior/v1_00">
   <soapenv:Header>
      <head:fsbHeader>
         <head:messageId>692da97e-e4a0-4ed0-b0bd-6e3f01e1e601</head:messageId>
      </head:fsbHeader>
   </soapenv:Header>
   <soapenv:Body>
      <v1:retrieveDocument>
         <v1:receiverId>?</v1:receiverId>
         <v1:senderId>?</v1:senderId>
         <v1:documentType>?</v1:documentType>
         <v1:documentId>?</v1:documentId>
      </v1:retrieveDocument>
   </soapenv:Body>
</soapenv:Envelope>

Response

Image RemovedImage Added

Code Block
languagexml
titleRetrieveDocumentResponse
<soapenv:Envelope xmlns:soapenv=http://schemas.xmlsoap.org/soap/envelope/  xmlns:v1="http://fsb.belgium.be/einvoicing/simpleprior/v1_00>
   <soapenv:Header>
      <wsse:Security soap:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsu:Timestamp wsu:Id="Timestamp-HvumButHp993jGDym7t89Q22" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsu:Created>2018-10-03T10:07:55Z</wsu:Created>
            <wsu:Expires>2018-10-03T10:12:55Z</wsu:Expires>
         </wsu:Timestamp>
	<!—More elements on security and signature:-->
      </wsse:Security>    </soapenv:Header>
   <soapenv:Body>
      <v1:retrieveDocumentResponse>
         <v1:receivedDate>yyyy-MM-dd</v1:receivedDate>
         <v1:document>
            <!--Valid UBL document returned-->
         </v1:document>
      </v1:retrieveDocumentResponse>
   </soapenv:Body>
</soapenv:Envelope>

...

InputOutputException(*)
  • receiverdId
  • senderId
  • documentType
  • documentId
  • ackIndicator = True
  • Document doesn't exist or is not accessible (unauthorized)
(*) See SOAP Fault section for more details

Request

Image RemovedImage Added

Code Block
languagexml
titleMarkDocumentRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:head=”http://fsb.belgium.be/header”  xmlns:v1="http://fsb.belgium.be/einvoicing/simpleprior/v1_00">
   <soapenv:Header>
      <head:fsbHeader>
         <head:messageId>692da97e-e4a0-4ed0-b0bd-6e3f01e1e601</head:messageId>
      </head:fsbHeader>
   </soapenv:Header>
   <soapenv:Body>
      <v1:markDocument>
         <v1:receiverId>?</v1:receiverId>
         <v1:senderId>?</v1:senderId>
         <v1:documentType>?</v1:documentType>
         <v1:documentId>?</v1:documentId>
      </v1:markDocument>
   </soapenv:Body>
</soapenv:Envelope>

Response

Image RemovedImage Added

Code Block
languagexml
titleMarkDocumentResponse
<soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/” 
xmlns:v1="http://fsb.belgium.be/einvoicing/simpleprior/v1_00">
         <soapenv:Header>
            <wsse:Security soap:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
               <wsu:Timestamp wsu:Id="Timestamp-HvumButHp993jGDym7t89Q22" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                  <wsu:Created>2018-10-03T10:07:55Z</wsu:Created>
                  <wsu:Expires>2018-10-03T10:12:55Z</wsu:Expires>
               </wsu:Timestamp>
	      <!—More elements on security and signature:-->
            </wsse:Security>          </soapenv:Header>
   <soapenv:Body>
      <v1:markDocumentResponse>
		<!—When successful ackIndicator is true-->
         <v1:ackIndicator>true</v1:ackIndicator>
		<!—When an exception occurred ackIndicator is false-->
		<v1:ackIndicator>false</v1:ackIndicator>
		-->
      </v1:markDocumentResponse>
   </soapenv:Body>
</soapenv:Envelope>

...

InputOutputException

valid Document

ackIndicator = True

  • unsupported document format
  • document format violation (list of errors found)
(*) See SOAP Fault section for more details

Request

Image RemovedImage Added

Code Block
languagexml
titleSubmitDocumentRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:head=”http://fsb.belgium.be/header”   xmlns:v1="http://fsb.belgium.be/einvoicing/simpleprior/v1_00">
   <soapenv:Header>
      <head:fsbHeader>
         <head:messageId>692da97e-e4a0-4ed0-b0bd-6e3f01e1e601</head:messageId>
      </head:fsbHeader>
   </soapenv:Header>
   <soapenv:Body>
      <v1:submitDocument>
         <v1:document>
            <!--You may enter ANY valid UBL document at this point-->
         </v1:document>
      </v1:submitDocument>
   </soapenv:Body>
</soapenv:Envelope>

Response

Image RemovedImage Added

Code Block
languagexml
titleSubmitDocumentResponse
<soapenv:Envelope xmlns:soapenv=http://schemas.xmlsoap.org/soap/envelope/
xmlns:v1="http://fsb.belgium.be/einvoicing/simpleprior/v1_00">
         <soapenv:Header>
            <wsse:Security soap:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
               <wsu:Timestamp wsu:Id="Timestamp-HvumButHp993jGDym7t89Q22" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                  <wsu:Created>2018-10-03T10:07:55Z</wsu:Created>
                  <wsu:Expires>2018-10-03T10:12:55Z</wsu:Expires>
               </wsu:Timestamp>
	      <!—More elements on security and signature:-->
            </wsse:Security>          </soapenv:Header>
   <soapenv:Body>
      <v1:submitDocumentResponse>
         <!—When successful ackIndicator is true-->
         <v1:ackIndicator>true</v1:ackIndicator>
		<!—When an exception occurred ackIndicator is false-->
		<v1:ackIndicator>false</v1:ackIndicator>
		-->
      </v1:submitDocumentResponse>
   </soapenv:Body>
</soapenv:Envelope>

...

The semantic layer are defined by standardization teams . that new PEPPOL BIS 3 Invoice format is an implementation of the european stadard for electonic invoice, that provides the semantic specification and the syntaxt binding. PEPPOL teams only add implementation-level specifications .

Image RemovedImage Added

Defined document formats

the following 2 table summarize the key information about the supported document formats.

Format specifications

Document format
UBL DocumentTypeCodesyntax (XSD)semanticstatus

BIS V2 Invoice

380

UBL-Invoice-2.1.xsd

PEPPOL BIS 5A Billing

  • in phase out.
  • bidirectional support (in-,outbound).

BIS V2 Credit Note

81

UBL-CreditNote-2.1.xsd

PEPPOL BIS 5A Billing

  • in phase out.
  • bidirectional support (in-,outbound).
BIS V3 invoice/CN

cf   http://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-inv/

UBL-Invoice-2.1.xsd


http://docs.peppol.eu/poacc/billing/3.0/



EN-compliant

BIS V3 Credit Note

UBL-CreditNote-2.1.xsd

BIS V2 Message Level Response (MLR)

301

UBL-ApplicationResponse-2.1.xsd

PEPPOL BIS 36A Message Level Response

  • in phase out.
  • [TO CHECK] bidirectional support (in-,outbound).
BISV2 Order////UBL-Order-2.1.xsdPEPPOL BIS 28A Orderingoutbound support

Order Response

231

UBL-OrderResponse-2.1.xsd

PEPPOL BIS 28A Ordering

Not supported, no intake programmed yet

Invoice Response

23

UBL-ApplicationResponse-2.1.xsd

PEPPOL BIS 63A Invoice Response

intake programmed, but not yet started

PEPPOL Format identifiers

...

MercuriusMail-room from the Belgian Public sector, for e-Procurement related structured electronic documents
PEPPOLPan-European Public Procurement Online, PEPPOL enables businesses across Europe and beyond to communicate electronically with public buyers in various stages of the procurement process
OpenPEPPOL

OpenPEPPOL is a non-profit international association under Belgian law (Association Internationale Sans But Lucratif – AISBL) and consists of both public sector and private members. The association has assumed full responsibility for the development and maintenance of the PEPPOL specifications, building blocks and its services and implementation across Europe.

IntegratorsIntegrator allow service consumers to access the Simpl.ePRIOR service exposed by the Mercurius platform. The service on the Mercurius platform is only accessible to integrators : Federal ( FSB ) or regional ( Magda, ... )
PortalAlso known as the Mercurius portal, it allows customers and suppliers to monitor (track and trace) the documents received and sent. It provides business information (sender, receiver, business status, date, ...) and access to technical information (messages exchanged, technical status, ...)
FASFederal Authentication Service authenticates authorises users to access the platform
Supplier

A supplier is an enterprise that contributes goods or services. Generally, a supply chain vendor manufactures inventory/stock items and sells them to the next link in the chain. Today, these terms refer to a supplier of any good or service.

See https://en.wikipedia.org/wiki/Supplier

The Peppol definition is the following :

The supplier is the legal person or organization who provides a product and/or service.
Examples of supplier roles: seller, consignor, creditor, economic operator.

Customer

In sales, commerce and economics, a customer (sometimes known as a client, buyer, or purchaser) is the recipient of a good, service, product or an idea - obtained from a seller, vendor, or supplier via a financial transaction or exchange for money or some other valuable consideration.

See https://en.wikipedia.org/wiki/Customer

The Peppol definition is the following :

The customer is the legal person or organization who is in demand of a product and/or service.
Examples of customer roles: buyer, consignee, debtor, contracting authority.



References

Sample Code

This example is provided without any guarantee or support. It's only to help you and show you how to generate code based on the WSDL definition.

...