Top

CreditNotes

List creditnote settings
GET /settings/creditnotes
List of settings applied for creditnotes.
Update creditnote settings
PUT /settings/creditnotes
Update the settings associated to creditnotes.
Get creditnote notes and terms
GET /settings/creditnotes/notesandterms
Get the contents of creditnote notes and terms.
Update creditnote notes and terms
PUT /settings/creditnotes/notesandterms
Update the notes and terms field for creditnotes.

List creditnote settings

GET  /settings/creditnotes

List of settings applied for creditnotes.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "creditnote_settings": {
    "auto_generate": true,
    "prefix_string": "CN-",
    "reference_text": "",
    "next_number": "00005",
    "notes": "",
    "terms": ""
  }
}

Update creditnote settings

PUT  /settings/creditnotes

Update the settings associated to creditnotes.

Request attributes

auto_generate boolean To enable or disable auto number generation.
prefix_string string
[50]
Prefix string for entity auto number generation.
reference_text string
[100]
Label for the reference number.
next_number string
[100]
Number that will be next updated while creating an entity.
notes string
[5000]
Notes to the customer.
terms string
[10000]
Terms and conditions.

Sample Request

{
  "auto_generate": true,
  "prefix_string": "CN-",
  "reference_text": "",
  "next_number": "00005",
  "notes": "",
  "terms": ""
}

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Your credit note preferences have been saved.",
  "creditnote_settings": {
    "auto_generate": true,
    "prefix_string": "CN-",
    "reference_text": "",
    "next_number": "00005",
    "notes": "",
    "terms": ""
  }
}

Get creditnote notes and terms

GET  /settings/creditnotes/notesandterms

Get the contents of creditnote notes and terms.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "notes_and_terms": {
    "notes": "",
    "terms": ""
  }
}

Update creditnote notes and terms

PUT  /settings/creditnotes/notesandterms

Update the notes and terms field for creditnotes.

Request attributes

notes string
[5000]
Notes to the customer.
terms string
[10000]
Terms and conditions.

Sample Request

{
      "notes": "",
      "terms": "Terms and Conditions"
    }

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "Your credit note preferences have been saved.",
      "notes_and_terms": {
        "notes": "",
        "terms": "Terms and Conditions"
      }
    }