Lieferscheine

Alle Lie­fer­scheine auflisten

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>

Über Para­me­ter kann gefil­tert werden:

GET /api/delivery-notes?delivery_note_number=LS123

Lis­tet alle Lie­fer­scheine auf, die “LS123” in der Lie­fer­schein­num­mer haben. Groß– und Klein­schrei­bung wird igno­riert.
Fol­gende Filter-Parameter ste­hen zur Verfügung:

Lie­fer­scheine aggre­giert auflisten

GET /api/delivery-notes?group_by=client

Lie­fer­scheine kön­nen auch grup­piert abge­ru­fen wer­den. Obi­ges Bei­spiel grup­piert alle Lie­fer­scheine nach Kunde.
Fol­gende Werte ste­hen für den Para­me­ter group_by zur Verfügung:

Ein­zel­nen Lie­fer­schein aufrufen

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>
	<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>
	<status>CREATED</status>
	<date type="date">2009-10-14</date>
	<address>Billomat GmbH &amp; Co. KG&#13;
	Hollertszug 26&#13;
	57562 Herdorf&#13;
	Deutschland</address>
        <label>Projekt 123</label>
	<intro>Wir liefern Ihnen folgende Ware:</intro>
	<note>Vielen Dank!</note>
</delivery-note>

sta­tus kann fol­gende Werte haben:

• DRAFT (Ent­wurf)
• CREATED (erstellt)

Die Lie­fer­schein­po­si­tio­nen und Lie­fer­schein­kom­men­tare kön­nen geson­dert abge­ru­fen werden.

Lie­fer­schein erstellen

POST /api/delivery-notes

sta­tus ist bei der Erstel­lung immer DRAFT.

Die übri­gen Eigen­schaf­ten des Lie­fer­scheins wer­den auto­ma­tisch berechnet.

Lie­fer­schein­po­si­tio­nen (delivery-note-items) kön­nen bei der Erstel­lung direkt mit ange­ge­ben wer­den. Es gel­ten die glei­chen XML-Elemente wie unter Lie­fer­schein­po­si­tion erstel­len. Nur das XML-Element delivery_note_id muss nicht mit ange­ge­ben werden.

<delivery-note>
<client_id>1</client_id>
	<date>2009-11-18</date>
	<note>Wir schreiben Ihnen gut:</note>
	<delivery-note-items>
		<delivery-note-item>
			<unit>Stück</unit>
			<quantity>1.5</quantity>
			<title>Muster</title>
		</delivery-note-item>
		<delivery-note-item>
			<unit>Stunde</unit>
			<quantity>8</quantity>
			<title>Arbeiten</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>
	<date type="date">2009-11-18</date>
	...
</delivery-note>

Lie­fer­schein bearbeiten

PUT /api/delivery-notes/{id}

Ein Lie­fer­schein kann grund­sätz­lich nur im Entwurfs-Status (DRAFT) bear­bei­tet werden.

Lie­fer­scheinepo­si­tio­nen und Kom­men­tare kön­nen nicht direkt über den Lie­fer­schein bear­bei­tet wer­den. Bitte dafür über die ent­spre­chende Res­source gehen.

<delivery-note>
<date>2009-10-13</date>
</delivery-note>

Lie­fer­schein löschen

DELETE /api/delivery-notes/{id}

Löscht einen Lie­fer­schein inkl. aller dazu­ge­hö­ri­ger Doku­mente (PDFs), Lie­fer­schein­po­si­tio­nen und Kom­men­tare.

PDFs eines Lie­fer­scheins aufrufen

GET /api/delivery-notes/{id}/pdf

An die­ser Stelle kann der Para­me­ter format=pdf ver­wen­det wer­den, um das PDF direkt mit Mime­type “application/pdf” aufzurufen.

<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>

Lie­fer­schein abschließen

PUT /api/delivery-notes/{id}/complete

Schließt einen Lie­fer­schein im Ent­wurfs­sta­tus (DRAFT) ab. Dabei wird der Sta­tus auf offen (OPEN) gesetzt, ein PDF erzeugt und im Datei­sys­tem abge­legt.
Wel­che Vor­lage für die PDF-Erzeugung benutzt wird, steu­ert der optio­nale Para­me­ter template_id.
Wird die­ser Para­me­ter nicht ange­ge­ben, wird die ein­ge­stellte Standard-Vorlage benutzt.

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

Lie­fer­schein per E-Mail versenden

POST /api/delivery-notes/{id}/email

<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>

Lie­fer­schein stornieren

PUT /api/delivery-notes/{id}/cancel