Defines the operations for uploading an invoice to erechnung.gv.at
Author: Philip Helger, Bundesrechenzentrum GmbH
Version: 2.0.1
Last Update: 2017-05-30
History:
2.0.1: Documentation update
2.0.0: Complete rewrite
1.2.0: All changes compared to 1.1.0 are marked with [CHANGE120]
1.1.0: All changes compared to 1.0.0 are marked with [CHANGE110]
Global changes:
using elementFormDefault=qualified
1.0.0: Initial version
Defines the possible hash algorithm types
The name of this property.
Must be unique within all properties.
This contains the main invoice XML to be delivered.
As erechnung.gv.at supports multiple formats, and we can't tell whether it
will always be XML, the content must be base64Binary encoded.
It is important that the XML document declaration
<?xml version="..." encoding="..."?>
is contained in the binary encoded data!
Also the content MUST NOT contain a BOM!
The encoding of the Base64 String. Should be identical to the content encoding.
Default is UTF-8.
If an unknown encoding is provided, the invoice delivery is rejected.
An attachment that is directly delivered with the invoice.
The filename of this attachment.
It should not contain any path element!
It must have a supported file extension (like '.pdf').
The original encoding of the document before it was Base64
encoded.
This is only relevant for text attachments (like XML).
If an unknown encoding is provided, the invoice delivery is rejected.
If a text attachment is provided (by the determined content type) and
no encoding is present, the invoice delivery is rejected.
!!!This is NOT supported!!!
An attachment that is available externally.
The URI/URL where the attachment resides.
This URL must be publicly accessible.
No username or password must be required to access it.
Only http and https URLs are allowed.
It must have a supported file extension (like '.pdf').
The filename part of the URL is used as the attachment
name so please provide usable filenames.
As there are many ways how the download of an external document
can fail, this flags specifies whether the download of the
document is mandatory or not.
If this flag is set to 'true' and the content could not be
retrieved, than the invoice delivery will fail.
The original encoding of the document.
This is only relevant for text attachments (like XML).
If an unknown encoding is provided, the invoice delivery is rejected.
If a text attachment is provided (by the determined content type) and
no encoding is present, the invoice delivery is rejected.
The size of the document in bytes.
This value is only used to verify that the retrieval of the content
succeeded.
If this attribute is present, and the results differ, the
invoice is rejected.
The algorithm used to calculate the hash value.
Must be present if a hash value is set.
This value is only used to verify that the retrieval of the content
succeeded.
The hash value of the document byte stream calculated with
the algorithm specified in the 'hashalgo' attribute.
This value is only used to verify that the retrieval of the content
succeeded.
If this attribute is present, and the results differ, the
invoice is rejected.
The hash value must be present as a hex-encoded string.
Example: byte 1 encoded as '01', byte 255 encoded as 'ff' etc.
Optional properties to be passed back in the asynchronous
callback Webservice.
This may contain some unique keys or identification
properties for the invoice deliverer to match the callback
invocation to the original request.
These properties are passed in success and in error case.
Property names must be unique! If not later definitions
overwrite previous definitions without further notice.
URL of the Webservice endpoint that should be invoked
to send the invoice delivery status to.
If this value is not present, or if the Webservice at the URL
is not reachable, an email containing the invoice delivery
status is sent instead.
The WSDL service description that the this URL must implement
is located in the file 'erb-out-invoice-callback-*.wsdl'.
Represents the version of the callback service that should be
invoked.
The initial version of the callback has version '100'.
If a SOAPAction is required in the invoice delivery status
it must be specified here. If this attribute is missing or
empty, no SOAPAction will be specified in the call.
Email settings to be used for the response to this service call.
These settings are only used if no Callback is provided or if the
invocation of the Callback fails.
Overwrite the response email addresses specified in the invoice.
Only one email address may be provided per element!
If this field is present and does not contain a valid email
address (by means of a regular expression) the invoice delivery
is rejected!
Add response email addresses to the ones specified in the invoice.
Only one email address may be provided per element!
If AlternateResponseEmail elements are present, they have precedence
over the additional response email addresses.
If this field is present and does not contain a valid email
address (by means of a regular expression) the invoice delivery
is rejected!
Add response CC email addresses.
Only one email address may be provided per element!
Email addresses specified here are used independent if
AlternateResponseEmail or AdditionalResponseEmail elements are present.
If this field is present and does not contain a valid email
address (by means of a regular expression) the invoice delivery
is rejected!
Add response BCC email addresses.
Only one email address may be provided per element!
Email addresses specified here are used independent if
AlternateResponseEmail or AdditionalResponseEmail elements are present.
If this field is present and does not contain a valid email
address (by means of a regular expression) the invoice delivery
is rejected!
A special prefix to be used for the email subject.
This should allow for easy filtering of email messages from erechnung.gv.at.
This prefix is added AFTER the default '[ERB] ' prefix which has
higher precedence.
Contains the Webservice settings for a single invocation
Contains email response settings
You may provide an email address of the technical stuff
responsible for this Webservice in case there are specific
error (like invocation of the callback service fails)
Optional request extension point.
Only handled upon bilateral agreement.
If this flag is set to true, the transmission is considered a
test-transmission and will not be forwarded to the invoice recipient!
If this flag is set to 'true' only the technical checks are performed and the result is returned.
If ID of the language in which the returned messages should be
printed. Currently supported are:
'de' - German
'en' - English
Contains the main invoice to be uploaded.
Optional attachments to be delivered together with the invoice.
Only certain file types are allowed: PDF, PNG, XLS, XLSX and XML
!!!This is NOT supported!!!
Optional attachments to be downloaded by erechnung.gv.at together with the invoice.
Only certain file types are allowed: PDF, PNG, XLS, XLSX and XML
Optional settings that apply only to a single service call!
!!!This is NOT supported!!!
The MIME type of the printable invoice.
For PDF this is 'application/pdf'
The size of the document in bytes before it was Base64 encoded
The algorithm used to calculate the hash value.
The hash value of the document calculated with the algorithm
specified in the 'hashalgo' attribute before it was Base64 encoded.
The hash value must be present as a hex-encoded string.
The date and time when the printable invoice was generated.
The time zone is always UTC.
The delivery response success type.
The erechnung.gv.at internal document ID.
The supplier ID (Lieferantennummer) as specified in the invoice.
The email address(es) as specified in the invoice.
Each element contains a single email address.
The invoice number (Rechnungsnummer) as specified in the invoice.
The complete order ID (Auftragsreferenz) as specified in the invoice.
!!!This is NOT supported!!!
This element is never present!
Contains the printable version of the invoice delivery acknowledgement.
Optional success response extension point.
Only handled upon bilateral agreement.
The erechnung.gv.at internal error code for machine-processing.
See a separate list for details.
The field containing the error.
The main error message for the specified field.
This should contain a human readable text.
The delivery response error type.
Contains all the single error messages.
Optional error response extension point.
Only handled upon bilateral agreement.
The global delivery response type.
In case of success this elements is present
In case of error this element is present
The generic exception type in case something goes wrong in erechnung.gv.at.
The human understandable exception message.
Input part for method deliverInvoice
Output part for method deliverInvoice
Fault part "Invoice" for method deliverInvoice
SOAP portType WSInvoiceDelivery
Assembled parts for method deliverInvoice
SOAP binding WSInvoiceDelivery
SOAP binding for method deliverInvoice
SOAP service WSInvoiceDelivery