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
actionkeyBeschreibung
COMMENTein durch den Nutzer erstellter Kommentar
CREATEerstellen
COPYKopie
CREATE_FROM_OFFERerstellt aus Angebot
CREATE_FROM_INVOICEerstellt als Korrektur einer Rechnung
CREATE_FROM_RECURRINGAbo-Rechnung
STATUSStatusänderungen
PAYMENTZahlungen gebucht
PAYMENT_ERRORFehler bei Zahlungen
DELETE_PAYMENTZahlung gelöscht
MAILVersenden (E-Mail)
LETTERVersenden (Post)
FAXVersenden (Fax)
SIGNsignieren
SIGN_MAILsigniert verschickt
CANCELstornieren
ERROR_MAILFehler beim Versenden (E-Mail)
CREATE_CREDIT_NOTEGutschrift erzeugt
REMINDER_CREATEMahnung erstellt
REMINDER_STATUSMahnung: Statusänderungen
REMINDER_MAILMahnung versendet (E-Mail)
REMINDER_ERROR_MAILMahnung: Fehler beim Versenden (E-Mail)
REMINDER_LETTERMahnung versendet (Post)
REMINDER_FAXMahnung versendet (Fax)
REMINDER_SIGNMahnung signiert
REMINDER_SIGN_MAILMahnung signiert verschickt
REMINDER_CANCELMahnung storniert
REMINDER_DELETEMahnung gelöscht

Kommentar erstellen

POST /api/invoice-comments
XML-ElementBeschreibungTypDefault-WertPflichtfeld
invoice_idID der RechnungINTja
commentKommentarALNUMja
publicSoll das Kommentar im Kundenportal angezeigt werden (0 = nein, 1 = ja)?BOOL0nein
<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}