API Docs
/
No Results Found
Credit Notes

Credit Notes

A credit note is a promisory note issued to a person, when we owe him money. Credit notes are created when a refund is to be made to a customer. A credit note object allows you to keep track of all credit note related information.

Possible error codes:
Error CodeMessage
1002Credit Note does not exists
12003Credit notes that are in closed status cannot be applied to invoices
12004Credit notes that are in void status cannot be applied to invoices
12005Credits cannot be applied to invoices in the draft status
12006Credits cannot be applied to invoices in the closed status
12007Credits cannot be applied to invoices in the void status
12018The specified Credit Note Number already exists

End Points
Create a credit note
List Credit Notes
Update a credit note
Get a credit note
Delete a credit note
Email a credit note
Void a credit note
Open a voided credit note
Email history
Update billing address
Update Shipping address
List credit note templates
Update a credit note template
Credit to an invoice
List invoices credited
Delete invoices credited
Add a comment
List credit note comments & history
Delete a Comment
List credit note refunds
Refund credit note
List refunds of a credit note
Update credit note refund
Get credit note refund
Delete credit note refund

Attribute

creditnote_id
string
Unique ID of the credit note generated by the server.
creditnote_number
string
Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Maximum Length [100]
date
string
The date on which credit note is raised. Date Format [yyyy-mm-dd]
status
string
Status of the credit note. This can be open, closed or void.
customer_id
string
Customer ID of the customer for whom the credit note is raised.
product_type
string
Enter goods/services
serial_numbers
string
Enter serial number
customer_name
string
Name of the customer to whom the credit note is raised. Maximum Length of the name [100]
custom_fields
array
Custom fields for a credit note.
Show Sub-Attributes arrow
customfield_id
long
Unique ID of the custom field
data_type
string
Data type of the custom field.
label
string
Label of the custom field.
show_on_pdf
boolean
Enable/Disable show this custom field on pdf for that invoice
show_in_all_pdf
Enable/Disable show this custom field on all the pdf
value
string
Value of the custom field.
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Maximum Length [100]
email
string
Email address of the customer.
total
double
Total credits raised in this credit note.
balance
double
The unapplied/existing credits.
line_items
array
Items present in a credit note
Show Sub-Attributes arrow
item_id
string
Unique string generated for the item to which a refund is to be made.
description
string
A small description about the item.
name
string
Name of the credit note item.
type
integer
Type of the creditnote line item.
quantity
int32
Quantity of the item included.
tax_id
string
Unique to denote the tax associate dto the creditnote
rate
double
The rate of the item included.
item_total
double
Total credits raised by this item. This would be the multiplicative product of item price and quantity.
product_type
string
Enter goods/services
hsn_or_sac
string
🇮🇳 India
only
Add HSN/SAC code for your goods/services
project_id
string
ID of the project
project_name
string
Name of the project.
invoices
array
Invoices included for a credit note redemption
Show Sub-Attributes arrow
invoice_id
string
Invoice ID of the required invoice.
invoice_number
string
Invoice number of the required invoice.
amount
double
Amount of the invoice.
taxes
array
Taxes associated with the subscription.
Show Sub-Attributes arrow
tax_id
string
Unique to denote the tax associate dto the creditnote
tax_name
string
Unique name for tax.
tax_amount
string
Tax amount applied to the subscription.
currency_code
string
Customer's currency code. This currency code is used in credit notes.
currency_symbol
string
Customer's currency symbol.
billing_address
object
Address to which a customer is billed
Show Sub-Attributes arrow
address
string
Billing address for the invoice
city
string
City of the customer’s billing address.
state
string
State of the customer’s billing address.
zip
string
Zip code of the customer’s billing address.
country
string
Country of the customer’s billing address.
fax
string
Customer's fax number.
shipping_address
object
Address to which goods/any exchange must be shipped to contact
Show Sub-Attributes arrow
address
string
Billing address for the invoice
city
string
City of the customer’s billing address.
state
string
State of the customer’s billing address.
zip
string
Zip code of the customer’s billing address.
country
string
Country of the customer’s billing address.
fax
string
Customer's fax number.
created_time
string
Time at which the credit note was created.
updated_time
string
Time at which the credit note details were last updated.
template_id
string
Unique ID of the creditnote template used
template_name
string
Name of the default template of the creditnote used
notes
string
A short note for the credit note. Maximum length [5000]
terms
string
Terms & condition to be displayed in the credit note. Maximum length [10000]

