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 Code | Message |
---|---|
1002 | Credit Note does not exists |
12003 | Credit notes that are in closed status cannot be applied to invoices |
12004 | Credit notes that are in void status cannot be applied to invoices |
12005 | Credits cannot be applied to invoices in the draft status |
12006 | Credits cannot be applied to invoices in the closed status |
12007 | Credits cannot be applied to invoices in the void status |
12018 | The specified Credit Note Number already exists |
Attribute
Maximum Length [100]
Date Format [yyyy-mm-dd]
open
, closed
or void
.Maximum Length of the name [100]
Maximum Length [100]
Maximum length [5000]
Maximum length [10000]
{
"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
Date Format [yyyy-mm-dd]
Maximum length [25]
Maximum length [25]
Maximum Length [100]
business_gst
, business_none
, overseas
, consumer
.place of contact
given for the contact will be taken)Maximum Length [100]
Maximum length [5000]
Maximum length [10000]
Maximum length [25]
Maximum length [25]
Maximum length [25]
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
$ 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"}'
{
"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"
}
{
"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
Maximum Length [100]
Date Format [yyyy-mm-dd]
open
, closed
or void
.Maximum Length [100]
Maximum Length of the name [100]
Maximum length [100]
item_description_startswith
and item_description_contains
. Maximum length [100]
Status.All
Status.Open
Status.Draft
Status.Closed
and Status.Void
Maximum length [100]
customer_name
creditnote_number
balance
total
date
and created_time
$ curl https://invoice.zoho.com/api/v3/creditnotes
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"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
Date Format [yyyy-mm-dd]
Maximum length [25]
Maximum length [25]
Maximum Length [100]
business_gst
, business_none
, overseas
, consumer
.place of contact
given for the contact will be taken)Maximum Length [100]
Maximum length [5000]
Maximum length [10000]
Maximum length [25]
Maximum length [25]
Maximum length [25]
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
$ 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"}'
{
"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"
}
{
"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
true
, false
, on
and off
json
, pdf
and html
$ curl https://invoice.zoho.com/api/v3/creditnotes/{creditnote_id}
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"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
$ 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"
{
"code": 0,
"message": "The credit note has been deleted."
}
Email a credit note
Email a credit note. oauthscope : ZohoInvoice.creditnotes.CREATE
Arguments
Maximum length [1000]
Maximum length [5000]
Query Parameters
$ 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"}'
{
"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."
}
{
"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
$ 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"
{
"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
$ 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"
{
"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
$ 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"
{
"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
$ 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"}'
{
"address": "4900 Hopyard Rd, Suite 310",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "USA",
"fax": "+1-925-924-9600"
}
{
"code": 0,
"message": "Billing address updated"
}
Update Shipping address
Updates the shipping address for an existing credit note alone. oauthscope : ZohoInvoice.creditnotes.UPDATE
Arguments
$ 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"}'
{
"address": "Suite 125, McMillan Avenue",
"city": "San Francisco",
"state": "CA",
"zip": 94134,
"country": "USA",
"fax": "+1-925-924-9600"
}
{
"code": 0,
"message": "Shipping address updated"
}
List credit note templates
Get all credit note pdf templates. oauthscope : ZohoInvoice.creditnotes.READ
$ curl https://invoice.zoho.com/api/v3/creditnotes/templates
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"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
$ 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"
{
"code": 0,
"message": "The credit note has been updated."
}
Credit to an invoice
Apply credit note to existing invoices. oauthscope : ZohoInvoice.creditnotes.CREATE
Arguments
$ 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"}'
{
"invoices": [
{
"invoice_id": "90300000079426",
"amount_applied": 41.82
}
]
}
{
"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
$ 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"
{
"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
$ 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"
{
"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
$ 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"}'
{
"description": "Credits applied to invoice INV-00004"
}
{
"code": 0,
"message": "Comments added."
}
List credit note comments & history
Get history and comments of a credit note. oauthscope : ZohoInvoice.creditnotes.READ
$ 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"
{
"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
$ 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"
{
"code": 0,
"message": "The comment has been deleted."
}
List credit note refunds
List all refunds with pagination. oauthscope : ZohoInvoice.creditnotes.READ
Query Parameters
refund_mode
, reference_number
, date
, creditnote_number
, customer_name
, amount_bcy
and amount_fcy
$ curl https://invoice.zoho.com/api/v3/creditnotes/refunds
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"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 Format [yyyy-mm-dd]
Maximum Length [100]
$ 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"}'
{
"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."
}
{
"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
$ 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"
{
"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 Format [yyyy-mm-dd]
Maximum Length [100]
$ 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"}'
{
"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."
}
{
"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
$ 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"
{
"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
$ 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"
{
"code": 0,
"message": "The refund has been successfully deleted."
}