Comments | Billomat Accounting API - Create Online Invoices

List all comments of a delivery note

GET /api/delivery-note-comments?delivery_note_id={delivery_note_id}

Comments can only be returned for a particular delivery note.
Therefore delivery_note_id is a mandatory parameter.

<?xml version="1.0" encoding="UTF-8"?>
<delivery-note-comments type="array" page="1" per_page="100" total="2">
    <delivery-note-comment>
        ...
    </delivery-note-comment>
    <delivery-note-comment>
        ...
    </delivery-note-comment>
</delivery-note-comments>

Get single comment

GET /api/delivery-note-comments/{id}

<?xml version="1.0" encoding="UTF-8"?>
<delivery-note-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <delivery_note_id type="integer">1</delivery_note_id>
    <user_id type="integer">1</user_id>
    <comment>Delivery note created.</comment>
    <actionkey>CREATED</actionkey>
    <public>0</public>
</delivery-note-comment>

actionkey

The value for actionkey indicates by what kind of comment it is. It is set for all actions that were triggered by the system.
With the actionkey a filtering is possible. In this case, multiple values can be specified. They are separated by a comma.

GET /api/delivery-note-comments?delivery_note_id={delivery_note_id}&actionkey=CREATE,COPY

actionkey	Description
COMMENT	a comment that was entered by the user
CREATE	created
COPY	copied
CREATE_FROM_OFFER	created from estimate
CREATE_FROM_INVOICE	created from invoice
CREATE_FROM_CONFIRMATION	created from confirmation
STATUS	status changed
MAIL	sent (e-mail)
LETTER	sent (letter)
FAX	sent (fax)
ERROR_MAIL	e-mail error

Create comment

POST /api/delivery-note-comments

XML element	Description	Type	Default value	Mandatory
delivery_note_id	ID of the delivery note	INT		yes
comment	Comment text	ALNUM		yes
public	Should the comment be displayed in the customer portal (0 = no, 1 = yes)?	BOOL	0	no

<delivery-note-comment>
    <delivery_note_id>1</delivery_note_id>
    <comment>Send by mail</comment>
</delivery-note-comment>

<?xml version="1.0" encoding="UTF-8"?>
<delivery-note-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <delivery_note_id type="integer">1</delivery_note_id>
    <user_id type="integer">1</user_id>
    <comment>Send by mail</comment>
    <actionkey>COMMENT</actionkey>
    <public>0</public>
</delivery-note-comment>

Delete comment

DELETE /api/delivery-note-comments/{id}