Example

{ "creditnote_id": "90300000072369", "creditnote_number": "CN-29", "date": "2016-06-05", "status": "open", "customer_id": "903000000000099", "product_type": "goods", "serial_numbers": "string", "customer_name": "Bowman Furniture", "custom_fields": [ { "customfield_id": 439910000000236000, "data_type": "text", "label": "label", "show_on_pdf": true, "show_in_all_pdf": true, "value": 129890 } ], "reference_number": "INV-384", "email": "test@zylker.org", "total": 450, "balance": 10, "line_items": [ { "item_id": "90300000081501", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "name": "Hard Drive", "type": 1, "quantity": 1, "tax_id": "903000000000356", "rate": 100, "item_total": 100, "product_type": "goods", "hsn_or_sac": 80540, "project_id": 90300000087378, "project_name": "Sample Project" } ], "invoices": [ { "invoice_id": "90300000079426", "invoice_number": "INV-384", "amount": 450 } ], "taxes": [ { "tax_id": "903000000000356", "tax_name": "Basic Tax", "tax_amount": "2.50" } ], "currency_code": "USD", "currency_symbol": "$", "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "created_time": "2016-06-05T02:30:08-0700", "updated_time": "2016-07-05T02:30:08-0700", "template_id": "90300000001336", "template_name": "Standard Template", "notes": "Offer for the referral", "terms": "Can be added for refund only if purchased again" }

Create a credit note

Details of an existing creditnote.
oauthscope : ZohoInvoice.creditnotes.CREATE

Arguments

customer_id
string
(Required)
Customer ID of the customer for whom the credit note is raised.
contact_persons
array
Contact Persons associated with the credit note.
date
string
(Required)
The date on which credit note is raised. Date Format [yyyy-mm-dd]
exchange_rate
string
Exchange rate for the currency associated with the customer.
line_items
array
(Required)
Items present in a credit note
Show Sub-Attributes arrow
item_id
string
Unique string generated for the item to which a refund is to be made.
description
string
A small description about the item.
name
string
Name of the credit note item.
type
integer
Type of the creditnote line item.
quantity
int32
Quantity of the item included.
tax_id
string
Unique to denote the tax associate dto the creditnote
tax_exemption_id
string
🇮🇳 India
, 🇺🇸 United States
, 🇨🇦 Canada
only
Unique ID of the tax exemption.
avatax_tax_code
string
Avalara Integration only
A tax code is a unique label used to group Items (products, services, or charges) together. Maximum length [25]
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]
rate
double
The rate of the item included.
item_total
double
Total credits raised by this item. This would be the multiplicative product of item price and quantity.
product_type
string
Enter goods/services
hsn_or_sac
string
🇮🇳 India
only
Add HSN/SAC code for your goods/services
project_id
string
ID of the project
creditnote_number
string
(Required)
Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Maximum Length [100]
gst_treatment
string
🇮🇳 India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
gst_no
string
🇮🇳 India
only
15 digit GST identification number of the customer.
place_of_supply
string
🇮🇳 India
only
Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
ignore_auto_number_generation
boolean
Set to true if you need to provide your own credit note number.
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Maximum Length [100]
custom_fields
array
Custom fields for a credit note.
Show Sub-Attributes arrow
label
string
Label of the custom field.
value
string
Value of the custom field.
notes
string
A short note for the credit note. Maximum length [5000]
terms
string
Terms & condition to be displayed in the credit note. Maximum length [10000]
template_id
string
Unique ID of the creditnote template used
tax_authority_id
string
🇺🇸 United States
, 🇨🇦 Canada
only
Unique ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_exemption_id
string
🇮🇳 India
, 🇺🇸 United States
, 🇨🇦 Canada
only
Unique ID of the tax exemption.
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]
avatax_tax_code
string
Avalara Integration only
A tax code is a unique label used to group Items (products, services, or charges) together. Maximum length [25]
avatax_exempt_no
string
Avalara Integration only
Exemption certificate number of the customer. Maximum length [25]
vat_treatment
string
🇬🇧 United Kingdom
only
(Optional) VAT treatment for the credit notes. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).

