Credit Notes
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
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.
Download Credit Notes OpenAPI Document
End Points
Create a credit note
Update a credit note using a custom field's unique value
List all Credit Notes
Update a credit note
Get a credit note
Delete a credit note
Email a credit note
Get email content
Void a Credit Note
Convert Credit Note to Draft.
Convert to Open
Submit a credit note for approval
Approve a credit note.
Email history
Update billing address
Update Shipping address
List credit note template
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 credit note number displayed in the interface. Auto-generated with CN prefix unless ignore_auto_number_generation is true. Max-Length [100]
date
string
The date on which the credit note is raised. Must be in yyyy-mm-dd format. This date determines the accounting period and affects tax calculations.
is_pre_gst
boolean
🇮🇳
India
only
Applicable for transactions that fall before July 1, 2017.
place_of_supply
string
🇮🇳
India
only
Place of supply for GST (Indian state/UT code where the supply is treated as made). If omitted, the contact’s place of contact may apply. Example:
TN (Tamil Nadu). gst_no
string
🇮🇳
India
only
15 digit GST identification number of the customer.
gst_treatment
string
🇮🇳
India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are
business_gst , business_none , overseas , consumer . status
string
Status of the credit note. This can be
open, closed or void. customer_id
string
Unique identifier for the customer contact. Retrieve customer IDs from the Get Customers API endpoint in the contacts section. This ID links the credit note to the specific customer record.
customer_name
string
Name of the customer to whom the credit note is raised. Max-length [100].
contact_persons_associated
array
Contact Persons associated with the transaction.
contact_person_id
string
Unique ID of the Contact Person.
contact_person_name
string
Name of the contact person.
first_name
string
First Name of the Contact Person.
last_name
string
Last Name of the Contact Person.
contact_person_email
string
Email ID of the Contact Person.
phone
string
Phone Number of the Contact Person.
mobile
string
Mobile Number of the Contact Person.
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
custom_fields
array
Additional fields for the Credit-Notes.
index
integer
Index of the custom field. It can hold any value from 1 to 10.
value
string
Value of the custom field.
label
string
Label of the custom field.
data_type
string
Data type of the custom field.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_name
string
Name of the tag.
tag_option_id
string
ID of the tag option.
tag_option_name
string
Name of the tag option.
is_tag_mandatory
boolean
Indicates if the tag is mandatory.
reference_number
string
Optional reference number for tracking purposes. Can be any custom string or auto-generated. Useful for linking to external systems or internal tracking. Max-Length [100]
email
string
Email address of the customer.
total
double
Total credits raised in this credit note.
balance
double
The unapplied credits.
location_id
string
Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.
location_name
string
Name of the location.
line_items
array
Line items of a credit note.
item_id
string
Unique identifier for the item in the line item. Retrieve item IDs from the List Items API endpoint in the items section. Links the line item to a specific product or service.
line_item_id
string
Search credit notes by credit note line item id.
account_id
string
Unique identifier for the chart of accounts entry. Retrieve account IDs from the List Chart of Accounts API endpoint. Determines which account the line item affects for accounting purposes.
name
string
Name or title of the line item. Describes the product or service being credited. This name is displayed on the credit note document.
description
string
Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document.
item_order
integer
Order of the item.
rate
double
Rate of the line item.
quantity
int32
Number of units being credited for this line item. Must be a positive number. Used to calculate the total amount for the line item.
unit
string
Unit of the line item. E.g: kgs, Nos.
discount
double
Discount applied to the credit note, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g., 10%). For example, on Rs.1000, a 10% discount results in Rs.900, while a flat Rs.200 discount results in Rs.800.
tax_id
string
Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.
tds_tax_id
string
🇮🇳
India
only
Unique ID denoting the TDS tax associated with the credit note.
tax_exemption_id
string
🇮🇳
India
only
Unique ID of the tax exemption.
tax_exemption_code
string
🇮🇳
India
only
Unique code of the tax exemption.
product_type
string
Type of line item for GST. Allowed values:
goods or services. hsn_or_sac
string
🇮🇳
India
only
Add HSN/SAC code for your goods/services.
item_custom_fields
array
Custom field information.
location_id
string
Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.
location_name
string
Name of the location.
serial_numbers
string
Serial numbers of the items being credited. Used for tracking specific units of inventory or equipment. Important for warranty and return tracking.
project_id
string
Unique identifier for the project associated with the line item. Links the credit to a specific project for project-based accounting and reporting.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_name
string
Name of the tag.
tag_option_id
string
ID of the tag option.
tag_option_name
string
Name of the tag option.
is_tag_mandatory
boolean
Indicates if the tag is mandatory.
invoices
array
List of invoices for which the credit note has been raised. This contains
invoice_id and amount. invoice_id
string
Invoice ID of the required invoice.
invoice_number
string
Invoice number of the required invoice.
amount
double
Amount paid for the invoice.
taxes
array
Taxes associated wit the subscription.
tax_id
string
Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.
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
string
Billing address for the invoice.
street2
string
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
string
Billing address for the invoice.
street2
string
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 identifier for the credit note PDF template. Retrieve template IDs from the List Credit Note Templates API endpoint. Determines the visual layout and branding of the credit note document.
template_name
string
Name of the default template of the creditnote.
notes
string
Additional notes or comments for the credit note. Displayed on the credit note document for customer reference. Max-length [5000]
terms
string
Terms and conditions displayed on the credit note document. Include payment terms, return policies, or other business conditions. Max-length [10000]
{
"creditnote_id": "90300000072369",
"creditnote_number": "CN-29",
"date": "2016-06-05",
"is_pre_gst": true,
"place_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"status": "draft",
"customer_id": "903000000000099",
"customer_name": "Zylker Inc",
"contact_persons_associated": [
{
"contact_person_id": 982000000567003,
"contact_person_name": "David",
"first_name": "David",
"last_name": "John",
"contact_person_email": "willsmith@zylker.org",
"phone": "+91-44-4567-8900",
"mobile": "+91-9876543210",
"communication_preference": {
"is_email_enabled": true,
"is_whatsapp_enabled": true
}
}
],
"custom_fields": [
{
"index": 1,
"value": 129890,
"label": "label",
"data_type": "text"
}
],
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
],
"reference_number": "INV-384",
"email": "benjamin.george@zylker.org",
"total": 450,
"balance": 10,
"location_id": "460000000038080",
"location_name": "string",
"line_items": [
{
"item_id": "90300000081501",
"line_item_id": 903000006245,
"account_id": "903000000000388",
"name": "Basic Monthly",
"description": "prorated amount for items",
"item_order": 0,
"rate": 0,
"quantity": 1,
"unit": "kgs",
"discount": 10,
"tax_id": "903000000000356",
"tds_tax_id": "903000000000357",
"tax_exemption_id": "903000006345",
"tax_exemption_code": "GST FREE",
"product_type": "goods",
"hsn_or_sac": 80540,
"item_custom_fields": [
"string"
],
"location_id": "460000000038080",
"location_name": "string",
"serial_numbers": "string",
"project_id": 90300000087378,
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
]
}
],
"invoices": [
{
"invoice_id": "90300000079426",
"invoice_number": "INV-384",
"amount": 450
}
],
"taxes": [
{
"tax_id": "903000000000356",
"tax_name": "Basic Tax",
"tax_amount": "2.50"
}
],
"currency_code": "INR",
"currency_symbol": "₹",
"billing_address": {
"address": "4900 Hopyard Rd, Suite 310",
"street2": "McMillan Avenue",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": "+91-44-4567-8901"
},
"shipping_address": {
"address": "4900 Hopyard Rd, Suite 310",
"street2": "McMillan Avenue",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": "+91-44-4567-8901"
},
"created_time": "2016-06-05T02:30:08+0530",
"updated_time": "2016-06-05T02:30:08+0530",
"template_id": "90300000001336",
"template_name": "Standard Template",
"notes": "Offer for the referral",
"terms": ""
}
Create a credit note
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Create a new credit note to record credits issued to customers for returned items, overpayments, or adjustments. Supports multi-currency transactions, custom line items, tax calculations, and workflows.
OAuth Scope : ERP.creditnotes.CREATE
Arguments
customer_id
string
(Required)
Unique identifier for the customer contact. Retrieve customer IDs from the Get Customers API endpoint in the contacts section. This ID links the credit note to the specific customer record.
currency_id
string
Unique identifier for the currency used in the credit note. Can differ from customer currency if multi-currency is enabled. Retrieve currency IDs from the List Currencies API endpoint in the currency section.
contact_persons_associated
array
Contact Persons associated with the transaction.
contact_person_id
string
Unique ID of the Contact Person.
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
date
string
(Required)
The date on which the credit note is raised. Must be in yyyy-mm-dd format. This date determines the accounting period and affects tax calculations.
is_draft
boolean
Set to true to create the credit note in draft status. Draft credit notes are not finalized and can be modified before sending to customers.
exchange_rate
string
Exchange rate for converting the credit note currency to base currency. Required when currency differs from base currency. Retrieve rates from currency exchange rate APIs.
line_items
array
(Required)
Array of line items for the credit note. Each line item represents a product or service being credited to the customer.
item_id
string
Unique identifier for the item in the line item. Retrieve item IDs from the List Items API endpoint in the items section. Links the line item to a specific product or service.
invoice_id
string
Invoice ID of the required invoice.
invoice_item_id
string
Unique identifier of the invoice line item that this credit note line item references. Use this when creating a credit note for a specific invoice line item.
description
string
Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document.
code
string
Unique code or SKU for the line item. Used for product identification and inventory tracking. Helps distinguish between different variants of the same product.
name
string
Name or title of the line item. Describes the product or service being credited. This name is displayed on the credit note document.
type
integer
Type of the credit note line item. Numeric value indicating the line item type (e.g., 1 for product, 2 for service). Used for categorization and reporting purposes.
account_id
string
Unique identifier for the chart of accounts entry. Retrieve account IDs from the List Chart of Accounts API endpoint. Determines which account the line item affects for accounting purposes.
account_name
string
Name of the chart of accounts entry. Displays the account name for reference and reporting purposes. Should match the account_id provided.
quantity
int32
Number of units being credited for this line item. Must be a positive number. Used to calculate the total amount for the line item.
tax_id
string
Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.
tds_tax_id
string
🇮🇳
India
only
Unique ID denoting the TDS tax associated with the credit note.
product_type
string
Type of line item for GST. Allowed values:
goods or services. serial_numbers
string
Serial numbers of the items being credited. Used for tracking specific units of inventory or equipment. Important for warranty and return tracking.
location_id
string
Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.
project_id
string
Unique identifier for the project associated with the line item. Links the credit to a specific project for project-based accounting and reporting.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
ID of the tag option.
location_id
string
Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.
creditnote_number
string
(Required)
Unique credit note number displayed in the interface. Auto-generated with CN prefix unless ignore_auto_number_generation is true. Max-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 of supply for GST (Indian state/UT code where the supply is treated as made). If omitted, the contact’s place of contact may apply. Example:
TN (Tamil Nadu). ignore_auto_number_generation
boolean
Set to true to provide a custom credit note number instead of auto-generated CN prefix. When true, you must specify creditnote_number manually.
reference_number
string
Optional reference number for tracking purposes. Can be any custom string or auto-generated. Useful for linking to external systems or internal tracking. Max-Length [100]
custom_fields
array
Additional fields for the Credit-Notes.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
ID of the tag option.
notes
string
Additional notes or comments for the credit note. Displayed on the credit note document for customer reference. Max-length [5000]
terms
string
Terms and conditions displayed on the credit note document. Include payment terms, return policies, or other business conditions. Max-length [10000]
template_id
string
Unique identifier for the credit note PDF template. Retrieve template IDs from the List Credit Note Templates API endpoint. Determines the visual layout and branding of the credit note document.
tax_id
string
Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.
tax_exemption_id
string
🇮🇳
India
only
Unique ID of the tax exemption.
is_inclusive_tax
boolean
Used to specify whether the line item rates are inclusive or exclusive of tax.
Query Parameters
organization_id
string
(Required)
ID of the organization
invoice_id
string
Invoice ID of the required invoice.
ignore_auto_number_generation
boolean
Set to true if you need to provide your own credit note number.
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/creditnotes?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"customer_id": "903000000000099",
"currency_id": "982000000567240",
"contact_persons_associated": [
{
"contact_person_id": 982000000567003,
"communication_preference": {
"is_email_enabled": true,
"is_whatsapp_enabled": true
}
}
],
"date": "2016-06-05",
"is_draft": true,
"exchange_rate": "5.5",
"line_items": [
{
"item_id": "90300000081501",
"invoice_id": "90300000079426",
"invoice_item_id": "982000000567021",
"description": "prorated amount for items",
"code": "basic-monthly",
"name": "Basic Monthly",
"type": 1,
"account_id": "903000000000388",
"account_name": "Sales",
"quantity": 1,
"tax_id": "903000000000356",
"tds_tax_id": "903000000000357",
"product_type": "goods",
"serial_numbers": "string",
"location_id": "460000000038080",
"project_id": 90300000087378,
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
]
}
],
"location_id": "460000000038080",
"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": [
"string"
],
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"notes": "Offer for the referral",
"terms": "",
"template_id": "90300000001336",
"tax_id": "903000000000356",
"tax_exemption_id": "903000006345",
"is_inclusive_tax": "fasle"
}
{
"code": 0,
"message": "The credit note has been created.",
"creditnote": {
"creditnote_id": "90300000072369",
"creditnote_number": "CN-29",
"date": "2016-06-05",
"is_pre_gst": true,
"place_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"status": "draft",
"customer_id": "903000000000099",
"customer_name": "Zylker Inc",
"contact_persons_associated": [
{
"contact_person_id": 982000000567003,
"contact_person_name": "David",
"first_name": "David",
"last_name": "John",
"contact_person_email": "willsmith@zylker.org",
"phone": "+91-44-4567-8900",
"mobile": "+91-9876543210",
"communication_preference": {
"is_email_enabled": true,
"is_whatsapp_enabled": true
}
}
],
"custom_fields": [
{
"index": 1,
"value": 129890,
"label": "label",
"data_type": "text"
}
],
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
],
"reference_number": "INV-384",
"email": "benjamin.george@zylker.org",
"total": 450,
"balance": 10,
"location_id": "460000000038080",
"location_name": "string",
"line_items": [
{
"item_id": "90300000081501",
"line_item_id": 903000006245,
"account_id": "903000000000388",
"name": "Basic Monthly",
"description": "prorated amount for items",
"item_order": 0,
"rate": 0,
"quantity": 1,
"unit": "kgs",
"discount": 10,
"tax_id": "903000000000356",
"tds_tax_id": "903000000000357",
"tax_exemption_id": "903000006345",
"tax_exemption_code": "GST FREE",
"product_type": "goods",
"hsn_or_sac": 80540,
"item_custom_fields": [
"string"
],
"location_id": "460000000038080",
"location_name": "string",
"serial_numbers": "string",
"project_id": 90300000087378,
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
]
}
],
"invoices": [
{
"invoice_id": "90300000079426",
"invoice_number": "INV-384",
"amount": 450
}
],
"taxes": [
{
"tax_id": "903000000000356",
"tax_name": "Basic Tax",
"tax_amount": "2.50"
}
],
"currency_code": "INR",
"currency_symbol": "₹",
"billing_address": {
"address": "4900 Hopyard Rd, Suite 310",
"street2": "McMillan Avenue",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": "+91-44-4567-8901"
},
"shipping_address": {
"address": "4900 Hopyard Rd, Suite 310",
"street2": "McMillan Avenue",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": "+91-44-4567-8901"
},
"created_time": "2016-06-05T02:30:08+0530",
"updated_time": "2016-06-05T02:30:08+0530",
"template_id": "90300000001336",
"template_name": "Standard Template",
"notes": "Offer for the referral",
"terms": ""
}
}
Update a credit note using a custom field's unique value
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a credit note by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header. Based on this value, the corresponding credit note will be retrieved and updated. Additionally, there is an optional X-Upsert header. If the X-Upsert header is true and the custom field's unique value is not found in any of the existing credit notes, a new credit note will be created if the necessary payload details are available.
OAuth Scope : ERP.invoices.UPDATE
Arguments
customer_id
string
(Required)
Unique identifier for the customer contact. Retrieve customer IDs from the Get Customers API endpoint in the contacts section. This ID links the credit note to the specific customer record.
currency_id
string
Unique identifier for the currency used in the credit note. Can differ from customer currency if multi-currency is enabled. Retrieve currency IDs from the List Currencies API endpoint in the currency section.
contact_persons_associated
array
Contact Persons associated with the transaction.
contact_person_id
string
Unique ID of the Contact Person.
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
date
string
(Required)
The date on which the credit note is raised. Must be in yyyy-mm-dd format. This date determines the accounting period and affects tax calculations.
is_draft
boolean
Set to true to create the credit note in draft status. Draft credit notes are not finalized and can be modified before sending to customers.
exchange_rate
string
Exchange rate for converting the credit note currency to base currency. Required when currency differs from base currency. Retrieve rates from currency exchange rate APIs.
line_items
array
(Required)
Line items of a credit note.
item_id
string
Unique identifier for the item in the line item. Retrieve item IDs from the List Items API endpoint in the items section. Links the line item to a specific product or service.
line_item_id
string
Search credit notes by credit note line item id.
account_id
string
Unique identifier for the chart of accounts entry. Retrieve account IDs from the List Chart of Accounts API endpoint. Determines which account the line item affects for accounting purposes.
name
string
Name or title of the line item. Describes the product or service being credited. This name is displayed on the credit note document.
description
string
Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document.
item_order
integer
Order of the item.
rate
double
Rate of the line item.
quantity
int32
Number of units being credited for this line item. Must be a positive number. Used to calculate the total amount for the line item.
unit
string
Unit of the line item. E.g: kgs, Nos.
discount
double
Discount applied to the credit note, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g., 10%). For example, on Rs.1000, a 10% discount results in Rs.900, while a flat Rs.200 discount results in Rs.800.
tax_id
string
Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.
tds_tax_id
string
🇮🇳
India
only
Unique ID denoting the TDS tax associated with the credit note.
tax_exemption_id
string
🇮🇳
India
only
Unique ID of the tax exemption.
tax_exemption_code
string
🇮🇳
India
only
Unique code of the tax exemption.
product_type
string
Type of line item for GST. Allowed values:
goods or services. hsn_or_sac
string
🇮🇳
India
only
Add HSN/SAC code for your goods/services.
item_custom_fields
array
Custom field information.
location_id
string
Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.
location_name
string
Name of the location.
serial_numbers
string
Serial numbers of the items being credited. Used for tracking specific units of inventory or equipment. Important for warranty and return tracking.
project_id
string
Unique identifier for the project associated with the line item. Links the credit to a specific project for project-based accounting and reporting.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_name
string
Name of the tag.
tag_option_id
string
ID of the tag option.
tag_option_name
string
Name of the tag option.
is_tag_mandatory
boolean
Indicates if the tag is mandatory.
location_id
string
Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.
creditnote_number
string
(Required)
Unique credit note number displayed in the interface. Auto-generated with CN prefix unless ignore_auto_number_generation is true. Max-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 of supply for GST (Indian state/UT code where the supply is treated as made). If omitted, the contact’s place of contact may apply. Example:
TN (Tamil Nadu). ignore_auto_number_generation
boolean
Set to true to provide a custom credit note number instead of auto-generated CN prefix. When true, you must specify creditnote_number manually.
reference_number
string
Optional reference number for tracking purposes. Can be any custom string or auto-generated. Useful for linking to external systems or internal tracking. Max-Length [100]
custom_fields
array
Additional fields for the Credit-Notes.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
ID of the tag option.
notes
string
Additional notes or comments for the credit note. Displayed on the credit note document for customer reference. Max-length [5000]
terms
string
Terms and conditions displayed on the credit note document. Include payment terms, return policies, or other business conditions. Max-length [10000]
template_id
string
Unique identifier for the credit note PDF template. Retrieve template IDs from the List Credit Note Templates API endpoint. Determines the visual layout and branding of the credit note document.
tax_id
string
Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.
tax_exemption_id
string
🇮🇳
India
only
Unique ID of the tax exemption.
is_inclusive_tax
boolean
Used to specify whether the line item rates are inclusive or exclusive of tax.
item_id
string
Unique identifier for the item in the line item. Retrieve item IDs from the List Items API endpoint in the items section. Links the line item to a specific product or service.
account_id
string
Unique identifier for the chart of accounts entry. Retrieve account IDs from the List Chart of Accounts API endpoint. Determines which account the line item affects for accounting purposes.
name
string
Name or title of the line item. Describes the product or service being credited. This name is displayed on the credit note document.
description
string
Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document.
unit
string
Unit of the line item. E.g: kgs, Nos.
rate
double
Rate of the line item.
quantity
int32
Number of units being credited for this line item. Must be a positive number. Used to calculate the total amount for the line item.
Query Parameters
organization_id
string
(Required)
ID of the organization
Headers
X-Unique-Identifier-Key
string
(Required)
Unique custom field API name.
X-Unique-Identifier-Value
string
(Required)
Unique custom field value.
X-Upsert
boolean
If no record is found for the unique custom field value, a new invoice will be created.
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("X-Unique-Identifier-Key", "cf_unique_cf");
headers_data.put("X-Unique-Identifier-Value", "unique Value");
headers_data.put("X-Upsert", "true");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695")
.put(body)
.addHeader("X-Unique-Identifier-Key", "cf_unique_cf")
.addHeader("X-Unique-Identifier-Value", "unique Value")
.addHeader("X-Upsert", "true")
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
'X-Unique-Identifier-Key': 'cf_unique_cf',
'X-Unique-Identifier-Value': 'unique Value',
'X-Upsert': 'true',
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'X-Unique-Identifier-Key': "cf_unique_cf",
'X-Unique-Identifier-Value': "unique Value",
'X-Upsert': "true",
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/erp/v3/creditnotes?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes?organization_id=10234695",
"headers": {
"X-Unique-Identifier-Key": "cf_unique_cf",
"X-Unique-Identifier-Value": "unique Value",
"X-Upsert": "true",
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'X-Unique-Identifier-Key: cf_unique_cf' \
--header 'X-Unique-Identifier-Value: unique Value' \
--header 'X-Upsert: true' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"customer_id": "903000000000099",
"currency_id": "982000000567240",
"contact_persons_associated": [
{
"contact_person_id": 982000000567003,
"communication_preference": {
"is_email_enabled": true,
"is_whatsapp_enabled": true
}
}
],
"date": "2016-06-05",
"is_draft": true,
"exchange_rate": "5.5",
"line_items": [
{
"item_id": "90300000081501",
"line_item_id": 903000006245,
"account_id": "903000000000388",
"name": "Basic Monthly",
"description": "prorated amount for items",
"item_order": 0,
"rate": 0,
"quantity": 1,
"unit": "kgs",
"discount": 10,
"tax_id": "903000000000356",
"tds_tax_id": "903000000000357",
"tax_exemption_id": "903000006345",
"tax_exemption_code": "GST FREE",
"product_type": "goods",
"hsn_or_sac": 80540,
"item_custom_fields": [
"string"
],
"location_id": "460000000038080",
"location_name": "string",
"serial_numbers": "string",
"project_id": 90300000087378,
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
]
}
],
"location_id": "460000000038080",
"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": [
"string"
],
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"notes": "Offer for the referral",
"terms": "",
"template_id": "90300000001336",
"tax_id": "903000000000356",
"tax_exemption_id": "903000006345",
"is_inclusive_tax": "fasle",
"item_id": "90300000081501",
"account_id": "903000000000388",
"name": "Basic Monthly",
"description": "prorated amount for items",
"unit": "kgs",
"rate": 0,
"quantity": 1
}
{
"code": 0,
"message": "The credit note has been updated.",
"creditnote": {
"creditnote_id": "90300000072369",
"creditnote_number": "CN-29",
"date": "2016-06-05",
"is_pre_gst": true,
"place_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"status": "draft",
"customer_id": "903000000000099",
"customer_name": "Zylker Inc",
"contact_persons_associated": [
{
"contact_person_id": 982000000567003,
"contact_person_name": "David",
"first_name": "David",
"last_name": "John",
"contact_person_email": "willsmith@zylker.org",
"phone": "+91-44-4567-8900",
"mobile": "+91-9876543210",
"communication_preference": {
"is_email_enabled": true,
"is_whatsapp_enabled": true
}
}
],
"custom_fields": [
{
"index": 1,
"value": 129890,
"label": "label",
"data_type": "text"
}
],
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"reference_number": "INV-384",
"email": "benjamin.george@zylker.org",
"total": 450,
"balance": 10,
"line_items": [
{
"item_id": "90300000081501",
"description": "prorated amount for items",
"code": "basic-monthly",
"name": "Basic Monthly",
"type": 1,
"account_id": "903000000000388",
"account_name": "Sales",
"quantity": 1,
"tax_id": "903000000000356",
"product_type": "goods",
"serial_numbers": "string",
"location_id": "460000000038080",
"location_name": "string",
"project_id": 90300000087378,
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
]
}
],
"invoices": [
{
"invoice_id": "90300000079426",
"invoice_number": "INV-384",
"amount": 450
}
],
"taxes": [
{
"tax_id": "903000000000356",
"tax_name": "Basic Tax",
"tax_amount": "2.50"
}
],
"currency_code": "INR",
"currency_symbol": "₹",
"location_id": "460000000038080",
"location_name": "string",
"billing_address": {
"address": "4900 Hopyard Rd, Suite 310",
"street2": "McMillan Avenue",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": "+91-44-4567-8901",
"attention": " "
},
"shipping_address": {
"address": "4900 Hopyard Rd, Suite 310",
"street2": "McMillan Avenue",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": "+91-44-4567-8901",
"attention": " "
},
"created_time": "2016-06-05T02:30:08+0530",
"updated_time": "2016-06-05T02:30:08+0530",
"template_id": "90300000001336",
"template_name": "Standard Template",
"notes": "Offer for the referral",
"terms": ""
}
}
List all Credit Notes
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Retrieve a paginated list of credit notes with comprehensive filtering, sorting, and search capabilities. Use query parameters to filter by date, status, amount, customer details, items, taxes, and custom fields.
OAuth Scope : ERP.creditnotes.READ
Query Parameters
organization_id
string
(Required)
ID of the organization
creditnote_number
string
Filter credit notes by specific credit note number. Use this parameter to search for a particular credit note by its unique number. Max-Length [100]
date
string
Filter credit notes by the date they were raised. Use yyyy-mm-dd format to search for credit notes created on a specific date.
status
string
Filter credit notes by their current status. Allowed values:
open, closed, void, or draft. total
double
Filter credit notes by their total amount. Use this parameter to search for credit notes with a specific total value.
reference_number
string
Filter credit notes by their reference number. Use this parameter to search for credit notes with a specific reference number. Max-Length [100]
customer_name
string
Filter credit notes by customer name. Use this parameter to search for credit notes associated with a specific customer. Max-Length [100]
item_name
string
Filter credit notes by item name. Use this parameter to search for credit notes containing specific items. Max-Length [100]
customer_id
string
Filter credit notes by customer ID. Use this parameter to search for credit notes associated with a specific customer. Retrieve customer IDs from the contacts API.
item_description
string
Filter credit notes by item description. Supports variants
item_description_startswith and item_description_contains for flexible searching. Max-length [100] item_id
string
Filter credit notes by item ID. Use this parameter to search for credit notes containing a specific item. Retrieve item IDs from the items API.
line_item_id
string
Filter credit notes by line item ID. Use this parameter to search for credit notes containing a specific line item within the credit note.
tax_id
string
Filter credit notes by tax ID. Use this parameter to search for credit notes with a specific tax applied. Retrieve tax IDs from the taxes API.
filter_by
string
Filter credit notes by status using predefined status values. Allowed values:
Status.All, Status.Open, Status.Draft, Status.Closed, and Status.Void. search_text
string
Search credit notes using text search across multiple fields. Searches credit note number, customer name, and reference number. Max-length [100]
sort_column
string
Sort credit notes by specified column. Allowed values:
customer_name, creditnote_number, balance, total, date, and created_time. page
integer
Page number for pagination. Specify which page of results to retrieve. Default value is 1.
per_page
integer
Number of records to be fetched per page. Default value is 200.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/creditnotes?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v3/creditnotes?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"creditnotes": {
"creditnote_id": "90300000072369",
"creditnote_number": "CN-29",
"status": "draft",
"reference_number": "INV-384",
"date": "2016-06-05",
"total": 450,
"balance": 10,
"location_id": "460000000038080",
"location_name": "string",
"customer_id": "903000000000099",
"customer_name": "Zylker Inc",
"currency_id": "982000000567240",
"currency_code": "INR",
"created_time": "2016-06-05T02:30:08+0530",
"last_modified_time": "2016-06-05T02:30:08+0530",
"is_emailed": true
}
}
Update a credit note
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Details of an existing creditnote.
OAuth Scope : ERP.creditnotes.UPDATE
Arguments
customer_id
string
(Required)
Unique identifier for the customer contact. Retrieve customer IDs from the Get Customers API endpoint in the contacts section. This ID links the credit note to the specific customer record.
currency_id
string
Unique identifier for the currency used in the credit note. Can differ from customer currency if multi-currency is enabled. Retrieve currency IDs from the List Currencies API endpoint in the currency section.
contact_persons_associated
array
Contact Persons associated with the transaction.
contact_person_id
string
Unique ID of the Contact Person.
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
date
string
(Required)
The date on which the credit note is raised. Must be in yyyy-mm-dd format. This date determines the accounting period and affects tax calculations.
is_draft
boolean
Set to true to create the credit note in draft status. Draft credit notes are not finalized and can be modified before sending to customers.
exchange_rate
string
Exchange rate for converting the credit note currency to base currency. Required when currency differs from base currency. Retrieve rates from currency exchange rate APIs.
line_items
array
(Required)
Line items of a credit note.
item_id
string
Unique identifier for the item in the line item. Retrieve item IDs from the List Items API endpoint in the items section. Links the line item to a specific product or service.
line_item_id
string
Search credit notes by credit note line item id.
account_id
string
Unique identifier for the chart of accounts entry. Retrieve account IDs from the List Chart of Accounts API endpoint. Determines which account the line item affects for accounting purposes.
name
string
Name or title of the line item. Describes the product or service being credited. This name is displayed on the credit note document.
description
string
Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document.
item_order
integer
Order of the item.
rate
double
Rate of the line item.
quantity
int32
Number of units being credited for this line item. Must be a positive number. Used to calculate the total amount for the line item.
unit
string
Unit of the line item. E.g: kgs, Nos.
discount
double
Discount applied to the credit note, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g., 10%). For example, on Rs.1000, a 10% discount results in Rs.900, while a flat Rs.200 discount results in Rs.800.
tax_id
string
Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.
tds_tax_id
string
🇮🇳
India
only
Unique ID denoting the TDS tax associated with the credit note.
tax_exemption_id
string
🇮🇳
India
only
Unique ID of the tax exemption.
tax_exemption_code
string
🇮🇳
India
only
Unique code of the tax exemption.
product_type
string
Type of line item for GST. Allowed values:
goods or services. hsn_or_sac
string
🇮🇳
India
only
Add HSN/SAC code for your goods/services.
item_custom_fields
array
Custom field information.
location_id
string
Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.
location_name
string
Name of the location.
serial_numbers
string
Serial numbers of the items being credited. Used for tracking specific units of inventory or equipment. Important for warranty and return tracking.
project_id
string
Unique identifier for the project associated with the line item. Links the credit to a specific project for project-based accounting and reporting.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_name
string
Name of the tag.
tag_option_id
string
ID of the tag option.
tag_option_name
string
Name of the tag option.
is_tag_mandatory
boolean
Indicates if the tag is mandatory.
location_id
string
Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.
creditnote_number
string
(Required)
Unique credit note number displayed in the interface. Auto-generated with CN prefix unless ignore_auto_number_generation is true. Max-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 of supply for GST (Indian state/UT code where the supply is treated as made). If omitted, the contact’s place of contact may apply. Example:
TN (Tamil Nadu). ignore_auto_number_generation
boolean
Set to true to provide a custom credit note number instead of auto-generated CN prefix. When true, you must specify creditnote_number manually.
reference_number
string
Optional reference number for tracking purposes. Can be any custom string or auto-generated. Useful for linking to external systems or internal tracking. Max-Length [100]
custom_fields
array
Additional fields for the Credit-Notes.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
ID of the tag option.
notes
string
Additional notes or comments for the credit note. Displayed on the credit note document for customer reference. Max-length [5000]
terms
string
Terms and conditions displayed on the credit note document. Include payment terms, return policies, or other business conditions. Max-length [10000]
template_id
string
Unique identifier for the credit note PDF template. Retrieve template IDs from the List Credit Note Templates API endpoint. Determines the visual layout and branding of the credit note document.
tax_id
string
Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.
tax_exemption_id
string
🇮🇳
India
only
Unique ID of the tax exemption.
is_inclusive_tax
boolean
Used to specify whether the line item rates are inclusive or exclusive of tax.
item_id
string
Unique identifier for the item in the line item. Retrieve item IDs from the List Items API endpoint in the items section. Links the line item to a specific product or service.
account_id
string
Unique identifier for the chart of accounts entry. Retrieve account IDs from the List Chart of Accounts API endpoint. Determines which account the line item affects for accounting purposes.
name
string
Name or title of the line item. Describes the product or service being credited. This name is displayed on the credit note document.
description
string
Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document.
unit
string
Unit of the line item. E.g: kgs, Nos.
rate
double
Rate of the line item.
quantity
int32
Number of units being credited for this line item. Must be a positive number. Used to calculate the total amount for the line item.
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
ignore_auto_number_generation
boolean
Set to true if you need to provide your own credit note number.
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695")
.put(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/erp/v3/creditnotes/90300000072369?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"customer_id": "903000000000099",
"currency_id": "982000000567240",
"contact_persons_associated": [
{
"contact_person_id": 982000000567003,
"communication_preference": {
"is_email_enabled": true,
"is_whatsapp_enabled": true
}
}
],
"date": "2016-06-05",
"is_draft": true,
"exchange_rate": "5.5",
"line_items": [
{
"item_id": "90300000081501",
"line_item_id": 903000006245,
"account_id": "903000000000388",
"name": "Basic Monthly",
"description": "prorated amount for items",
"item_order": 0,
"rate": 0,
"quantity": 1,
"unit": "kgs",
"discount": 10,
"tax_id": "903000000000356",
"tds_tax_id": "903000000000357",
"tax_exemption_id": "903000006345",
"tax_exemption_code": "GST FREE",
"product_type": "goods",
"hsn_or_sac": 80540,
"item_custom_fields": [
"string"
],
"location_id": "460000000038080",
"location_name": "string",
"serial_numbers": "string",
"project_id": 90300000087378,
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
]
}
],
"location_id": "460000000038080",
"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": [
"string"
],
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"notes": "Offer for the referral",
"terms": "",
"template_id": "90300000001336",
"tax_id": "903000000000356",
"tax_exemption_id": "903000006345",
"is_inclusive_tax": "fasle",
"item_id": "90300000081501",
"account_id": "903000000000388",
"name": "Basic Monthly",
"description": "prorated amount for items",
"unit": "kgs",
"rate": 0,
"quantity": 1
}
{
"code": 0,
"message": "The credit note has been updated.",
"creditnote": {
"creditnote_id": "90300000072369",
"creditnote_number": "CN-29",
"date": "2016-06-05",
"is_pre_gst": true,
"place_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"status": "draft",
"customer_id": "903000000000099",
"customer_name": "Zylker Inc",
"contact_persons_associated": [
{
"contact_person_id": 982000000567003,
"contact_person_name": "David",
"first_name": "David",
"last_name": "John",
"contact_person_email": "willsmith@zylker.org",
"phone": "+91-44-4567-8900",
"mobile": "+91-9876543210",
"communication_preference": {
"is_email_enabled": true,
"is_whatsapp_enabled": true
}
}
],
"custom_fields": [
{
"index": 1,
"value": 129890,
"label": "label",
"data_type": "text"
}
],
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"reference_number": "INV-384",
"email": "benjamin.george@zylker.org",
"total": 450,
"balance": 10,
"line_items": [
{
"item_id": "90300000081501",
"description": "prorated amount for items",
"code": "basic-monthly",
"name": "Basic Monthly",
"type": 1,
"account_id": "903000000000388",
"account_name": "Sales",
"quantity": 1,
"tax_id": "903000000000356",
"product_type": "goods",
"serial_numbers": "string",
"location_id": "460000000038080",
"location_name": "string",
"project_id": 90300000087378,
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
]
}
],
"invoices": [
{
"invoice_id": "90300000079426",
"invoice_number": "INV-384",
"amount": 450
}
],
"taxes": [
{
"tax_id": "903000000000356",
"tax_name": "Basic Tax",
"tax_amount": "2.50"
}
],
"currency_code": "INR",
"currency_symbol": "₹",
"location_id": "460000000038080",
"location_name": "string",
"billing_address": {
"address": "4900 Hopyard Rd, Suite 310",
"street2": "McMillan Avenue",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": "+91-44-4567-8901",
"attention": " "
},
"shipping_address": {
"address": "4900 Hopyard Rd, Suite 310",
"street2": "McMillan Avenue",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": "+91-44-4567-8901",
"attention": " "
},
"created_time": "2016-06-05T02:30:08+0530",
"updated_time": "2016-06-05T02:30:08+0530",
"template_id": "90300000001336",
"template_name": "Standard Template",
"notes": "Offer for the referral",
"terms": ""
}
}
Get a credit note
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Details of an existing creditnote.
OAuth Scope : ERP.creditnotes.READ
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
print
boolean
Export credit note pdf with default print option. Allowed Values:
true, false, on and off accept
string
You can get credit note details as json/pdf/html. Default format is html. Allowed Values:
json, pdf and htmlheaders_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/creditnotes/90300000072369?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"creditnote": {
"creditnote_id": "90300000072369",
"creditnote_number": "CN-29",
"date": "2016-06-05",
"is_pre_gst": true,
"place_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"status": "draft",
"customer_id": "903000000000099",
"customer_name": "Zylker Inc",
"contact_persons_associated": [
{
"contact_person_id": 982000000567003,
"contact_person_name": "David",
"first_name": "David",
"last_name": "John",
"contact_person_email": "willsmith@zylker.org",
"phone": "+91-44-4567-8900",
"mobile": "+91-9876543210",
"communication_preference": {
"is_email_enabled": true,
"is_whatsapp_enabled": true
}
}
],
"custom_fields": [
{
"index": 1,
"value": 129890,
"label": "label",
"data_type": "text"
}
],
"reference_number": "INV-384",
"email": "benjamin.george@zylker.org",
"total": 450,
"balance": 10,
"location_id": "460000000038080",
"location_name": "string",
"line_items": [
{
"item_id": "90300000081501",
"description": "prorated amount for items",
"code": "basic-monthly",
"name": "Basic Monthly",
"type": 1,
"account_id": "903000000000388",
"account_name": "Sales",
"quantity": 1,
"tax_id": "903000000000356",
"product_type": "goods",
"serial_numbers": "string",
"location_id": "460000000038080",
"location_name": "string",
"project_id": 90300000087378,
"project_name": "Sample Project",
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
]
}
],
"invoices": [
{
"invoice_id": "90300000079426",
"invoice_number": "INV-384",
"amount": 450
}
],
"taxes": [
{
"tax_id": "903000000000356",
"tax_name": "Basic Tax",
"tax_amount": "2.50"
}
],
"currency_code": "INR",
"currency_symbol": "₹",
"created_time": "2016-06-05T02:30:08+0530",
"updated_time": "2016-06-05T02:30:08+0530",
"billing_address": {
"address": "4900 Hopyard Rd, Suite 310",
"street2": "McMillan Avenue",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": "+91-44-4567-8901",
"attention": " "
},
"shipping_address": {
"address": "4900 Hopyard Rd, Suite 310",
"street2": "McMillan Avenue",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": "+91-44-4567-8901",
"attention": " "
},
"template_id": "90300000001336",
"template_name": "Standard Template",
"notes": "Offer for the referral",
"terms": "",
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
]
}
}
Delete a credit note
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Delete an existing credit note.
OAuth Scope : ERP.creditnotes.DELETE
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695")
.delete(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'DELETE',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/erp/v3/creditnotes/90300000072369?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request DELETE \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The credit note has been deleted."
}
Email a credit note
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Email a credit note.
OAuth Scope : ERP.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)
Subject of the email. Max-length [1000].
body
string
(Required)
Body of the email. Max-length [5000].
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
customer_id
string
Customer ID of the customer for whom the credit note is raised.
attachments
binary
The files to be attached with the email.
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/email?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/email?organization_id=10234695")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/email?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/creditnotes/90300000072369/email?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/email?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/email?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"to_mail_ids": [
"benjamin.george@zylker.org",
"paul@zylker.org"
],
"cc_mail_ids": [
"accounts@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."
}
Get email content
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Get email content of a credit note.
OAuth Scope : ERP.creditnotes.READ
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
email_template_id
string
Get the email content based on a specific email template. If this param is not inputted, then the content will be based on the email template associated with the customer. If no template is associated with the customer, then default template will be used.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/email?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/email?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/email?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/creditnotes/90300000072369/email?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/email?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/email?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"data": [
{
"body": "The credit note is attached with this email.",
"error_list": [],
"subject": "Credit Note from Zylker Inc(Credit Note #: CN-00001)",
"emailtemplates": [
{
"selected": "fasle",
"name": "Default",
"email_template_id": "460000000000085"
}
],
"to_contacts": [
{
"first_name": "Will",
"selected": "fasle",
"phone": "+91-44-4567-8900",
"email": "willsmith@zylker.org",
"contact_person_id": "460000000026051",
"last_name": "Parker",
"salutation": "Mr.",
"mobile": "+91-9876543211"
}
],
"file_name": "CN-00001.pdf",
"from_emails": [
{
"user_name": "John Smith",
"selected": "fasle",
"email": "willsmith@zylker.org"
}
],
"customer_id": "46000000002609"
},
{...},
{...}
]
}
Void a Credit Note
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Mark the credit note as Void.
OAuth Scope : ERP.creditnotes.CREATE
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/void?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/void?organization_id=10234695")
.post(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/void?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("POST", "/erp/v3/creditnotes/90300000072369/status/void?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/status/void?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/void?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The credit note has been marked as void."
}
Convert Credit Note to Draft.
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Convert a voided credit note to Draft.
OAuth Scope : ERP.creditnotes.CREATE
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/draft?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/draft?organization_id=10234695")
.post(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/draft?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("POST", "/erp/v3/creditnotes/90300000072369/status/draft?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/status/draft?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/draft?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The credit note has been marked as Draft."
}
Convert to Open
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Convert a credit note in Draft status to Open.
OAuth Scope : ERP.creditnotes.CREATE
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/open?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/open?organization_id=10234695")
.post(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/open?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("POST", "/erp/v3/creditnotes/90300000072369/status/open?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/status/open?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/status/open?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "Status of the credit note has been changed to open."
}
Submit a credit note for approval
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Submit an estimate for approval.
OAuth Scope : ERP.creditnotes.CREATE
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/submit?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/submit?organization_id=10234695")
.post(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/submit?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("POST", "/erp/v3/creditnotes/90300000072369/submit?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/submit?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/submit?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The Credit Note has been successfully submitted for approval."
}
Approve a credit note.
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Approve a credit note.
OAuth Scope : ERP.creditnotes.CREATE
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/approve?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/approve?organization_id=10234695")
.post(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/approve?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("POST", "/erp/v3/creditnotes/90300000072369/approve?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/approve?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/approve?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "You have approved the Credit Note."
}
Email history
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Get email history of a credit code.
OAuth Scope : ERP.creditnotes.READ
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"email_history": [
{
"mailhistory_id": 982000000570005,
"from": "gator@zylker.org",
"to_mail_ids": [
"benjamin.george@zylker.org",
"paul@zylker.org"
],
"subject": "Credit note for subscription.",
"date": "2016-06-05"
},
{...},
{...}
]
}
Update billing address
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Updates the billing address for an existing credit note alone.
OAuth Scope : ERP.creditnotes.UPDATE
Arguments
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.
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/address/billing?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/address/billing?organization_id=10234695")
.put(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/address/billing?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/erp/v3/creditnotes/90300000072369/address/billing?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/address/billing?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/address/billing?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"address": "4900 Hopyard Rd, Suite 310",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "USA",
"fax": "+91-44-4567-8901"
}
{
"code": 0,
"message": "Billing address updated"
}
Update Shipping address
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Updates the shipping address for an existing credit note alone.
OAuth Scope : ERP.creditnotes.UPDATE
Arguments
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.
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695")
.put(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/erp/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"address": "Suite 125, McMillan Avenue",
"city": "San Francisco",
"state": "CA",
"zip": 94134,
"country": "USA",
"fax": "+91-44-4567-8901"
}
{
"code": 0,
"message": "Shipping address updated"
}
List credit note template
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Get all credit note pdf templates.
OAuth Scope : ERP.creditnotes.READ
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/templates?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/templates?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/templates?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/creditnotes/templates?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/templates?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/templates?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"templates": [
{
"template_name": "Standard Template",
"template_id": "90300000001336",
"template_type": "professional"
},
{...},
{...}
]
}
Update a credit note template
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Update the pdf template associated with the credit note.
OAuth Scope : ERP.creditnotes.UPDATE
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
template_id
string
(Required)
Unique identifier of the credit note template.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695"
type: PUT
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695")
.put(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("PUT", "/erp/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request PUT \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The credit note has been updated."
}
Credit to an invoice
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Apply credit note to existing invoices.
OAuth Scope : ERP.creditnotes.CREATE
Arguments
invoices
array
List of invoices for which the credit note has been raised. This contains
invoice_id and amount. invoice_id
string
(Required)
Invoice ID of the required invoice.
amount_applied
double
(Required)
The total amount applied form the credit note on an invoice.
invoice_id
string
(Required)
Invoice ID of the required invoice.
amount_applied
double
(Required)
The total amount applied form the credit note on an invoice.
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"invoices": [
{
"invoice_id": "90300000079426",
"amount_applied": 41.82
}
],
"invoice_id": "90300000079426",
"amount_applied": 41.82
}
{
"code": 0,
"message": "Credits have been applied to the invoice(s)."
}
List invoices credited
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
List invoices to which the credit note is applied.
OAuth Scope : ERP.creditnotes.READ
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"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
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Delete the credits applied to an invoice.
OAuth Scope : ERP.creditnotes.DELETE
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
creditnote_invoice_id
string
(Required)
Unique identifier of the credit note invoice.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695")
.delete(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'DELETE',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/erp/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request DELETE \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "Credits applied to an invoice have been deleted."
}
Add a comment
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Add a comment to an existing credit note.
OAuth Scope : ERP.creditnotes.CREATE
Arguments
description
string
A small description about the item.
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"code": 0,
"message": "Comments added."
}
List credit note comments & history
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Get history and comments of a credit note.
OAuth Scope : ERP.creditnotes.READ
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"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": "John Smith",
"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
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Delete a credit note comment.
OAuth Scope : ERP.creditnotes.DELETE
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
comment_id
string
(Required)
Unique identifier of the comment.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695")
.delete(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'DELETE',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/erp/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request DELETE \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The comment has been deleted."
}
List credit note refunds
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
List all refunds with pagination.
OAuth Scope : ERP.creditnotes.READ
Query Parameters
organization_id
string
(Required)
ID of the organization
customer_id
string
Customer ID of the customer for whom the credit note is raised.
sort_column
string
Sort refunds list. Allowed Values:
refund_mode, reference_number, date, creditnote_number, customer_name, amount_bcy and amount_fcy page
integer
Page number for pagination. Specify which page of results to retrieve. Default value is 1.
per_page
integer
Number of records to be fetched per page. Default value is 200.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/refunds?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/refunds?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/refunds?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/creditnotes/refunds?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/refunds?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/refunds?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"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",
"payment_form": "cash",
"reference_number": "INV-384",
"creditnote_number": "CN-29",
"customer_name": "Zylker Inc",
"description": "",
"amount_bcy": 10,
"amount_fcy": 10
},
{...},
{...}
],
"page_context": {
"page": 1,
"per_page": 10,
"has_more_page": false,
"report_name": "Credit Notes Refund",
"sort_column": "created_time",
"sort_order": "D"
}
}
Refund credit note
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Refund credit note amount.
OAuth Scope : ERP.creditnotes.CREATE
Arguments
date
string
The date on which the credit note is raised. Must be in yyyy-mm-dd format. This date determines the accounting period and affects tax calculations.
refund_mode
string
The method of refund.
payment_form
string
Mode of vendor payment.
reference_number
string
Optional reference number for tracking purposes. Can be any custom string or auto-generated. Useful for linking to external systems or internal tracking. Max-Length [100]
amount
double
Amount paid for the invoice.
exchange_rate
string
Exchange rate for converting the credit note currency to base currency. Required when currency differs from base currency. Retrieve rates from currency exchange rate APIs.
from_account_id
string
The account from which credit note is refunded.
description
string
Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document.
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"date": "2016-06-05",
"refund_mode": "cash",
"payment_form": "cash",
"reference_number": "INV-384",
"amount": 450,
"exchange_rate": "5.5",
"from_account_id": " ",
"description": "prorated amount for items"
}
{
"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",
"payment_form": "cash",
"reference_number": "INV-384",
"amount": 450,
"customer_name": "Zylker Inc",
"description": "prorated amount for items"
}
}
List refunds of a credit note
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
List all refunds of an existing credit note.
OAuth Scope : ERP.creditnotes.READ
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
Query Parameters
organization_id
string
(Required)
ID of the organization
page
integer
Page number for pagination. Specify which page of results to retrieve. Default value is 1.
per_page
integer
Number of records to be fetched per page. Default value is 200.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"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",
"payment_form": "cash",
"reference_number": "INV-384",
"creditnote_number": "CN-29",
"customer_name": "Zylker Inc",
"description": "",
"amount_bcy": 10,
"amount_fcy": 10
},
{...},
{...}
],
"page_context": {
"page": 1,
"per_page": 10,
"has_more_page": false,
"report_name": "Credit Notes Refund",
"sort_column": "created_time",
"sort_order": "D"
}
}
Update credit note refund
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Update the refunded transaction.
OAuth Scope : ERP.creditnotes.UPDATE
Arguments
date
string
The date on which the credit note is raised. Must be in yyyy-mm-dd format. This date determines the accounting period and affects tax calculations.
refund_mode
string
The method of refund.
payment_form
string
Mode of vendor payment.
reference_number
string
Optional reference number for tracking purposes. Can be any custom string or auto-generated. Useful for linking to external systems or internal tracking. Max-Length [100]
amount
double
Amount paid for the invoice.
exchange_rate
string
Exchange rate for converting the credit note currency to base currency. Required when currency differs from base currency. Retrieve rates from currency exchange rate APIs.
from_account_id
string
The account from which credit note is refunded.
description
string
Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document.
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
creditnote_refund_id
string
(Required)
Unique identifier of the credit note refund.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695")
.put(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"date": "2016-06-05",
"refund_mode": "cash",
"payment_form": "cash",
"reference_number": "INV-384",
"amount": 450,
"exchange_rate": "5.5",
"from_account_id": " ",
"description": "prorated amount for items"
}
{
"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",
"payment_form": "cash",
"reference_number": "INV-384",
"amount": 450,
"customer_name": "Zylker Inc",
"description": "prorated amount for items"
}
}
Get credit note refund
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Get refund of a particular credit note.
OAuth Scope : ERP.creditnotes.READ
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
creditnote_refund_id
string
(Required)
Unique identifier of the credit note refund.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"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",
"payment_form": "cash",
"reference_number": "INV-384",
"amount": 450,
"customer_name": "Zylker Inc",
"description": "prorated amount for items"
}
}
Delete credit note refund
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Delete a credit note refund.
OAuth Scope : ERP.creditnotes.DELETE
Path Parameters
creditnote_id
string
(Required)
Unique identifier of the credit note.
creditnote_refund_id
string
(Required)
Unique identifier of the credit note refund.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695")
.delete(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'DELETE',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request DELETE \
--url 'https://www.zohoapis.in/erp/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The refund has been successfully deleted."
}
{ "description": "Credits applied to invoice INV-00004" }