Alle Kommentare einer Rechnung auflisten

GET /api/invoice-comments?invoice_id={invoice_id}

Kommentare können immer nur für eine bestimmte Rechnung zurückgegeben werden.
Deshalb ist invoice_id ein Pflichtparameter.

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

Einzelnen Kommentar aufrufen

GET /api/invoice-comments/{id}
<?xml version="1.0" encoding="UTF-8"?>
<invoice-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <invoice_id type="integer">1</invoice_id>
    <user_id type="integer">1</user_id>
    <comment>Rechnung erstellt.</comment>
    <actionkey>CREATED</actionkey>
    <public>0</public>
</invoice-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/invoice-comments?invoice_id={invoice_id}&actionkey=CREATE,COPY
actionkey Beschreibung
COMMENT ein durch den Nutzer erstellter Kommentar
CREATE erstellen
COPY Kopie
CREATE_FROM_OFFER erstellt aus Angebot
CREATE_FROM_INVOICE erstellt als Korrektur einer Rechnung
CREATE_FROM_RECURRING Abo-Rechnung
STATUS Statusänderungen
PAYMENT Zahlungen gebucht
PAYMENT_ERROR Fehler bei Zahlungen
DELETE_PAYMENT Zahlung gelöscht
MAIL Versenden (E-Mail)
LETTER Versenden (Post)
FAX Versenden (Fax)
SIGN signieren
SIGN_MAIL signiert verschickt
CANCEL stornieren
ERROR_MAIL Fehler beim Versenden (E-Mail)
CREATE_CREDIT_NOTE Gutschrift erzeugt
REMINDER_CREATE Mahnung erstellt
REMINDER_STATUS Mahnung: Statusänderungen
REMINDER_MAIL Mahnung versendet (E-Mail)
REMINDER_ERROR_MAIL Mahnung: Fehler beim Versenden (E-Mail)
REMINDER_LETTER Mahnung versendet (Post)
REMINDER_FAX Mahnung versendet (Fax)
REMINDER_SIGN Mahnung signiert
REMINDER_SIGN_MAIL Mahnung signiert verschickt
REMINDER_CANCEL Mahnung storniert
REMINDER_DELETE Mahnung gelöscht

Kommentar erstellen

POST /api/invoice-comments
XML-Element Beschreibung Typ Default-Wert Pflichtfeld
invoice_id ID der Rechnung INT ja
comment Kommentar ALNUM ja
public Soll das Kommentar im Kundenportal angezeigt werden (0 = nein, 1 = ja)? BOOL 0 nein 
<invoice-comment>
    <invoice_id>1</invoice_id>
    <comment>Kunde will nächste Woche bezahlen</comment>
</invoice-comment>

<?xml version="1.0" encoding="UTF-8"?>
<invoice-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <invoice_id type="integer">1</invoice_id>
    <user_id type="integer">1</user_id>
    <comment>Kunde will nächste Woche bezahlen</comment>
    <actionkey>COMMENT</actionkey>
    <public>0</public>
</invoice-comment>

Kommentar löschen

DELETE /api/invoice-comments/{id}