Query Parameters

invoice_id
Invoice ID of the required invoice.
ignore_auto_number_generation
Set to true if you need to provide your own credit note number.

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "customer_id": "903000000000099", "contact_persons": [ "903000006532" ], "date": "2016-06-05", "exchange_rate": "5.5", "line_items": [ { "item_id": "90300000081501", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "name": "Hard Drive", "type": 1, "quantity": 1, "tax_id": "903000000000356", "tax_exemption_id": "903000006345", "avatax_tax_code": "string", "avatax_use_code": "string", "rate": 100, "item_total": 100, "product_type": "goods", "hsn_or_sac": 80540, "project_id": 90300000087378 } ], "creditnote_number": "CN-29", "gst_treatment": "business_gst", "gst_no": "22AAAAA0000A1Z5", "place_of_supply": "TN", "ignore_auto_number_generation": false, "reference_number": "INV-384", "custom_fields": [ { "label": "label", "value": 129890 } ], "notes": "Offer for the referral", "terms": "Can be added for refund only if purchased again", "template_id": "90300000001336", "tax_authority_id": "903000006345", "tax_exemption_id": "903000006345", "avatax_use_code": "string", "avatax_tax_code": "string", "avatax_exempt_no": "string", "vat_treatment": "overseas" }

Response Example

