List all confirmations

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

You can filter the result by parameters:

GET /api/confirmations?confirmation_number=AB123

Lists all invoices with “AB123” in the confirmation number. Upper and lower case are ignored.
The following filter parameters are available:

client_idID of the client
contact_idID of the contact
confirmation_numberConfirmation number
statusStatus (DRAFT, COMPLETED, CANCELED). More than one statuses could be given as a comma separated list. Theses statuses will be logically OR-connected.
fromOnly show invoices since this date (format YYYY-MM-DD)
toOnly show invoices up to this date (format YYYY-MM-DD)
labelFree text search in label text
introFree text search in introductory text
noteFree text search in explanatory notes
tagsComma separated list of tags
article_idID of an article

Get a single confirmation

GET /api/confirmations/{id}
<?xml version="1.0" encoding="UTF-8"?>
<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>
<number type="integer">123</number>
<number_length type="integer">0</number_length>
<date type="date">2010-10-01</date>

<address>Billomat GmbH & Co. KG
Hollertszug 26
57562 Herdorf
Deutschland</address>    <title></title>
<label>project 123</label>
<intro>Dear sir or madam,…</intro>
<note>Best regards</note>
<total_gross type="float">107.1</total_gross>
<total_net type="float">90.0</total_net>
<total_gross_unreduced type="float">119.0</total_gross_unreduced>
<total_net_unreduced type="float">100.0</total_net_unreduced>
<quote type="float">1.0000</quote>
<taxes type="array">
<rate type="float">19.0</rate>
<amount type="float">19.0</amount>

status can have the following values:

    net_gross can have the following values:
  • NET
    In addition to the confirmation combined taxes (taxes) will be returned.
    Items and comments can be accessed separately.

Create a confirmation

POST /api/confirmations
XML elementDescriptionTypeDefault valueMandatory
client_idID of the clientINTyes
contact_idID of the contactINT
addressThe addressALNUMClient’s address
number_prePrefixALNUMValue taken from the settings
numberserial numberINTnext free number
number_lengthMinimum length of the confirmationnumber (to be filled with leading zeros)INTValue taken from the settings
dateDate of the confirmationDATEtoday
titleTitle of the documentALNUM
labelLabel text to describe the projectALNUM
introIntroductory textALNUMValue taken from the settings
noteExplanatory notesALNUMValue taken from the settings
reductionReduction (absolute or percent: 10/10%)ALNUM
currency_codeCurrencyISO currency codeDefault currency
net_grossPrice basis (gross or net prices)ALNUM (“NET”, “GROSS”)Default value taken from the settings
quoteCurrency quote (for conversion into standard currency)FLOAT1.0000
offer_idThe ID of the estimate, if the confirmation was created from an estimate.INT
free_text_idThe ID of the free text to set title, label, intro and note.INT
template_idThe ID of the template to be used to complete the confirmation.INTID of the default template

status at creation is always DRAFT.

When initially created in DRAFT state, the confirmation_number is returned as an empty response. It is only on completion of a confirmation that the confirmation number is calculated and gets a value.

The remaining properties are automatically calculated.

Confirmation items (confirmation-items) can be specified directly at creation. Please find a documentation of the XML elements at Create confirmation items, but the XML element confirmation_id need not be specified with.

<title>Pattern 2</title>
<?xml version="1.0" encoding="UTF-8"?>
<id type="integer">1234</id>
<client_id type="integer">5</client_id>
<created type="datetime">2007-12-13T12:12:00+01:00</created>
<number type="integer">124</number>
<number_length type="integer">0</number_length>
<date type="date">2009-11-17</date>

Edit a confirmation

PUT /api/confirmations/{id}

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


Delete a confirmation

DELETE /api/confirmations/{id}

Deletes a confirmation with all documents (PDFs), items and comments.

Complete confirmation

PUT /api/confirmations/{id}/complete

Completes a confirmation in the draft status (DRAFT). Here, the status of open (OPEN) 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 confirmation or the default template is used.


Open pdf of a confirmation

GET /api/confirmations/{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.

    <id type="integer">4882</id>
<created type="datetime">2009-09-02T12:04:15+02:00</created>
<confirmation_id type="integer">240</confirmation_id>
<base64file>{base64 encoded PDF}</base64file>

Send confirmation by e-mail

POST /api/confirmations/{id}/email
XML elementDescriptionTypeDefault valueMandatory
email_template_idID of the e-mail templateINT
fromSenderEMAILDefault email from the settings
recipientsRecipients of the e-mail. There must be at least one xml node for “to”, “cc” and/or “bcc”.XML node/EMAILja
subjectSubject of the e-mail (may include placeholders)ALNUMValue taken from the (default) e-mail template
bodyText of the e-mail (may include placeholders)ALNUMValue taken from the (default) e-mail template
filenameName of the PDF file (without .pdf)ALNUMinvoice_{id}
attachmentsFurther files. Attachments can contain as many nodes on the “attachment” with the elements “filename”, “mimetype” and “base64file”.XML node
<subject>Bestätigung des Auftrags</subject>
<body>Dear sir or madam, ….</body>
<base64file>{base64 encoded file}</base64file>

Send confirmation by mail

POST /api/confirmations/{id}/mail

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

XML elementDescriptionTypeDefault valueMandatory
colorDetermines whether to use color printing.BOOL0
duplexDetermines whether to use duplex printing.BOOL1
paper_weightDetermines the paper weight in grams. Possible values are 80 or 90.INT90
attachmentsFurther PDF files. Attachments can contain as many nodes on the “attachment” with the elements “filename”, “mimetype” and “base64file”.XML node
<base64file>{base64 encoded file}</base64file>

Cancel confirmation

PUT /api/confirmations/{id}/cancel

Undo cancellation

PUT /api/confirmations/{id}/uncancel

Mark confirmationas cleared

PUT /api/confirmations/{id}/clear

Mark confirmationas uncleared

PUT /api/confirmations/{id}/unclear