#
Envelopes & batching
#
Introduction
This section includes information about various technical envelopes and batchers and the different ways they are relevant when integrating with Pagero Network.
#
Technical envelopes
#
SBDH
SBDH is an acronym for Standard Business Document Header.
SBDH contains information expressed in an XML format. The header provides information about the routing and processing of the Standard Business Document, whether the document is in an XML or EDI or other format. The SBDH is designed to be either an integral part of a Standard Business Document (e.g. either XML instance document or EDI interchange), or an object associated with the Standard Business Document itself.
It is a technical envelope, in many ways used much like a physical envelope in that you wrap it around what you want to send (the "payload") and then include some additional, useful information (e.g. address of the sender/receiver) in the actual header.
Information in the SBDH can be categorized into the following categories
- Document routing
- Document identification
- Document processing context
Document routing information is captured in the Sender
and Receiver
data structures of the SBDH. It is used to identify the message sender and message receiver using unique identifiers for the trading partners and optionally with additional contact information details.
Document identification information is captured in the DocumentIdentification
data structure of the SBDH. It is used to identify the actual business document payload content enclosed inside SBDH.
Document Processing Context is captured in the BusinessScope
data structure of SBDH. It is used to provide parameters for processing the business document in the context of a business choreography exchange.
#
SBDH in Pagero Online
We support SBDH in both inbound and outbound directions/capacities.
#
Example
<?xml version="1.0" encoding="UTF-8"?>
<StandardBusinessDocument xmlns="http://www.unece.org/cefact/namespaces/StandardBusinessDocumentHeader">
<StandardBusinessDocumentHeader>
<HeaderVersion>1.0</HeaderVersion>
<Sender>
<Identifier Authority="iso6523-actorid-upis">0007:5566778899</Identifier>
</Sender>
<Receiver>
<Identifier Authority="iso6523-actorid-upis">0088:7210000000001</Identifier>
</Receiver>
<DocumentIdentification>
<Standard>urn:oasis:names:specification:ubl:schema:xsd:Invoice-2</Standard>
<TypeVersion>2.1</TypeVersion>
<InstanceIdentifier>123e4567-e89b-12d3-a456-426614174000</InstanceIdentifier>
<Type>Invoice</Type>
<CreationDateAndTime>2021-09-20T09:33:05.93</CreationDateAndTime>
</DocumentIdentification>
<BusinessScope>
<Scope>
<Type>DOCUMENTID</Type>
<InstanceIdentifier>urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1</InstanceIdentifier>
<Identifier>busdox-docid-qns</Identifier>
</Scope>
<Scope>
<Type>PROCESSID</Type>
<InstanceIdentifier>urn:fdc:peppol.eu:2017:poacc:billing:01:1.0</InstanceIdentifier>
<Identifier>cenbii-procid-ubl</Identifier>
</Scope>
</BusinessScope>
</StandardBusinessDocumentHeader>
<Invoice
xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2"
xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
xmlns:ext="urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2">
<cbc:CustomizationID>urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0</cbc:CustomizationID>
<cbc:ProfileID>urn:fdc:peppol.eu:2017:poacc:billing:01:1.0</cbc:ProfileID>
<cbc:ID>123456789</cbc:ID>
<!-- Omitted for clarity -->
</Invoice>
</StandardBusinessDocument>
#
Specification
For more information, see the official SBDH v 1.3 specification.
#
SOAP
SOAP (formerly an acronym for Simple Object Access Protocol) is a lightweight protocol intended for exchanging structured information in a decentralized, distributed environment. It uses XML technologies to define an extensible messaging framework providing a message construct that can be exchanged over a variety of underlying protocols. The framework has been designed to be independent of any particular programming model and other implementation specific semantics.
It is an XML-based protocol consisting of three parts:
- an envelope, which defines the message structure and how to process it
- a set of encoding rules for expressing instances of application-defined datatypes
- a convention for representing procedure calls and responses
#
SOAP in Pagero Online
We support SOAP in both inbound and outbound directions/capacities.
#
Example
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:eb="http://www.oasis-open.org/committees/ebxml-msg/schema/msg-header-2_0.xsd" xmlns:xlink="http://www.w3.org/1999/xlink">
<SOAP-ENV:Header>
<eb:MessageHeader SOAP-ENV:mustUnderstand="1">
<eb:From>
<eb:PartyId>003711111111</eb:PartyId>
<eb:Role>Sender</eb:Role>
</eb:From>
<eb:From>
<eb:PartyId>003722222222</eb:PartyId>
<eb:Role>Intermediator</eb:Role>
</eb:From>
<eb:To>
<eb:PartyId>003733333333</eb:PartyId>
<eb:Role>Receiver</eb:Role>
</eb:To>
<eb:To>
<eb:PartyId>003744444444</eb:PartyId>
<eb:Role>Intermediator</eb:Role>
</eb:To>
<eb:CPAId/>
<eb:ConversationId>nnnn</eb:ConversationId>
<eb:Service>Routing</eb:Service>
<eb:Action>ProcessInvoice</eb:Action>
<eb:MessageData>
<eb:MessageId>123e4567-e89b-12d3-a456-426614174000</eb:MessageId>
<eb:Timestamp>2021-10-21T12:30:19+03:00</eb:Timestamp>
<eb:RefToMessageId/>
</eb:MessageData>
</eb:MessageHeader>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<eb:Manifest xmlns="http://www.oasis-open.org/committees/ebxml-msg/schema/msg-header-2_0.xsd" eb:id="Manifest" eb:version="2.0">
<eb:Reference xmlns="http://www.w3.org/1999/xlink" eb:id="Finvoice" xlink:href="20020209-133003">
<eb:schema xmlns="http://www.oasis-open.org/committees/ebxml-msg/schema/msg-header-2_0.xsd" eb:location="http://www.pankkiyhdistys.fi/verkkolasku/finvoice/finvoice.xsd" eb:version="2.0"/>
</eb:Reference>
</eb:Manifest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
<?xml version="1.0" encoding="ISO-8859-15"?>
<Finvoice xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="3.0" xsi:noNamespaceSchemaLocation="Finvoice3.0.xsd">
<!-- Main document, omitted for clarity -->
</Finvoice>
#
Specification
For more information, see the official SOAP 1.2 specification.
#
Batching
#
TAR
TAR is short for Tape ARchive and is a file format used to store multiple files in one single file.
It is a popular way of sending multiple files at once over the internet.
The TAR file format is common in Linux and Unix systems. TAR files are often compressed after being created, but those become TGZ files, using the .tgz
, .tar.gz
, or .gz
extension. Its MIME media type is application/gzip
.
A program or command that can compress/decomress archives is required to handle TAR files.
#
TAR in Pagero Online
We support TAR in both inbound and outbound directions/capacities.
#
ZIP
ZIP is an archive file format that supports lossless data compression. It is the most widely used archiving format on the internet.
A ZIP file may contain one or more files or directories that may have been compressed and is, as such, a popular way of sending files over the internet.
ZIP files generally use the file extensions .zip
or .ZIP and the MIME media type application/zip
.
A program or command that can compress/decomress archives is required to handle ZIP files.
#
ZIP in Pagero Online
We support ZIP in both inbound and outbound directions/capacities.