Document Management API
| DocumentInboxImport | Import electronic document to document management inbox |
| DocumentInboxAddEntry | Add an entry to document management inbox (document capture inbox) |
| DocumentInboxList | List entries in the document management inbox |
DocumentInboxImport
Import electronic document to document inbox. This can be only a document which is unique to a specific organization and which contains all data needed to identify its type and receiver. Examples of such documents include ISO SEPA bank statements in XML, electronic invoices in XML (eSLOG, UBL), etc.
Parameters
| checkExisting | Boolean parameter. If true, importing an already existing document will fail. The document is equal to an already existing document if document number or filename match existing/already imported document. |
| allOrganizations | Boolean parameter. If true, the organization lookup will be performed before actual import is done. The document will be imported into the organization for which the document is destined according to the data it contains (VAT ID, TaxID, IBAN, etc.). |
| electronicDocument | Electronic document file. This can be either ISO SEPA XML or eSLOG XML |
| documentVisualization | PDF visualization of electronic document (optional parameter) |
| automaticallyImportDocument | Optional parameter, that determines, that document (for now only received invoices and bank statements) will be automatically imported after successfully imported into inbox. |
Example request and response
POST /WebServicesSI/API HTTP/1.1
Host: eurofaktura.com
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DocumentInboxImport">
<parameter name="checkExisting" value="true" />
<parameter name="allOrganizations" value="true" />
<parameter name="automaticallyImportDocument" value="true" />
<parameter name="electronicDocument">
<documentDate>2012-11-15 12:00:00<documentDate>
<fileName>ISO_sepa.xml<fileName>
<contents encoding="BASE64">ASDASDASDASD</contents>
</parameter>
<parameter name="documentVisualization">
<documentDate>2012-11-15 12:00:00<documentDate>
<fileName>ISO_sepa.pdf<fileName>
<contents encoding="BASE64">ASDASDASDASD</contents>
</parameter>
</method>
</request>
DocumentInboxAddEntry
Add new entry to document inbox. This can be either a PDF document, scanned image, XML electronic invoice or even multiple files each of its own type.
Parameters
| checkExisting | Boolean parameter. If true, importing an already existing document will fail. The document is equal to an already existing document if document date, partner and document number all match. |
| automaticallyImportDocument | Optional parameter, that determines, that document (for now only received invoices and bank statements) will be automatically imported after successfully imported into inbox. |
Example request and response
POST /WebServicesSI/API HTTP/1.1
Host: eurofaktura.com
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DocumentInboxAddEntry">
<parameter name="checkExisting" value="true" />
<parameter name="automaticallyImportDocument" value="true" />
<parameter name="document">
<documentDate>2012-11-15 12:00:00</documentDate>
<documentNumber>22309-001-003</documentNumber>
<documentType>PurchaseInvoice</documentType> <!-- Document type (Unknown, PurchaseInvoice, ReceivedSalesQuote, BankStatement, Contract, Advertising, ReceivedSalesOrder, ReceivedCreditNote, ReceivedAdvanceInvoice, GoodsReceipt, CashbookDailyTurnoverSummary, SalesInvoice, Compensation, PayrollDocuments, Other, SingleAdministrativeDocument)
<senderPartnerIdentifier>88888888</senderPartnerIdentifier>
<senderPartnerCode>00001</senderPartnerCode>
<senderPartnerName>Test Sender d.o.o.</senderPartnerName>
<emailSubject>Incoming mail subject</emailSubject>
<mailDescription>Description in incoming mail</mailDescription>
<receivedDate>2020-01-01</receivedDate>
<Attachments>
<Attachment>
<fileName>Invoice.pdf</fileName>
<fileType>PDF</fileType>
<contents encoding="BASE64">ASDASDASDASD</contents>
</Attachment>
<Attachment>
<fileName>Invoice.xml</fileName>
<fileType>XML</fileType>
<contents encoding="BASE64">ASDASDASDASD</contents>
</Attachment>
</Attachments>
</parameter>
</method>
</request>
DocumentInboxList
List entries in the document management inbox.
Parameters
| documentNumber | Document number received by mail. |
| dateFrom | Document date from received by mail. |
| dateTo | Document date to received by mail. |
| receivalDateFrom | Mail receival from. |
| receivalDateTo | Mail receival to. |
| status | Status of mail. |
| sequentialNumber | Sequential number of mail. |
| senderName | Sender name. |
| type | Type of mail. |
| deliveryMethod | Delivery method of mail. |
| description | Search by word or sentence from mail description. |
| fileName | Search mail by their attachemnt filenames. |
Example request and response
POST /WebServicesSI/API HTTP/1.1
Host: eurofaktura.com
User-Agent: Mozilla/4.0
Content-Length: 410
Content-Type: application/octet-stream
<?xml version="1.0" encoding="utf-8"?>
<request>
<login username="micka" md5pass="ddb43e9f119c6805f4770ecc4f6466ba" token="E7DF3E6E94FB4579BBA8F54979010B5C" />
<method name="DocumentInboxList">
<parameter name="status" value="Open" />
<parameter name="receivalDateFrom" type="Date" value="2017-01-01" />
<parameter name="receivalDateTo" type="Date" value="2021-01-01" />
</method>
</request>
</request>
Response
HTTP/1.1 200 OK
Server: e-racuni.com web server
Date: Tue, 1 March 2010 11:00:05 GMT
Content-Type: text/xml
Content-Length: 328
<?xml version="1.0" encoding="utf-8"?>
<response status="ok">
<Document>
<businessYear>2021</businessYear>
<deliveryMethod>ElectronicViaWebServicesAPI</deliveryMethod>
<description>Incoming mail subject
------------------------------
Description in incoming mail</description>
<documentDate>2012-11-15</documentDate>
<documentNumber>22309-001-003</documentNumber>
<enteredTS>2021-03-18 08:14:01</enteredTS>
<receivedDate>2020-01-01</receivedDate>
<senderName>WorldStream B.V.</senderName>
<sequentialNumber>5</sequentialNumber>
<status>Open</status>
<type>PurchaseInvoice</type>
</Document>
<Document>
<businessYear>2021</businessYear>
<deliveryMethod>ElectronicViaWebServicesAPI</deliveryMethod>
<description>Incoming mail subject
------------------------------
Description in incoming mail</description>
<documentDate>2012-11-15</documentDate>
<documentNumber>22309-001-003</documentNumber>
<enteredTS>2021-03-18 08:13:10</enteredTS>
<receivedDate>2020-01-01</receivedDate>
<senderName>Tastno 2x</senderName>
<sequentialNumber>4</sequentialNumber>
<status>Open</status>
<type>PurchaseInvoice</type>
</Document>
</response>
Response (on error)
<?xml version="1.0" encoding="utf-8"?>
<response status="error" >
<error description="Access denied. User account does not have sufficient privileges for the given request"><error/> <!-- There are several different error messages possible.
</response>
