List all delivery notes

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>

You can filter the result by parameters:

GET /api/delivery-notes?delivery_note_number=LS123

Lists all delivery notes with “LS123” in the delivery note number. Upper and lower case are ignored.
The following filter parameters are available:

Parameter Description
client_id ID of the client
contact_id ID of the contact
delivery_note_number Delivery note number
status Status (DRAFT, CREATED). More than one statuses could be given as a comma separated list. Theses statuses will be logically OR-connected.
from Only show delivery notes since this date (format YYYY-MM-DD)
to Only show delivery notes up to this date (format YYYY-MM-DD)
label Free text search in label text
intro Free text search in introductory text
note Free text search in explanatory notes
tags Comma separated list of tags
article_id ID of an article

Get a single delivery note

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; Co. KG
    Hollertszug 26
    57562 Herdorf
    Deutschland</address>
    <title></title>
    <label>project 123</label>
    <intro>Dear sir or madam,...</intro>
    <note>Thank you!</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>
</delivery-note>

status can have the following values:
– DRAFT
– CREATED
Delivery note items and comments can be accessed separately.

Create delivery note

POST /api/delivery-notes
XML element Description Type Default value Mandatory
client_id ID of the client INT yes
contact_id ID of the contact INT
address the delivery address ALNUM Address of the customer
number_pre Prefix ALNUM Value taken from the settings.
number serial number INT next free number
number_length Minimum length of the delivery note number (to be filled with leading zeros) INT Value taken from the settings.
date Date of delivery DATE today
title Title of the document ALNUM
label Label text to describe the project ALNUM
intro Introductory text ALNUM Value taken from the settings.
note Explanatory notest ALNUM Value taken from the settings.
offer_id The ID of the estimate, if the delivery note was created from an estimate. INT
confirmation_id The ID of the confirmation, if the delivery note was created from a confirmation. INT
invoice_id The ID of the invoice, if the delivery note was created from an invoice. INT
free_text_id The ID of the free text to set title, label, intro and note. INT
template_id The ID of the template to be used to complete the delivery note. INT ID of the default template

status at creation is always DRAFT.
Delivery note items (delivery-note-items) can be specified directly at creation. Please find a documentation of the XML elements at Create delivery note items, but the XML element invoice_id need not be specified with.

<delivery-note>
    <client_id>1</client_id>
    <date>2009-11-18</date>
    <note>Dear sir or madam,...:</note>
    <delivery-note-items>
        <delivery-note-item>
            <unit>Piece</unit>
            <quantity>1.5</quantity>
            <title>Pattern</title>
        </delivery-note-item>
        <delivery-note-item>
            <unit>Hour</unit>
            <quantity>8</quantity>
            <title>Working</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>

Edit delivery note

PUT /api/delivery-notes/{id}

A delivery note can basically be edited in draft status (DRAFT) only.
Delivery note items and comments could not be edited at the delivery note. Please use the appropriate resource instead.

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

Delete delivery note

DELETE /api/delivery-notes/{id}

Deletes an invoice with all documents (PDFs), items and comments.

Complete delivery note

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

Completes a delivery note in the draft status (DRAFT). Here, the status of created (CREATED) is set and a PDF is generated and stored in the file system.

The optional parameter template_id determines which template is used to create a pdf.

If this parameter is not specified, the template specified at the delivery note or the default template is used.

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

Open pdf of a delivery note

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

At this point, the parameter format=pdf can also be used to open the PDF directly with MIME type “application/pdf”.
With the optional parameter type=print you can request the PDF without background. Note that the setting print_version must have been activated.

<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 encoded PDF}</base64file>
</pdf>

Send delivery note by e-mail

POST /api/delivery-notes/{id}/email
XML element Description Type Default value Mandatory
email_template_id ID of the e-mail template INT
from Sender EMAIL Default email from the settings
recipients Recipients of the e-mail. There must be at least one xml node for “to”, “cc” and/or “bcc”. XML node/EMAIL ja
subject Subject of the e-mail (may include placeholders) ALNUM Value taken from the (default) e-mail template
body Text of the e-mail (may include placeholders) ALNUM Value taken from the (default) e-mail template
filename Name of the PDF file (without .pdf) ALNUM invoice_{id}
attachments Further files. Attachments can contain as many nodes on the “attachment” with the elements “filename”, “mimetype” and “base64file”. XML node
<email>
    <from>info@billomat.com</from>
    <recipients>
        <to>info@billomat.com</to>
        <cc>mail@example.com</cc>
    </recipients>
    <subject>Your invoice</subject>
    <body>Dear sir or madam, ....</body>
    <filename>delivery_note</filename>
    <attachments>
        <attachment>
            <filename>drawing.pdf</filename>
            <mimetype>application/pdf</mimetype>
            <base64file>{base64 encoded file}</base64file>
        </attachment>
    </attachments>
</email>

Send delivery note by mail

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

Sends a delivery note by mail. Pixelletter has to be configured as add on for usage.

XML element Description Type Default value Mandatory
color Determines whether to use color printing. BOOL 0
duplex Determines whether to use duplex printing. BOOL 1
paper_weight Determines the paper weight in grams. Possible values are 80 or 90. INT 90
attachments Further PDF files. Attachments can contain as many nodes on the “attachment” with the elements “filename”, “mimetype” and “base64file”. XML node
<mail>
    <color>0</color>
    <duplex>1</duplex>
    <paper_weight>90</paper_weight>
    <attachments>
        <attachment>
            <filename>drawing.pdf</filename>
            <mimetype>application/pdf</mimetype>
            <base64file>{base64 encoded file}</base64file>
        </attachment>
    </attachments>
</mail>