Alle Kommentare einer Gutschrift auflisten

GET /api/credit-note-comments?credit_note_id={credit_note_id}

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

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

Einzelnen Kommentar aufrufen

GET /api/credit-note-comments/{id}
<?xml version="1.0" encoding="UTF-8"?>
<credit-note-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <credit_note_id type="integer">1</credit_note_id>
    <user_id type="integer">1</user_id>
    <comment>Gutschrift erstellt.</comment>
    <actionkey>CREATED</actionkey>
    <public>0</public>
</credit-note-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/credit-note-comments?credit_note_id={credit_note_id}&actionkey=CREATE,COPY
actionkeyBeschreibung
COMMENTein durch den Nutzer erstellter Kommentar
CREATEerstellen
CREATE_FROM_INVOICEerstellt aus einer Rechnung
COPYKopie
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)

Kommentar erstellen

POST /api/credit-note-comments
XML-ElementBeschreibungTypDefault-WertPflichtfeld
credit_note_idID der GutschriftINTja
commentKommentarALNUMja
publicSoll das Kommentar im Kundenportal angezeigt werden (0 = nein, 1 = ja)?BOOL0nein
<credit-note-comment>
    <credit_note_id>1</credit_note_id>
    <comment>Aus Kulanz</comment>
</credit-note-comment>
<?xml version="1.0" encoding="UTF-8"?>
<credit-note-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <credit_note_id type="integer">1</credit_note_id>
    <user_id type="integer">1</user_id>
    <comment>Aus Kulanz</comment>
    <actionkey>COMMENT</actionkey>
    <public>0</public>
</credit-note-comment>

Kommentar löschen

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