{ "code": 0, "message": "The credit note has been created.", "creditnote": { "creditnote_id": "90300000072369", "creditnote_number": "CN-29", "date": "2016-06-05", "status": "open", "customer_id": "903000000000099", "product_type": "goods", "serial_numbers": "string", "customer_name": "Bowman Furniture", "custom_fields": [ { "customfield_id": 439910000000236000, "data_type": "text", "label": "label", "show_on_pdf": true, "show_in_all_pdf": true, "value": 129890 } ], "reference_number": "INV-384", "email": "test@zylker.org", "total": 450, "balance": 10, "line_items": [ { "item_id": "90300000081501", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "name": "Hard Drive", "type": 1, "quantity": 1, "tax_id": "903000000000356", "rate": 100, "item_total": 100, "product_type": "goods", "hsn_or_sac": 80540, "project_id": 90300000087378, "project_name": "Sample Project" } ], "invoices": [ { "invoice_id": "90300000079426", "invoice_number": "INV-384", "amount": 450 } ], "taxes": [ { "tax_id": "903000000000356", "tax_name": "Basic Tax", "tax_amount": "2.50" } ], "currency_code": "USD", "currency_symbol": "$", "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "created_time": "2016-06-05T02:30:08-0700", "updated_time": "2016-07-05T02:30:08-0700", "template_id": "90300000001336", "template_name": "Standard Template", "notes": "Offer for the referral", "terms": "Can be added for refund only if purchased again" } }

List Credit Notes

List all the Credit Notes.
oauthscope : ZohoInvoice.creditnotes.READ

Query Parameters

creditnote_number
Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Maximum Length [100]
date
The date on which credit note is raised. Date Format [yyyy-mm-dd]
status
Status of the credit note. This can be open, closed or void.
total
Total credits raised in this credit note.
reference_number
Reference number generated for the payment. A string of your choice can also be used as the reference number. Maximum Length [100]
customer_name
Name of the customer to whom the credit note is raised. Maximum Length of the name [100]
item_name
Search credit notes by item name. Maximum length [100]
customer_id
Customer ID of the customer for whom the credit note is raised.
item_description
description for the item. Variants item_description_startswith and item_description_contains. Maximum length [100]
item_id
Unique string generated for the item to which a refund is to be made.
filter_by
Filter credit notes by status. Allowed values Status.All Status.Open Status.Draft Status.Closed and Status.Void
search_text
Search credit notes by credit note number or customer name or credit note reference number. Maximum length [100]
sort_column
Sort credit notes by following columns customer_name, creditnote_number, balance, total, date and created_time. Allowed Values customer_name creditnote_number balance total date and created_time

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "creditnotes": [ { "creditnote_id": "90300000072369", "creditnote_number": "CN-29", "status": "open", "reference_number": "INV-384", "date": "2016-06-05", "total": 450, "balance": 10, "customer_id": "903000000000099", "customer_name": "Bowman Furniture", "currency_id": "982000000567240", "currency_code": "USD", "created_time": "2016-06-05T02:30:08-0700", "last_modified_time": "2016-06-05T02:30:08-0700", "is_emailed": true }, {...}, {...} ] }

Update a credit note

Update Details of an existing creditnote.
oauthscope : ZohoInvoice.creditnotes.UPDATE

Arguments

customer_id
string
(Required)
Customer ID of the customer for whom the credit note is raised.
contact_persons
array
Contact Persons associated with the credit note.
date
string
(Required)
The date on which credit note is raised. Date Format [yyyy-mm-dd]
exchange_rate
string
Exchange rate for the currency associated with the customer.
line_items
array
(Required)
Items present in a credit note
Show Sub-Attributes arrow
item_id
string
Unique string generated for the item to which a refund is to be made.
description
string
A small description about the item.
name
string
Name of the credit note item.
type
integer
Type of the creditnote line item.
quantity
int32
Quantity of the item included.
tax_id
string
Unique to denote the tax associate dto the creditnote
tax_exemption_id
string
🇮🇳 India
, 🇺🇸 United States
, 🇨🇦 Canada
only
Unique ID of the tax exemption.
avatax_tax_code
string
Avalara Integration only
A tax code is a unique label used to group Items (products, services, or charges) together. Maximum length [25]
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]
rate
double
The rate of the item included.
item_total
double
Total credits raised by this item. This would be the multiplicative product of item price and quantity.
product_type
string
Enter goods/services
hsn_or_sac
string
🇮🇳 India
only
Add HSN/SAC code for your goods/services
project_id
string
ID of the project
creditnote_number
string
(Required)
Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Maximum Length [100]
gst_treatment
string
🇮🇳 India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
gst_no
string
🇮🇳 India
only
15 digit GST identification number of the customer.
place_of_supply
string
🇮🇳 India
only
Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
ignore_auto_number_generation
boolean
Set to true if you need to provide your own credit note number.
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Maximum Length [100]
custom_fields
array
Custom fields for a credit note.
Show Sub-Attributes arrow
label
string
Label of the custom field.
value
string
Value of the custom field.
notes
string
A short note for the credit note. Maximum length [5000]
terms
string
Terms & condition to be displayed in the credit note. Maximum length [10000]
template_id
string
Unique ID of the creditnote template used
tax_authority_id
string
🇺🇸 United States
, 🇨🇦 Canada
only
Unique ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_exemption_id
string
🇮🇳 India
, 🇺🇸 United States
, 🇨🇦 Canada
only
Unique ID of the tax exemption.
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]
avatax_tax_code
string
Avalara Integration only
A tax code is a unique label used to group Items (products, services, or charges) together. Maximum length [25]
avatax_exempt_no
string
Avalara Integration only
Exemption certificate number of the customer. Maximum length [25]
vat_treatment
string
🇬🇧 United Kingdom
only
(Optional) VAT treatment for the credit notes. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).

Query Parameters

ignore_auto_number_generation
Set to true if you need to provide your own credit note number.

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id} -X PUT -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "customer_id": "903000000000099", "contact_persons": [ "903000006532" ], "date": "2016-06-05", "exchange_rate": "5.5", "line_items": [ { "item_id": "90300000081501", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "name": "Hard Drive", "type": 1, "quantity": 1, "tax_id": "903000000000356", "tax_exemption_id": "903000006345", "avatax_tax_code": "string", "avatax_use_code": "string", "rate": 100, "item_total": 100, "product_type": "goods", "hsn_or_sac": 80540, "project_id": 90300000087378 } ], "creditnote_number": "CN-29", "gst_treatment": "business_gst", "gst_no": "22AAAAA0000A1Z5", "place_of_supply": "TN", "ignore_auto_number_generation": false, "reference_number": "INV-384", "custom_fields": [ { "label": "label", "value": 129890 } ], "notes": "Offer for the referral", "terms": "Can be added for refund only if purchased again", "template_id": "90300000001336", "tax_authority_id": "903000006345", "tax_exemption_id": "903000006345", "avatax_use_code": "string", "avatax_tax_code": "string", "avatax_exempt_no": "string", "vat_treatment": "overseas" }

