Top

Comments & History

List credit note comments & history
GET /creditnotes/:creditnote_id/comments
Get history and comments of a credit note.
Add a comment
POST /creditnotes/:creditnote_id/comments
Add a comment to an existing credit note.
Delete a comment
DELETE /creditnotes/:creditnote_id/comments/:comment_id
Delete a credit note comment.

List credit note comments & history

GET  /creditnotes/:creditnote_id/comments

Get history and comments of a credit note.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "comments": [
    {
      "comment_id": "982000000570001",
      "creditnote_id": "982000000567134",
      "description": "Creditnotes emailed to Bowman & Co",
      "commented_by_id": "982000000554041",
      "commented_by": "John David",
      "comment_type": "system",
      "date": "2013-11-18",
      "date_description": "7 hours ago",
      "time": "10:43 PM",
      "operation_type": "Updated",
      "transaction_id": "",
      "transaction_type": "email"
    },
    {
      "comment_id": "982000000567176",
      "creditnote_id": "982000000567134",
      "description": "Credits applied to invoice INV-00001",
      "commented_by_id": "982000000554041",
      "commented_by": "John David",
      "comment_type": "system",
      "date": "2013-11-18",
      "date_description": "yesterday",
      "time": "2:37 AM",
      "operation_type": "Added",
      "transaction_id": "982000000567172",
      "transaction_type": "creditnote_invoice"
    },
    {
      "comment_id": "982000000567160",
      "creditnote_id": "982000000567134",
      "description": "Credits refunded",
      "commented_by_id": "982000000554041",
      "commented_by": "John David",
      "comment_type": "system",
      "date": "2013-11-18",
      "date_description": "yesterday",
      "time": "2:35 AM",
      "operation_type": "Added",
      "transaction_id": "982000000567158",
      "transaction_type": "creditnote_refund"
    },
    {
      "comment_id": "982000000567136",
      "creditnote_id": "982000000567134",
      "description": "Creditnotes created",
      "commented_by_id": "982000000554041",
      "commented_by": "John David",
      "comment_type": "system",
      "date": "2013-11-18",
      "date_description": "yesterday",
      "time": "2:33 AM",
      "operation_type": "Added",
      "transaction_id": "",
      "transaction_type": "creditnote"
    }
  ]
}

Add a comment

POST  /creditnotes/:creditnote_id/comments

Add a comment to an existing credit note.

Request attributes

description string
[2000]
Description for the refund recorded.

Sample Request

{
      "description": "Credits applied to invoice INV-00004"
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Comments added."
}

Delete a comment

DELETE  /creditnotes/:creditnote_id/comments/:comment_id

Delete a credit note comment.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The comment has been deleted."
}