Dein Wohlfühlpaket für´s Homeoffice: Sichere Dir jetzt 50% Rabatt mit dem Code Feb_50_2021 auf den Tarif Deiner Wahl.
GET /api/credit-note-comments?credit_note_id={credit_note_id}
Comments can only be returned for a particular credit note.
Therefore credit_note_id is a mandatory parameter.
<?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>
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>Credit note created.</comment> <actionkey>CREATED</actionkey> <public>0</public> </credit-note-comment>
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/credit-note-comments?credit_note_id={credit_note_id}&actionkey=CREATE,COPY
actionkey | Description |
---|---|
COMMENT | a comment that was entered by the user |
CREATE | created |
CREATE_FROM_INVOICE | created from an invoice |
COPY | copied |
STATUS | status changed |
PAYMENT | payment received |
PAYMENT_ERROR | payment error |
DELETE_PAYMENT | payment deleted |
sent (e-mail) | |
LETTER | sent (letter) |
FAX | sent (fax) |
SIGN | signed |
SIGN_MAIL | send signed |
CANCEL | canceled |
ERROR_MAIL | e-mail error |
POST /api/credit-note-comments
XML element | Description | Type | Default value | Mandatory |
---|---|---|---|---|
credit_note_id | ID of the credit 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 |
<credit-note-comment> <credit_note_id>1</credit_note_id> <comment>Out of fairness</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>Out of fairness</comment> <actionkey>COMMENT</actionkey> <public>0</public> </credit-note-comment>
DELETE /api/credit-note-comments/{id}