Alle Briefe auflisten

GET /api/letters
<?xml version="1.0" encoding="UTF-8"?>
<letters type="array" page="1" per_page="100" total="2">
	<letter>
	...
	</letter>
	<letter>
	...
	</letter>
</letters>

Über Parameter kann gefiltert werden:

GET /api/letters?subject=Bestellung+123

Listet alle Briefe auf, die „Bestellung 123“ im Betreff haben. Groß- und Kleinschreibung wird ignoriert.
Folgende Filter-Parameter stehen zur Verfügung:

ParameterBeschreibung
client_idID des Kunden
contact_idID des Kontakts
supplier_idID des Lieferanten
statusBriefstatus (DRAFT, COMPLETED). Mehrere Stati können per Komma getrennt werden.
fromNur Briefe ab diesem Datum (Format YYYY-MM-DD)
toNur Briefe bis zu diesem Datum (Format YYYY-MM-DD)
labelFreitextsuche in der Bezeichnung
introFreitextsuche im Brieftext
tagsKommaseparierte Liste der Schlagworte

Einzelnen Brief aufrufen

GET /api/letters/{id}
<?xml version="1.0" encoding="UTF-8"?>
<letter>
    <id type="integer">1</id>
    <created type="datetime">2014-12-13T12:12:00+01:00</created>
    <client_id type="integer">123</client_id>
    <contact_id type="integer"></contact_id>
    <supplier_id type="integer"></supplier_id>
    <status>COMPLETED</status>
    <date type="date">2014-10-14</date>
    <address>Billomat GmbH & Co. KG
    Hollertszug 26
    57562 Herdorf
    Deutschland</address>
    <label>Projekt 123</label>
    <subject>Ihre Bestellung</subject>
    <intro>Sehr geehrte Damen und Herren, ...</intro>
    <customerportal_url>https://mybillomatid.billomat.net/customerportal/letters/show/entityId/123?hash=123456789aabbcc</customerportal_url>
</letter>

status kann folgende Werte haben:
– DRAFT (Entwurf)
– COMPLETED (abgeschlossen)

Brief erstellen

POST /api/letters
XML-ElementBeschreibungTypDefault-WertPflichtfeld
client_idID des KundenINTja
contact_idID des KontaktsINT
supplierLieferantINT
addresskomplette BriefadresseALNUMAdresse des Kunden
dateBriefdatumDATEheute
subjectDokumentenüberschriftALNUM
labelBezeichnungALNUM
introTextALNUMWert aus Einstellungen
free_text_idDie ID des Freitextes zur Belegung von subject (title), label und intro.INT
template_idDie ID der Vorlage, mit der der Brief abgeschlossen werden soll.INTID der Standardvorlage

status ist bei der Erstellung immer DRAFT.

<letter>
    <client_id>1</client_id>
	<date>2009-11-18</date>
	<subject>Ihre Bestellung</subject>
    <intro>Sehr geehrte Damen und Herren,...</intro>
</letter>
<?xml version="1.0" encoding="UTF-8"?>
<letter>
	<id type="integer">1234</id>
	<client_id type="integer">1</client_id>
	<created type="datetime">2014-12-13T12:12:00+01:00</created>
	<subject>Ihre Bestellung>/subject>
    <intro>Sehr geehrte Damen und Herren,...</intro>
	...
</letter>

Brief bearbeiten

PUT /api/letters/{id}

Ein Brief kann grundsätzlich nur im Entwurfs-Status (DRAFT) bearbeitet werden.

<letter>
    <date>2009-10-13</date>
</letter>

Brief löschen

DELETE /api/letters/{id}

Löscht einen Brief inkl. aller dazugehöriger Dokumente (PDFs) und Kommentare.

Brief abschließen

PUT /api/letters/{id}/complete

Schließt einen Brief im Entwurfsstatus (DRAFT) ab. Dabei wird der Status auf abgeschlossen (COMPLETED) gesetzt, ein PDF erzeugt und im Dateisystem abgelegt.

