GET /api/delivery-notes
<?xml version="1.0" encoding="UTF-8"?> <delivery-notes type="array" page="1" per_page="100" total="2"> <delivery-note> … </delivery-note> <delivery-note> … </delivery-note> </delivery-notes>
GET /api/delivery-notes?delivery_note_number=LS123
Parameter | Beschreibung |
---|---|
client_id | ID des Kunden |
contact_id | ID des Kontakts |
delivery_note_number | Lieferscheinnummer |
status | Lieferscheinstatus (DRAFT, CREATED). Mehrere Stati können per Komma getrennt werden. |
from | Nur Lieferscheine ab diesem Datum (Format YYYY-MM-DD) |
to | Nur Lieferscheine bis zu diesem Datum (Format YYYY-MM-DD) |
label | Freitextsuche in der Bezeichnung |
intro | Freitextsuche im Einleitungstext |
note | Freitextsuche im Anmerkungstext |
tags | Kommaseparierte Liste der Schlagworte |
article_id | ID eines Artikels, der enthalten ist |
GET /api/delivery-notes/{id}
<?xml version="1.0" encoding="UTF-8"?> <delivery-note> <id type="integer">1</id> <client_id type="integer">123</client_id> <contact_id type="integer"></contact_id> <created type="datetime">2007-12-13T12:12:00+01:00</created> <delivery_note_number>GS123</delivery_note_number> <number type="integer">123</number> <number_pre>LS</number_pre> <number_length type="integer">0</number_length> <status>CREATED</status> <date type="date">2009-10-14</date> <address>Billomat GmbH &amp;amp;amp;amp; Co. KG Hollertszug 26 57562 Herdorf Deutschland</address> <title></title> <label>Projekt 123</label> <intro>Wir liefern Ihnen folgende Ware:</intro> <note>Vielen Dank!</note> <customerportal_url>https://mybillomatid.billomat.net/customerportal/deliverynotes/show/entityId/123?hash=123456789aabbcc</customerportal_url> <offer_id></offer_id> <confirmation_id>7</confirmation_id> <invoice_id></invoice_id> <template_id></template_id> </delivery-note>
status kann folgende Werte haben:
POST /api/delivery-notes
XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
---|---|---|---|---|
client_id | ID des Kunden | INT | ja | |
contact_id | ID des Kontakts | INT | ||
address | komplette Lieferscheinadresse | ALNUM | Adresse des Kunden | |
number_pre | Präfix | ALNUM | Wert aus Einstellungen | |
number | lfd. Nummer | INT | nächste freie Nummer | |
number_length | Mindestlänge der Lieferscheinnummer (wird mit führenden Nullen aufgefüllt) | INT | Wert aus den Einstellungen | |
date | Lieferscheindatum | DATE | heute | |
title | Dokumentenüberschrift | ALNUM | ||
label | Bezeichnung | ALNUM | ||
intro | Einleitungstext | ALNUM | Wert aus Einstellungen | |
note | Anmerkungstext | ALNUM | Wert aus Einstellungen | |
offer_id | Die ID des Angebots, wenn der Lieferschein aus einem Angebot erstellt wurde. | INT | ||
confirmation_id | Die ID der Auftragsbestätigung, wenn der Lieferschein aus einer Auftragsbestätigung erstellt wurde. | INT | ||
invoice_id | Die ID der Rechnung, wenn der Lieferschein aus einer Rechnung erstellt wurde. | INT | ||
free_text_id | Die ID des Freitextes zur Belegung von title, label, intro und note. | INT | ||
template_id | Die ID der Vorlage, mit der der Lieferschein abgeschlossen werden soll. | INT | ID der Standardvorlage |
status ist bei der Erstellung immer DRAFT.
Bei der initialen Erstellung im DRAFT-Status wird die delivery_note_number als leere Response zurückgegeben. Erst bei Abschluss eines Lieferscheines wird die Lieferschein-Nummer berechnet und erhält einen Wert.
Die übrigen Eigenschaften des Lieferscheins werden automatisch berechnet.
Lieferscheinpositionen (delivery-note-items) können bei der Erstellung direkt mit angegeben werden. Es gelten die gleichen XML-Elemente wie unter Lieferscheinposition erstellen. Nur das XML-Element delivery_note_id muss nicht mit angegeben werden.
<delivery-note> <client_id>1</client_id> <date>2009-11-18</date> <intro>Wir liefern Ihnen folgende Ware:</intro> <delivery-note-items> <delivery-note-item> <unit>Stück</unit> <quantity>1.5</quantity> <title>Muster</title> </delivery-note-item> <delivery-note-item> <unit>Stück</unit> <quantity>8</quantity> <title>Visitenkarten</title> </delivery-note-item> </delivery-note-items> </delivery-note>
<?xml version="1.0" encoding="UTF-8"?> <delivery-note> <id type="integer">1234</id> <client_id type="integer">1</client_id> <created type="datetime">2007-12-13T12:12:00+01:00</created> <delivery_note_number>LS124</delivery_note_number> <number type="integer">124</number> <number_pre>LS</number_pre> <number_length type="integer">0</number_length> <date type="date">2009-11-18</date> … </delivery-note>
PUT /api/delivery-notes/{id}
<delivery-note> <date>2009-10-13</date> </delivery-note>
DELETE /api/delivery-notes/{id}
PUT /api/delivery-notes/{id}/complete
Welche Vorlage für die PDF-Erzeugung benutzt wird, steuert der optionale Parameter template_id.
Wird dieser Parameter nicht angegeben, wird entweder die am Lieferschein hinterlegte Vorlage oder die eingestellte Standardvorlage benutzt.
<complete> <template_id>123</template_id> </complete>
GET /api/delivery-notes/{id}/pdf
<pdf> <id type="integer">4882</id> <created type="datetime">2009-09-02T12:04:15+02:00</created> <delivery_note_id type="integer">240</delivery_note_id> <filename>delivery-note_123.pdf</filename> <mimetype>application/pdf</mimetype> <filesize>70137</filesize> <base64file>{base64-kodiertes PDF}</base64file> </pdf>
POST /api/delivery-notes/{id}/email
XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
---|---|---|---|---|
email_template_id | ID der E-Mail-Vorlage | INT | ||
from | Absender | Standard-E-Mail aus Einstellungen | ||
recipients | Empfänger der E-Mail. Muss mindestens einen XML-Knoten „to“, „cc“ und/oder „bcc“ mit den gewünschten E-Mail-Adressen enthalten | XML-Knoten/EMAIL | ja | |
subject | Betreff der E-Mail, kann Platzhalter enthalten | ALNUM | Wert aus der (Standard-)E-Mail-Vorlage | |
body | Text der Mail, kann Platzhalter enthalten | ALNUM | Wert aus der (Standard-)E-Mail-Vorlage | |
filename | Dateiname der PDF-Lieferschein (ohne .pdf) | ALNUM | delivery-note_{id} | |
attachments | Weitere Dateianhänge. Kann beliebig viele Dateianhänge über die Knoten „attachment“ mit den Elementen „filename“, „mimetype“ und „base64file“ enthalten | XML-Knoten |
<email> <from>info@billomat.com</from> <recipients> <to>info@billomat.com</to> <cc>mail@example.com</cc> </recipients> <subject>Ihr Lieferschein</subject> <body>Sehr geehrte Damen und Herren, ….</body> <filename>Lieferschein</filename> <attachments> <attachment> <filename>zeichnung.pdf</filename> <mimetype>application/pdf</mimetype> <base64file>{base64-kodierte Datei}</base64file> </attachment> </attachments> </email>
POST /api/delivery-notes/{id}/mail
XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
---|---|---|---|---|
color | Zeigt an, ob ein Farbdruck beauftragt werden soll. | BOOL | 0 | |
duplex | Zeigt an, ob Duplexdruck beauftragt werden soll. | BOOL | 1 | |
paper_weight | Welche Papierstärke in Gramm soll das Papier haben? Mögliche Werte sind 80 oder 90. | INT | 90 | |
attachments | PDF 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>