Zoho Inventory Credit Notes API
Credit-Notes Module
Zoho Inventory Credit Notes API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Credit Notes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 29 operations across 20 paths, and defines 175 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
29 operations
20 paths
175 schemas
4 DELETE10 GET10 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory Credit Notes API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 29
Across 20 paths, the API surfaces 29 operations — 4 DELETE, 10 GET, 10 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Credit Notes 29
Credit-Notes Module
POST
/creditnotes
Create a credit note
GET
/creditnotes
List all Credit Notes
PUT
/creditnotes/{creditnote_id}
Update a credit note
GET
/creditnotes/{creditnote_id}
Get a credit note
DELETE
/creditnotes/{creditnote_id}
Delete a credit note
POST
/creditnotes/{creditnote_id}/email
Email a credit note
GET
/creditnotes/{creditnote_id}/email
Get email content
POST
/creditnotes/{creditnote_id}/void
Void a Credit Note
POST
/creditnotes/{creditnote_id}/draft
Convert Credit Note to Draft
POST
/creditnotes/{creditnote_id}/converttoopen
Convert credit note to Open
POST
/creditnotes/{creditnote_id}/submit
Submit a credit note for approval
POST
/creditnotes/{creditnote_id}/approve
Approve a credit note
GET
/creditnotes/{creditnote_id}/emailhistory
Email history
PUT
/creditnotes/{creditnote_id}/address/billing
Update billing address
PUT
/creditnotes/{creditnote_id}/address/shipping
Update Shipping address
GET
/creditnotes/templates
List the credit note templates
PUT
/creditnotes/{creditnote_id}/templates/{template_id}
Update a credit note template
GET
/creditnotes/{creditnote_id}/invoices
List invoices credited
POST
/creditnotes/{creditnote_id}/invoices
Apply credits to invoices
DELETE
/creditnotes/{creditnote_id}/invoices/{creditnote_invoice_id}
Delete credits applied to an invoice
GET
/creditnotes/{creditnote_id}/comments
List credit note comments & history
POST
/creditnotes/{creditnote_id}/comments
Add a comment
DELETE
/creditnotes/{creditnote_id}/comments/{comment_id}
Delete a Comment
GET
/creditnotes/refunds
List credit note refunds
GET
/creditnotes/{creditnote_id}/refunds
List refunds of a credit note
POST
/creditnotes/{creditnote_id}/refunds
Refund credit note
GET
/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}
Get credit note refund
PUT
/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}
Update credit note refund
DELETE
/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}
Delete credit note refund
Schemas 175
The contract defines 175 schemas that model the data the API accepts and returns. The most detailed are creditnote-response (36 properties), update-a-credit-note-request (35 properties), create-a-credit-note-request (28 properties), refund-credit-note-request (7 properties). Each schema is shown below with its type and property counts.
attention
string
add-a-comment-response
object
2 properties
amount
number
Amount paid for the invoice.
zip
string
Zip code of the customer's billing address.
per_page
integer
to_mail_ids
array
The email IDs to which the credit note is to be mailed.
is_pre_gst
boolean
Applicable for transactions that were created before July 1, 2017
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100]
list-invoices-credited-response
object
3 properties
created_time
string
Time at which the credit note was created.
refund-credit-note-response
object
3 properties
commented_by_id
string
address
string
Billing address for the invoice
apply-credits-to-invoices-request
object
3 properties
2 required
get-credit-note-refund-response
object
3 properties
has_more_page
boolean
avatax_use_code
string
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter…
customer_name
string
Name of the customer to whom the credit note is raised. Max-Length [100]
sat_item_key_code
string
Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.
line_items
array
Line items of a credit note.
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
list-the-credit-note-templates-response
object
3 properties
terms
string
Terms & condition to be displayed in the credit note. Max-length [10000]
amount_bcy
integer
sort_column
string
Sort the credit notes by the following columns - customername, creditnotenumber, balance, total, date and createdtime. Allowed Values customername creditnotenu…
update-credit-note-refund-request
object
7 properties
list-refunds-of-a-credit-note-response
object
4 properties
void-a-credit-note-response
object
2 properties
email-a-credit-note-request
object
4 properties
3 required
amount_applied
number
The total amount applied from the credit note on an invoice.
creditnote-response
object
36 properties
storages-update
array
Bin/storage locations allocated for the line item. Applicable only for items with bin tracking enabled.
is_returned_to_stock
boolean
Defines the receivability of the items in the sales return. For example, if a sales return has been raised for five units of an item where three units are rece…
account_id
string
Unique ID to denote the account.
transaction_type
string
unitkey_code
string
Add Unit Key Code for your goods/services. Download the CFDI Catalogs.
get-email-content-response
object
3 properties
custom_fields
array
Additional fields for the Credit-Notes.
cc_mail_ids
array
The email IDs that have to be copied when the credit note is to be mailed.
state
string
State of the customer's billing address.
contact_persons_associated
array
Contact Persons associated with the credit note.
comment_type
string
balance
number
The unapplied credits.
ignore_auto_number_generation
boolean
Set to true if you need to provide your own credit note number.
avatax_exempt_no
string
Exemption certificate number of the customer. Max-length [25]
unit
string
Measurement unit of the line item. For example, kgs, Nos..
cfdi_reference_type
string
Choose CFDI Reference Type. Allowed values: creditnote , debitnote , returnofmerchandise , substitutionpreviouscfdi , transferofgoods , invoicegeneratedfromord…
account_name
string
Name of the account.
hsn_or_sac
string
Add HSN/SAC code for your goods/services
template_id
string
Unique ID of the creditnote template
mapped_items
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
item_custom_fields
array
List of custom fields associated with the line item
invoice_item_id
string
lineitemid of the underlying items in the invoice. This node is used when an invoice (of a sales order) or a sales return is converted to a credit note. Along…
currency_symbol
string
Customer's currency symbol.
batches-response
array
Batches tracked for the line item. Returned for items with batch tracking enabled.
salesreturn_item_id
string
lineitemid of the underlying items in the sales return. This node is needed for converting sales return to credit note. Other nodes such as invoiceid, invoicei…
fax
string
Customer's fax number.
vat_treatment
string
(Optional) VAT treatment for the credit notes. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk .…
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
2 properties
creditnote_refund_id
string
rate
number
Rate of the line item.
tax_exemption_code
string
Unique code of the tax exemption.
update-credit-note-refund-response
object
3 properties
refund_mode
string
The method of refund.
tax_treatment
string
VAT treatment for the credit note .Choose whether the contact falls under: vatregistered , vatnotregistered , gccvatnotregistered , gccvatregistered , nongcc ,…
status
string
Status of the credit note. This can be open , closed or void .
discount
number
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.,…
is_draft
boolean
Set to true if credit note has to be created in draft status.
approve-a-credit-note-response
object
2 properties
product_type
string
Enter goods/services
email
string
Email address of the customer.
creditnote_number
string
Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
storages-response
array
Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.
update-a-credit-note-request
object
35 properties
4 required
mapped_items_create
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
cfdi_usage
string
Choose CFDI Usage. Allowed values: acquisitionofmerchandise , returndiscountbonus , generalexpense , buildings , furnitureofficeequipment , transportequipment…
updated_time
string
Time at which the credit note details were last updated.
item_id
string
Unique string generated for the item for which a refund has to be made.
gst_no
string
15 digit GST identification number of the customer.
tax_authority_id
string
Unique ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is…
comment_id
string
The unique ID for the comment generated by the server.
tax_amount
string
Tax amount applied to the subscription.
list-credit-note-refunds-response
object
4 properties
date
string
The date on which the credit note was raised. Format [yyyy-mm-dd]
customer_id
string
Customer ID of the customer for whom the credit note is raised.
report_name
string
tds_tax_id
string
Unique ID to denote the TDS tax associated to the creditnote
creditnote_invoice_id
string
exchange_rate
string
Exchange rate for the currency associated with the customer.
item_order
integer
Order of the item in the list of line items.
quantity
integer
Quantity of the item included.
body
string
The body of the email. Max-length [5000]
description
string
A brief description about the item.
refund-credit-note-request
object
7 properties
update-billing-address-request
object
6 properties
total
number
Total credits raised in this credit note.
is_combo_product
boolean
Indicates whether the line item is a composite product.
label
string
Label of the custom field.
name
string
Name of the credit
email-history-response
object
3 properties
sort_order
string
customfield_id
string
Unique ID of the custom field.
email-a-credit-note-response
object
2 properties
update-shipping-address-request
object
6 properties
update-a-credit-note-template-response
object
2 properties
delete-credits-applied-to-an-invoice-response
object
2 properties
convert-credit-note-to-open-response
object
2 properties
type
integer
Type of the creditnote line item.
invoice_id
string
Invoice ID of the required invoice.
batches
array
Batches for the line item. Create a new batch using batchnumber or reference an existing batch using batchid . Applicable only for items with batch tracking en…
page
integer
list-credit-note-comments-and-history-response
object
3 properties
create-a-credit-note-response
object
3 properties
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
mobile
string
Mobile Number of the Contact Person.
update-shipping-address-response
object
2 properties
template_name
string
Name of the default template of the creditnote.
notes
string
A short note for the credit note. Max-length [5000]
tax_exemption_id
string
Unique ID of the tax exemption.
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
vat_reg_no
string
Enter VAT registration number.
contact_persons_associated_payload
array
Contact Persons associated with the credit note.
avatax_tax_code
string
A tax code is a unique label used to group Items (products, services, or charges) together. Refer the [link][2] for more deails. Max-length [25]
city
string
City of the customer's billing address.
add-a-comment-request
object
1 property
delete-credit-note-refund-response
object
2 properties
delete-a-credit-note-response
object
2 properties
time
string
tax_name
string
Unique name for tax.
tax_id
string
Unique ID to denote the tax associated with the credit note.
date_description
string
location_name
string
Name of the location
currency_code
string
Customer's currency code. This currency code is used in credit notes.
code
string
Unique code for the underlying line item of a credit note.
location_id
string
Location ID
line_item_id
string
Search credit notes by credit note line item id.
convert-credit-note-to-draft-response
object
2 properties
is_item_shipped
boolean
Defines the shipping status of the line item in the corresponding sales order. The value of this node should be 'True' in order to create a credit note from sa…
creditnote_id
string
Unique ID of the credit note generated by the server.
delete-a-comment-response
object
2 properties
operation_type
string
update-billing-address-response
object
2 properties
mapped_items_update
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
create-a-credit-note-request
object
28 properties
4 required
from
string
The email ID from which the credit note is to be mailed.
country
string
Country of the customer's billing address.
combo_type
string
Type of the composite item. Allowed values are assembly and kit .
transaction_id
string
The transaction ID associated with the involved credit notes.
credited_amount
number
The total amount that is credited.
phone
string
Phone Number of the Contact Person.
place_of_supply
string
Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken) For GCC Edition: Supported codes for UAE E…
last_name
string
Last Name of the Contact Person.
street2
string
update-a-credit-note-response
object
3 properties
template_type
string
invoice_number
string
Invoice number of the required invoice.
value
string
Value of the custom field.
list-all-credit-notes-response
object
3 properties
submit-a-credit-note-for-approval-response
object
2 properties
invoices
array
List of invoices for which the credit note has been raised. This contains invoiceid and amount .
subject
string
The subject of the email. Max-length [1000]
storages
array
Bin/storage locations allocated for the line item. Applicable only for items with bin tracking enabled.
get-a-credit-note-response
object
3 properties
apply-credits-to-invoices-response
object
2 properties
from_account_id
string
The account from which credit note is refunded.
commented_by
string
The name of the user who commented.
contact_person_name
string
Name of the Contact Person
first_name
string
First Name of the Contact Person.
contact_person_email
string
Email ID of the Contact Person.
batches-update
array
Batches for the line item. Create a new batch using batchnumber or reference an existing batch using batchid . Applicable only for items with batch tracking en…
is_inclusive_tax
boolean
Used to specify whether the line item rates are inclusive(true) or exclusive(false) of tax.
mailhistory_id
string
amount_fcy
integer
contact_person_id
string
Unique ID of the Contact Person.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho Inventory 12
Other APIs Zoho Inventory publishes across the network.
Zoho Inventory Batches API
Zoho Inventory Bills API
Zoho Inventory Compositeitems API
Zoho Inventory Contact Persons API
Zoho Inventory Contacts API
Zoho Inventory Currency API
Zoho Inventory Customer Payments API
Zoho Inventory Delivery Challans API
Zoho Inventory Inventoryadjustments API
Zoho Inventory Invoices API
Zoho Inventory Items API
Zoho Inventory Landedcosts API
#Credit Notes
Where this information came from
This is an independent, third-party profile of Zoho Inventory Credit Notes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.