Welche Vorlage für die PDF-Erzeugung benutzt wird, steuert der optionale Parameter template_id.

Wird dieser Parameter nicht angegeben, wird entweder die am Brief hinterlegte Vorlage oder die eingestellte Standardvorlage benutzt.

<complete>
    <template_id>123</template_id>
</complete>

PDFs eines Briefs aufrufen

GET /api/letters/{id}/pdf

An dieser Stelle kann außerdem der Parameter format=pdf verwendet werden, um das PDF direkt mit Mimetype „application/pdf“ aufzurufen. Über den optionalen Parameter type=print kann das PDF ohne Hintergrund angefordert werden. Bitte beachte, dass zum Zeitpunkt der Erstellung die Einstellung print_version bei den Settings aktiviert gewesen sein muss.

<pdf>
	<id type="integer">4882</id>
	<created type="datetime">2009-09-02T12:04:15+02:00</created>
	<filename>letter_123.pdf</filename>
	<mimetype>application/pdf</mimetype>
	<filesize>70137</filesize>
	<base64file>{base64-kodiertes PDF}</base64file>
</pdf>

Brief per E-Mail versenden

POST /api/letters/{id}/email
XML-ElementBeschreibungTypDefault-WertPflichtfeld
email_template_idID der E-Mail-VorlageINT
fromAbsenderEMAILStandard-E-Mail aus Einstellungen
recipientsEmpfänger der E-Mail. Muss mindestens einen XML-Knoten „to“, „cc“ und/oder „bcc“ mit den gewünschten E-Mail-Adressen enthaltenXML-Knoten/EMAILja
subjectBetreff der E-Mail, kann Platzhalter enthaltenALNUMWert aus der (Standard-)E-Mail-Vorlage
bodyText der Mail, kann Platzhalter enthaltenALNUMWert aus der (Standard-)E-Mail-Vorlage
filenameDateiname der PDF-Brief (ohne .pdf)ALNUMletter_{id}
attachmentsWeitere Dateianhänge. Kann beliebig viele Dateianhänge über die Knoten „attachment“ mit den Elementen „filename“, „mimetype“ und „base64file“ enthaltenXML-Knoten
<email>
	<from>info@billomat.com</from>
	<recipients>
		<to>info@billomat.com</to>
		<cc>mail@example.com</cc>
	</recipients>
	<subject>Ihr Brief</subject>
	<body>Sehr geehrte Damen und Herren, ....</body>
	<filename>Brief</filename>
	<attachments>
		<attachment>
			<filename>zeichnung.pdf</filename>
			<mimetype>application/pdf</mimetype>
			<base64file>{base64-kodierte Datei}</base64file>
		</attachment>
	</attachments>
</email>

Brief per Post versenden

POST /api/letters/{id}/mail

Versendet einen Brief per Post. Dazu muss Pixelletter als Add-On eingerichtet sein.

XML-ElementBeschreibungTypDefault-WertPflichtfeld
colorZeigt an, ob ein Farbdruck beauftragt werden soll.BOOL0
duplexZeigt an, ob Duplexdruck beauftragt werden soll.BOOL1
paper_weightWelche Papierstärke in Gramm soll das Papier haben? Mögliche Werte sind 80 oder 90.INT90
attachmentsPDF Dateien, die zusätzlich mit gedruckt werden sollen. Kann beliebig viele Dateien über die Knoten „attachment“ mit den Elementen „filename“, „mimetype“ und „base64file“ enthalten.XML-Knoten
<mail>
    <color>0</color>
    <duplex>1</duplex>
    <paper_weight>90</paper_weight>
    <attachments>
        <attachment>
            <filename>zeichnung.pdf</filename>
            <mimetype>application/pdf</mimetype>
            <base64file>{base64-kodierte Datei}</base64file>
        </attachment>
    </attachments>
</mail>