Response Example

{ "code": 0, "message": "The credit note has been updated.", "creditnote": { "creditnote_id": "90300000072369", "creditnote_number": "CN-29", "date": "2016-06-05", "status": "open", "customer_id": "903000000000099", "product_type": "goods", "serial_numbers": "string", "customer_name": "Bowman Furniture", "custom_fields": [ { "customfield_id": 439910000000236000, "data_type": "text", "label": "label", "show_on_pdf": true, "show_in_all_pdf": true, "value": 129890 } ], "reference_number": "INV-384", "email": "test@zylker.org", "total": 450, "balance": 10, "line_items": [ { "item_id": "90300000081501", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "name": "Hard Drive", "type": 1, "quantity": 1, "tax_id": "903000000000356", "rate": 100, "item_total": 100, "product_type": "goods", "hsn_or_sac": 80540, "project_id": 90300000087378, "project_name": "Sample Project" } ], "invoices": [ { "invoice_id": "90300000079426", "invoice_number": "INV-384", "amount": 450 } ], "taxes": [ { "tax_id": "903000000000356", "tax_name": "Basic Tax", "tax_amount": "2.50" } ], "currency_code": "USD", "currency_symbol": "$", "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "created_time": "2016-06-05T02:30:08-0700", "updated_time": "2016-07-05T02:30:08-0700", "template_id": "90300000001336", "template_name": "Standard Template", "notes": "Offer for the referral", "terms": "Can be added for refund only if purchased again" } }

Get a credit note

Details of an existing creditnote.
oauthscope : ZohoInvoice.creditnotes.READ

Query Parameters

print
Export credit note pdf with default print option. Allowed Values: true, false, on and off
accept
You can get credit note details as json/pdf/html. Default format is html. Allowed Values: json, pdf and html

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id} -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "creditnote": { "creditnote_id": "90300000072369", "creditnote_number": "CN-29", "date": "2016-06-05", "status": "open", "customer_id": "903000000000099", "product_type": "goods", "serial_numbers": "string", "customer_name": "Bowman Furniture", "custom_fields": [ { "customfield_id": 439910000000236000, "data_type": "text", "label": "label", "show_on_pdf": true, "show_in_all_pdf": true, "value": 129890 } ], "reference_number": "INV-384", "email": "test@zylker.org", "total": 450, "balance": 10, "line_items": [ { "item_id": "90300000081501", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "name": "Hard Drive", "type": 1, "quantity": 1, "tax_id": "903000000000356", "rate": 100, "item_total": 100, "product_type": "goods", "hsn_or_sac": 80540, "project_id": 90300000087378, "project_name": "Sample Project" } ], "invoices": [ { "invoice_id": "90300000079426", "invoice_number": "INV-384", "amount": 450 } ], "taxes": [ { "tax_id": "903000000000356", "tax_name": "Basic Tax", "tax_amount": "2.50" } ], "currency_code": "USD", "currency_symbol": "$", "created_time": "2016-06-05T02:30:08-0700", "updated_time": "2016-07-05T02:30:08-0700", "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "template_id": "90300000001336", "template_name": "Standard Template", "notes": "Offer for the referral", "terms": "Can be added for refund only if purchased again" } }

Delete a credit note

Delete an existing credit note.
oauthscope : ZohoInvoice.creditnotes.DELETE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id} -X DELETE -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The credit note has been deleted." }

Email a credit note

Email a credit note.
oauthscope : ZohoInvoice.creditnotes.CREATE

Arguments

to_mail_ids
array
(Required)
The email IDs to which the credit note is to be mailed.
cc_mail_ids
array
The email IDs that have to be copied when the credit note is to be mailed.
subject
string
(Required)
The subject of the email. Maximum length [1000]
body
string
(Required)
The body/content of the email. Maximum length [5000]

Query Parameters

customer_id
Customer ID of the customer for whom the credit note is raised.
attachments
The files to be attached with the email.

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/email -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "to_mail_ids": [ "test@zylker.org", "test1@zylker.org" ], "cc_mail_ids": [ "test@zylker.org" ], "subject": "Credit note for subscription.", "body": "Please find attached the credit note for your subscription." }

Response Example

{ "code": 0, "message": "Your creditnote has been sent." }

