Inbox

Alle Inbox-Dokumente auflisten

GET /api/inbox-documents
<?xml version="1.0" encoding="UTF-8"?>
<inbox-documents type="array" page="1" per_page="100" total="2">
<inbox-document>
<id type="integer">1</id>
<user_id type="integer">1</user_id>
<filename>foo.pdf</filename>
<mimetype>application/pdf</mimetype>
<filesize type="integer">128767</filesize>
<metadata type="array">
<data>
<key>SENDER_CITY</key>
<value>Siegen</value>
</data>
<data>
<key>WWW</key>
<value>www.billomat.com</value>
</data>
</metadata>
</inbox-document>
<inbox-document>
<id type="integer">2</id>
<user_id type="integer">1</user_id>
<filename>bar.pdf</filename>
<mimetype>application/pdf</mimetype>
<filesize type="integer">12463</filesize>
<metadata type="array"></metadata>
<inbox-document>
…
</inbox-documents>

Einzelnes Inbox-Dokument aufrufen

GET /api/inbox-documents/{id}
<?xml version="1.0" encoding="UTF-8"?>
<inbox-document>
<id type="integer">1</id>
<user_id type="integer">1</user_id>
<filename>foo.pdf</filename>
<mimetype>application/pdf</mimetype>
<filesize type="integer">128767</filesize>
<base64file>{base64-kodiertes PDF}</base64file>
<metadata type="array">
<data>
<key>SENDER_CITY</key>
<value>Siegen</value>
</data>
<data>
<key>WWW</key>
<value>www.billomat.com</value>
</data>
</metadata>
</inbox-document>

Inbox-Dokument erstellen

POST /api/inbox-documents
XML-ElementBeschreibungTypDefault-WertPflichtfeld
filenameDateinameALNUM
document_typeDocument-Type der Datei (siehe unten)ALNUMother
base64fileBase64-kodierter DateiinhaltBASE64FILEja
metadataListe mit Metadaten (siehe unten)ARRAY
<inbox-document>
<base63file>{base64-kodiertes PDF}</base64file>
</inbox-document>
<?xml version="1.0" encoding="UTF-8"?>
<inbox-document>
<id type="integer">17</id>
<user_id type="integer">12</user_id>
<filename>inbox_17.pdf</filename>
<filesize type="integer">13767</filesize>
<base64file>{base64-kodiertes PDF}</base64file>
</inbox-document>

Document-Type

Ein Dokument kann mit einem Document-Type versehen werden. Dieser Wert kann hilfreich sein, um die Genauigkeit der Texterkennung zu verbessern und dadurch bei der späteren manuellen Erstellung einer Eingangsrechnung die passenden Werte für Betrag brutto / Betrag netto vorgeschlagen zu bekommen.

Folgende Werte für Document-Type werden unterstützt:

WertBeschreibung
BANK_STATEMENTKontoauszug
CONTRACTVertrag
INVOICERechnung
REMINDERMahnung
REMITTANCE_SLIPÜberweisungsbeleg
TRAVEL_EXPENSE_REPORTReisekostenabrechnung
RECEIPTKassenbeleg
FUEL_RECEIPTTankbeleg
ENERGYStromrechnung
OTHERsonstiges

Metadaten

Ein Dokument kann mit Metadaten versehen werden. Diese Daten können hilfreich sein, wenn aus dem Inbox-Dokument später eine Eingangsrechnung erzeugt wird.
Metadaten stehen im metadata-Block. Eine Metaangabe besteht dabei immer aus einem Schlüssel und einem Wert.

<data>
<key>SENDER_NAME</key>
<value>Billomat Gmbh & Co KG</value>
</data>

Folgende Schlüssel für die Meta-Angaben werden unterstützt:

SchlüsselBeschreibung
TOTAL_GROSSGesamtbetrag brutto
TOTAL_NETGesamtbetrag netto
CURRENCY_CODEISO-Währungscode
INVOICE_NUMBERRechnungsnummer
CLIENT_NUMBERKundennummer beim Lieferanten
DATEDatum
DUE_DATEFälligkeitsdatum
NOTENotiz
SENDER_SALUTATIONAnrede des Absenders
SENDER_NAMEName des Absenders
SENDER_NAME_ADDITIONNamenszusatz des Absenders
SENDER_STREETStraße des Absenders
SENDER_PO_BOXPostfach des Absenders
SENDER_ZIPPLZ des Absenders
SENDER_CITYStadt des Absenders
SENDER_STATEStaat/Bundesland des Absenders
SENDER_COUNTRYLand des Absenders
PHONETelefonnummer des Absenders
MOBILEHandynummer des Absenders
FAXFaxnummer des Absenders
EMAILE-Mail-Adresse des Absenders
WWWHomepage des Absenders
BANK_ACCOUNT_NUMBERKontonummer des Absenders
BANK_NUMBERBLZ des Absenders
BANK_NAMEBank des Absenders
IBANIBAN des Absenders
BICBIC des Absenders
TAX_NUMBERSteuernummer des Absenders
VAT_NUMBERUStID des Absenders
COMPANY_REGISTER_IDHandelsregisternummer des Absenders
SEPA_CREDITOR_IDENTIFIERSEPA Gläubiger-ID des Absenders

Inbox-Dokument löschen

DELETE /api/inbox-documents/{id}