Kommentare
Alle Kommentare einer Rechnung auflisten
GET /api/incoming-comments?incoming_id={incoming_id}Kommentare können immer nur für eine bestimmte Rechnung zurückgegeben werden.
Deshalb ist incoming_id ein Pflichtparameter.
<?xml version="1.0" encoding="UTF-8"?> <incoming-comments type="array" page="1" per_page="100" total="2"> <incoming-comment> … </incoming-comment> <incoming-comment> … </incoming-comment> </incoming-comments>
Einzelnen Kommentar aufrufen
GET /api/incoming-comments/{id}<?xml version="1.0" encoding="UTF-8"?> <incoming-comment> <id type="integer">1</id> <created type="datetime">2007-12-13T12:12:00+01:00</created> <incoming_id type="integer">1</incoming_id> <user_id type="integer">1</user_id> <comment>Rechnung zur Buchhaltung übergeben.</comment> <actionkey>CREATED</actionkey> </incoming-comment>
actionkey
Der Wert für actionkey gibt an, um was für eine Art von Kommentar es sich handelt. Er ist bei allen Aktionen gesetzt, die vom System ausgelöst wurden.
Über den actionkey ist auch eine Filterung möglich. Dabei können mehrerer Werte angegeben werden. Sie werden dann mit einen Komma getrennt.
GET /api/incoming-comments?incoming_id={incoming_id}&amp;amp;actionkey=CREATE,COPY| actionkey | Beschreibung |
|---|---|
| COMMENT | ein durch den Nutzer erstellter Kommentar |
| CREATE | erstellen |
| STATUS | Statusänderungen |
| PAYMENT | Zahlungen gebucht |
| DELETE_PAYMENT | Zahlung gelöscht |
Kommentar erstellen
POST /api/incoming-comments
| XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
|---|---|---|---|---|
| incoming_id | ID der Eingangsrechnung | INT | ja | |
| comment | Kommentar | ALNUM | ja |
<incoming-comment> <incoming_id>1</incoming_id> <comment>Rechnung geprüft. Kann bezahlt werden.</comment> </incoming-comment>
<?xml version="1.0" encoding="UTF-8"?> <incoming-comment> <id type="integer">1</id> <created type="datetime">2007-12-13T12:12:00+01:00</created> <incoming_id type="integer">1</incoming_id> <user_id type="integer">1</user_id> <comment>Rechnung geprüft. Kann bezahlt werden.</comment> <actionkey>COMMENT</actionkey> </incoming-comment>
Kommentar löschen
DELETE /api/incoming-comments/{id}