Void a credit note

To mark a credit note as invalid/nullify it content.
oauthscope : ZohoInvoice.creditnotes.CREATE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/void -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The credit note has been marked as void." }

Open a voided credit note

Convert a voided credit note to open.
oauthscope : ZohoInvoice.creditnotes.CREATE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/converttoopen -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "Status of the credit note has been changed to open." }

Email history

Get email history of a credit code.
oauthscope : ZohoInvoice.creditnotes.READ

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/emailhistory -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "email_history": [ { "mailhistory_id": 982000000570005, "from": "gator@zillum.com", "to_mail_ids": [ "test@zylker.org", "test1@zylker.org" ], "subject": "Credit note for subscription.", "date": "2016-06-05" }, {...}, {...} ] }

Update billing address

Updates the billing address for an existing credit note alone.
oauthscope : ZohoInvoice.creditnotes.UPDATE

Arguments

address
string
Billing address of the contact
city
string
City of the contact
state
string
State of the contact's address
zip
string
ZIP code of a contacts billing address
country
string
Country of a contact's billing address
fax
string
FAX number of a contact

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/address/billing -X PUT -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "USA", "fax": "+1-925-924-9600" }

Response Example

{ "code": 0, "message": "Billing address updated" }

Update Shipping address

Updates the shipping address for an existing credit note alone.
oauthscope : ZohoInvoice.creditnotes.UPDATE

Arguments

address
string
Billing Address field
city
string
City of a contacts billing address
state
string
State of a contct's billing address
zip
string
ZIP code of a billing address
country
string
Country of a contacts billing address
fax
string
Customer's fax number.

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/address/shipping -X PUT -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "address": "Suite 125, McMillan Avenue", "city": "San Francisco", "state": "CA", "zip": 94134, "country": "USA", "fax": "+1-925-924-9600" }

Response Example

{ "code": 0, "message": "Shipping address updated" }

List credit note templates

Get all credit note pdf templates.
oauthscope : ZohoInvoice.creditnotes.READ

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/templates -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "templates": [ { "template_name": "Standard Template", "template_id": "90300000001336", "template_type": "professional" }, {...}, {...} ] }

Update a credit note template

Update the pdf template associated with the credit note.
oauthscope : ZohoInvoice.creditnotes.UPDATE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/templates/{template_id} -X PUT -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The credit note has been updated." }

Credit to an invoice

Apply credit note to existing invoices.
oauthscope : ZohoInvoice.creditnotes.CREATE

Arguments

invoices
array
List of invoices used for a credit redemption
Show Sub-Attributes arrow
invoice_id
string
Invoice ID of the required invoice.
amount_applied
double
The total amount applied for redemption from the credit note on an invoice.

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/invoices -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "invoices": [ { "invoice_id": "90300000079426", "amount_applied": 41.82 } ] }

Response Example

{ "code": 0, "message": "Credits have been applied to the invoice(s)." }

List invoices credited

List invoices to which the credit note is applied.
oauthscope : ZohoInvoice.creditnotes.READ

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/invoices -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "invoices_credited": [ { "creditnote_id": "90300000072369", "invoice_id": "90300000079426", "creditnote_invoice_id": "982000000567172", "date": "2016-06-05", "invoice_number": "INV-384", "creditnote_number": "CN-29", "credited_amount": 12.02 }, {...}, {...} ] }

Delete invoices credited

Delete the credits applied to an invoice.
oauthscope : ZohoInvoice.creditnotes.DELETE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/invoices/{creditnote_invoice_id} -X DELETE -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "Credits applied to an invoice have been deleted." }

Add a comment

Add a comment to an existing credit note.
oauthscope : ZohoInvoice.creditnotes.CREATE

Arguments

description
string
A short note on the credit applied

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/comments -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

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

Response Example

{ "code": 0, "message": "Comments added." }

List credit note comments & history

Get history and comments of a credit note.
oauthscope : ZohoInvoice.creditnotes.READ

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/comments -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "Comments of the credit note are displayed successfully.", "comments": [ { "comment_id": "982000000570001", "creditnote_id": "90300000072369", "description": "Credits applied to invoice INV-00004", "commented_by_id": "982000000554041", "commented_by": "David Sujin", "comment_type": "system", "date": "2016-06-05", "date_description": "7 hours ago", "time": "10:43 PM", "operation_type": "Updated", "transaction_id": "903000002072369", "transaction_type": "email" }, {...}, {...} ] }

