Inbox | Billomat Accounting API - Create Online Invoices

Get all inbox documents

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">foo</user_id>
<filename>bar.pdf</filename>
<mimetype>application/pdf</mimetype>
<filesize type="integer">12463</filesize>
<metadata type="array"></metadata>
</inbox-document>
</inbox-documents>

Get a single inbox document

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 encoded file}</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>

Create an inbox document

POST /api/inbox-documents

XML element	Description	Type	Madatory
filename	Name of the file	ALNUM
base64file	Base64 encoded file	BASE64FILE	yes
metadata	List of meta data (see below)	ARRAY

<inbox-document>
<base64file>{base64 encoded file}</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 encoded file}</base64file>
</inbox-document>

Metadata

A document can be annotated with metadata. This data can be useful when an inbox document becomes a incoming invoice later.
Metadata are embedded in a metadata block and always consists of a key and a value.

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

The following key are supported:

Key	Description
TOTAL_GROSS	Total amount gross
TOTAL_NET	Total amount net
CURRENCY_CODE	ISO currency code
INVOICE_NUMBER	Invoice number
CLIENT_NUMBER	Client number
DATE	Date
DUE_DATE	Due date
NOTE	Note
SENDER_SALUTATION	Salutation of the supplier
SENDER_NAME	Name of the supplier
SENDER_NAME_ADDITION	Name addition of the supplier
SENDER_STREET	Street of the supplier
SENDER_PO_BOX	Pox box of the supplier
SENDER_ZIP	Zip code of the supplier
SENDER_CITY	City of the supplier
SENDER_STATE	State of the supplier
SENDER_COUNTRY	Country of the supplier
PHONE	Phone number of the supplier
MOBILE	Handynummer of the supplier
FAX	Fax number of the supplier
EMAIL	E-mail address of the supplier
WWW	Homepage of the supplier
BANK_ACCOUNT_NUMBER	Bank account number of the supplier
BANK_NUMBER	Bank number of the supplier
BANK_NAME	Bank of the supplier
IBAN	IBAN of the supplier
BIC	BIC of the supplier
TAX_NUMBER	Tax number of the supplier
VAT_NUMBER	VAT number of the supplier
COMPANY_REGISTER_ID	Company register id of the supplier
SEPA_CREDITOR_IDENTIFIER	SEPA creditor identifier of the supplier

Delete an inbox document

DELETE /api/inbox-documents/{id}