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> <file_url>http://www.aws.file.signed.com/file_1.pdf</file_url> <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>
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> <file_url>http://www.aws.file.signed.com/file_1.pdf</file_url> <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>
POST /api/inbox-documents
XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
---|---|---|---|---|
filename | Dateiname | ALNUM | ||
document_type | Document-Type der Datei (siehe unten) | ALNUM | other | |
base64file | Base64-kodierter Dateiinhalt | BASE64FILE | ja | |
metadata | Liste 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>
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:
Wert | Beschreibung |
---|---|
BANK_STATEMENT | Kontoauszug |
CONTRACT | Vertrag |
INVOICE | Rechnung |
REMINDER | Mahnung |
REMITTANCE_SLIP | Überweisungsbeleg |
TRAVEL_EXPENSE_REPORT | Reisekostenabrechnung |
RECEIPT | Kassenbeleg |
FUEL_RECEIPT | Tankbeleg |
ENERGY | Stromrechnung |
OTHER | sonstiges |
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 &amp;amp;amp;amp;amp; Co KG</value> </data>
Folgende Schlüssel für die Meta-Angaben werden unterstützt:
Schlüssel | Beschreibung |
---|---|
TOTAL_GROSS | Gesamtbetrag brutto |
TOTAL_NET | Gesamtbetrag netto |
CURRENCY_CODE | ISO-Währungscode |
INVOICE_NUMBER | Rechnungsnummer |
CLIENT_NUMBER | Kundennummer beim Lieferanten |
DATE | Datum |
DUE_DATE | Fälligkeitsdatum |
NOTE | Notiz |
SENDER_SALUTATION | Anrede des Absenders |
SENDER_NAME | Name des Absenders |
SENDER_NAME_ADDITION | Namenszusatz des Absenders |
SENDER_STREET | Straße des Absenders |
SENDER_PO_BOX | Postfach des Absenders |
SENDER_ZIP | PLZ des Absenders |
SENDER_CITY | Stadt des Absenders |
SENDER_STATE | Staat/Bundesland des Absenders |
SENDER_COUNTRY | Land des Absenders |
PHONE | Telefonnummer des Absenders |
MOBILE | Handynummer des Absenders |
FAX | Faxnummer des Absenders |
E-Mail-Adresse des Absenders | |
WWW | Homepage des Absenders |
BANK_ACCOUNT_NUMBER | Kontonummer des Absenders |
BANK_NUMBER | BLZ des Absenders |
BANK_NAME | Bank des Absenders |
IBAN | IBAN des Absenders |
BIC | BIC des Absenders |
TAX_NUMBER | Steuernummer des Absenders |
VAT_NUMBER | UStID des Absenders |
COMPANY_REGISTER_ID | Handelsregisternummer des Absenders |
SEPA_CREDITOR_IDENTIFIER | SEPA Gläubiger-ID des Absenders |
DELETE /api/inbox-documents/{id}