Delete a Comment

Delete a credit note comment.
oauthscope : ZohoInvoice.creditnotes.DELETE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/comments/{comment_id} -X DELETE -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The comment has been deleted." }

List credit note refunds

List all refunds with pagination.
oauthscope : ZohoInvoice.creditnotes.READ

Query Parameters

customer_id
Customer ID of the customer for whom the credit note is raised.
sort_column
Sort refunds list. Allowed Values: refund_mode, reference_number, date, creditnote_number, customer_name, amount_bcy and amount_fcy

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/refunds -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The list of credit note refunds are displayed successfully.", "creditnote_refunds": [ { "creditnote_refund_id": "982000000567158", "creditnote_id": "90300000072369", "date": "2016-06-05", "refund_mode": "cash", "reference_number": "INV-384", "creditnote_number": "CN-29", "customer_name": "Bowman Furniture", "description": "Offer", "amount_bcy": 10, "amount_fcy": 10 }, {...}, {...} ] }

Refund credit note

Refund credit note amount.
oauthscope : ZohoInvoice.creditnotes.CREATE

Arguments

date
string
The date on which credit note is raised. Date Format [yyyy-mm-dd]
refund_mode
string
The method of refund.
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Maximum Length [100]
amount
double
Amount of the invoice.
exchange_rate
string
Exchange rate for the currency associated with the customer.
description
string
A small description about the item.

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/refunds -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "date": "2016-06-05", "refund_mode": "cash", "reference_number": "INV-384", "amount": 450, "exchange_rate": "5.5", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case." }

Response Example

{ "code": 0, "message": "The credit note amount is refunded successfully.", "creditnote_refund": { "creditnote_refund_id": "982000000567158", "creditnote_id": "90300000072369", "date": "2016-06-05", "refund_mode": "cash", "reference_number": "INV-384", "amount": 450, "customer_name": "Bowman Furniture", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case." } }

List refunds of a credit note

List all refunds of an existing credit note.
oauthscope : ZohoInvoice.creditnotes.READ

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/refunds -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The refunds of the existing credit note are displayed successfully.", "creditnote_refunds": [ { "creditnote_refund_id": "982000000567158", "creditnote_id": "90300000072369", "date": "2016-06-05", "refund_mode": "cash", "reference_number": "INV-384", "creditnote_number": "CN-29", "customer_name": "Bowman Furniture", "description": "Offer", "amount_bcy": 10, "amount_fcy": 10 }, {...}, {...} ] }

Update credit note refund

Update the refunded transaction.
oauthscope : ZohoInvoice.creditnotes.UPDATE

Arguments

date
string
The date on which credit note is raised. Date Format [yyyy-mm-dd]
refund_mode
string
The method of refund.
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Maximum Length [100]
amount
double
Amount of the invoice.
exchange_rate
string
Exchange rate for the currency associated with the customer.
description
string
A small description about the item.

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id} -X PUT -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "date": "2016-06-05", "refund_mode": "cash", "reference_number": "INV-384", "amount": 450, "exchange_rate": "5.5", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case." }

Response Example

{ "code": 0, "message": "The credit note refund is updated successfully.", "creditnote_refund": { "creditnote_refund_id": "982000000567158", "creditnote_id": "90300000072369", "date": "2016-06-05", "refund_mode": "cash", "reference_number": "INV-384", "amount": 450, "customer_name": "Bowman Furniture", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case." } }

Get credit note refund

Get refund of a particular credit note.
oauthscope : ZohoInvoice.creditnotes.READ

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id} -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The refund of the credit note is displayed successfully.", "creditnote_refund": { "creditnote_refund_id": "982000000567158", "creditnote_id": "90300000072369", "date": "2016-06-05", "refund_mode": "cash", "reference_number": "INV-384", "amount": 450, "customer_name": "Bowman Furniture", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case." } }

Delete credit note refund

Delete a credit note refund.
oauthscope : ZohoInvoice.creditnotes.DELETE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id} -X DELETE -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The refund has been successfully deleted." }