Search Knowledge Base Articles

API Guide Items- Credit_Notes - Add New Credit Notes

Credit_Notes - Add New Credit Notes

POST yourdomain.com/api/credit_notes

Header

json
Field Type Description
Authorization String

Basic Access Authentication token.

Parameter

json
Field Type Description
clientid Number

Mandatory. Customer id
date Date

Mandatory. Credit Note Date
number Number

Mandatory. Credit Note Number
currency Number

Mandatory. currency field
newitems Array

Mandatory. New Items to be added
billing_street String

Optional. Street Address
billing_city (optional) String

Optional. City Name for billing
billing_state (optional) String

Optional. Name of state for billing
billing_zip (optional) Number

Optional. Zip code
billing_country (optional) Number

Optional. Country code
shipping_street (optional) String

Optional. Address of shipping
shipping_city (optional) String

Optional. City name for shipping
shipping_state (optional) String

Optional. Name of state for shipping
shipping_zip (optional) Number

Optional. Zip code for shipping
shipping_country (optional) Number

Optional. Country code
discount_type (optional) String

Optional. before_tax / after_tax discount type
Admin (optional) String

Note] Optional. Admin Note
subtotal Decimal

Mandatory. calculation based on item Qty, Rate and Tax
total Decimal

Mandatory. calculation based on subtotal, Discount and
clientnote (optional) String

Optional. client notes
terms (optional) String

Optional. Terms

Success 200

json
Field Type Description
status Boolean

Request status.
message String

Credit Note Added Successfully

Error 4xx

json
Name Type Description
status Boolean

Request status.
message String

Credit Note add fail
newitems[] String

The Items field is required
number String

The Credit Note number is already in use
subtotal String

The Sub Total field is required
total String

The Total field is required
  • Success-Response:
HTTP/1.1 200 OK
{
  "status": true,
  "message": "Credit Note Added Successfully"
}
  • Error-Response: 
    HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Credit Note Add Fail"
}
  • Error-Response: 
       HTTP/1.1 409 Conflict
    {
      "status": false,
      "error": {
			"number":"The Credit Note number is already in use"
		},
		"message": "The Credit Note number is already in use"
    }
  • Error-Response: 
      HTTP/1.1 404 Not Found
   {
	    "status": false,
	    "error": {
	        "newitems[]": "The Items field is required"
	    },
	    "message": "<p>The Items field is required</p>\n"
	}
  • Error-Response: 
      HTTP/1.1 404 Not Found
   {
	    "status": false,
	    "error": {
	        "subtotal": "The Sub Total field is required"
	    },
	    "message": "<p>The Sub Total field is required</p>\n"
	}
  • Error-Response:
  HTTP/1.1 404 Not Found
   {
	    "status": false,
	    "error": {
	        "total": "The Total field is required"
	    },
	    "message": "<p>The Total field is required</p>\n"
	}

Did you find this article useful?

Related Articles