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.0.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.
list-refunds-of-a-credit-note-response
object
4 properties
list-invoices-credited-response
object
3 properties
item_custom_fields
array
List of custom fields associated with the line item
transaction_id
string
The transaction ID associated with the involved credit notes.
create-a-credit-note-response
object
3 properties
creditnote_invoice_id
string
terms
string
Terms & condition to be displayed in the credit note. Max-length [10000]
contact_persons_associated
array
Contact Persons associated with the credit note.
list-credit-note-comments-and-history-response
object
3 properties
is_draft
boolean
Set to true if credit note has to be created in draft status.
delete-credits-applied-to-an-invoice-response
object
2 properties
approve-a-credit-note-response
object
2 properties
email-history-response
object
3 properties
zip
string
Zip code of the customer's billing address.
code
string
Unique code for the underlying line item of a credit note.
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…
page
integer
item_id
string
Unique string generated for the item for which a refund has to be made.
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…
avatax_exempt_no
string
Exemption certificate number of the customer. Max-length [25]
get-email-content-response
object
3 properties
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…
create-a-credit-note-request
object
28 properties
4 required
account_id
string
Unique ID to denote the account.
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
sat_item_key_code
string
Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.
date
string
The date on which the credit note was raised. Format [yyyy-mm-dd]
per_page
integer
custom_fields
array
Additional fields for the Credit-Notes.
amount_applied
number
The total amount applied from the credit note on an invoice.
apply-credits-to-invoices-response
object
2 properties
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…
value
string
Value of the custom field.
to_mail_ids
array
The email IDs to which the credit note is to be mailed.
currency_symbol
string
Customer's currency symbol.
unitkey_code
string
Add Unit Key Code for your goods/services. Download the CFDI Catalogs.
contact_person_email
string
Email ID of the Contact Person.
body
string
The body of the email. Max-length [5000]
sort_order
string
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.
update-billing-address-response
object
2 properties
cc_mail_ids
array
The email IDs that have to be copied when the credit note is to be mailed.
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 .…
country
string
Country of the customer's billing address.
status
string
Status of the credit note. This can be open , closed or void .
label
string
Label of the custom field.
phone
string
Phone Number of the Contact Person.
transaction_type
string
hsn_or_sac
string
Add HSN/SAC code for your goods/services
from
string
The email ID from which the credit note is to be mailed.
attention
string
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]
quantity
integer
Quantity of the item included.
storages-response
array
Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.
apply-credits-to-invoices-request
object
3 properties
2 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.
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.,…
name
string
Name of the credit
from_account_id
string
The account from which credit note is refunded.
refund-credit-note-response
object
3 properties
add-a-comment-request
object
1 property
customer_name
string
Name of the customer to whom the credit note is raised. Max-Length [100]
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
invoice_id
string
Invoice ID of the required invoice.
updated_time
string
Time at which the credit note details were last updated.
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
2 properties
time
string
creditnote-response
object
36 properties
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…
line_item_id
string
Search credit notes by credit note line item id.
ignore_auto_number_generation
boolean
Set to true if you need to provide your own credit note number.
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100]
submit-a-credit-note-for-approval-response
object
2 properties
location_id
string
Location ID
comment_id
string
The unique ID for the comment generated by the server.
type
integer
Type of the creditnote line item.
is_pre_gst
boolean
Applicable for transactions that were created before July 1, 2017
operation_type
string
update-a-credit-note-response
object
3 properties
description
string
A brief description about the item.
mobile
string
Mobile Number of the Contact Person.
cfdi_reference_type
string
Choose CFDI Reference Type. Allowed values: creditnote , debitnote , returnofmerchandise , substitutionpreviouscfdi , transferofgoods , invoicegeneratedfromord…
storages
array
Bin/storage locations allocated for the line item. Applicable only for items with bin tracking enabled.
delete-credit-note-refund-response
object
2 properties
line_items
array
Line items of a credit note.
date_description
string
amount
number
Amount paid for the invoice.
mailhistory_id
string
notes
string
A short note for the credit note. Max-length [5000]
currency_code
string
Customer's currency code. This currency code is used in credit notes.
update-billing-address-request
object
6 properties
update-shipping-address-request
object
6 properties
update-a-credit-note-template-response
object
2 properties
storages-update
array
Bin/storage locations allocated for the line item. Applicable only for items with bin tracking enabled.
address
string
Billing address for the invoice
email-a-credit-note-response
object
2 properties
is_inclusive_tax
boolean
Used to specify whether the line item rates are inclusive(true) or exclusive(false) of tax.
commented_by
string
The name of the user who commented.
invoice_number
string
Invoice number of the required invoice.
list-all-credit-notes-response
object
3 properties
update-credit-note-refund-response
object
3 properties
vat_reg_no
string
Enter VAT registration number.
update-a-credit-note-request
object
35 properties
4 required
creditnote_refund_id
string
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…
customer_id
string
Customer ID of the customer for whom the credit note is raised.
delete-a-credit-note-response
object
2 properties
street2
string
refund_mode
string
The method of refund.
email
string
Email address of the customer.
list-credit-note-refunds-response
object
4 properties
has_more_page
boolean
contact_person_name
string
Name of the Contact Person
tax_treatment
string
VAT treatment for the credit note .Choose whether the contact falls under: vatregistered , vatnotregistered , gccvatnotregistered , gccvatregistered , nongcc ,…
list-the-credit-note-templates-response
object
3 properties
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…
add-a-comment-response
object
2 properties
comment_type
string
invoices
array
List of invoices for which the credit note has been raised. This contains invoiceid and amount .
exchange_rate
string
Exchange rate for the currency associated with the customer.
fax
string
Customer's fax number.
batches-response
array
Batches tracked for the line item. Returned for items with batch tracking enabled.
last_name
string
Last Name of the Contact Person.
unit
string
Measurement unit of the line item. For example, kgs, Nos..
delete-a-comment-response
object
2 properties
created_time
string
Time at which the credit note was created.
item_order
integer
Order of the item in the list of line items.
template_name
string
Name of the default template of the creditnote.
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
refund-credit-note-request
object
7 properties
cfdi_usage
string
Choose CFDI Usage. Allowed values: acquisitionofmerchandise , returndiscountbonus , generalexpense , buildings , furnitureofficeequipment , transportequipment…
update-shipping-address-response
object
2 properties
rate
number
Rate of the line item.
product_type
string
Enter goods/services
commented_by_id
string
tax_exemption_id
string
Unique ID of the tax exemption.
tax_exemption_code
string
Unique code of the tax exemption.
subject
string
The subject of the email. Max-length [1000]
first_name
string
First Name of the Contact Person.
creditnote_id
string
Unique ID of the credit note generated by the server.
tax_id
string
Unique ID to denote the tax associated with the credit note.
contact_persons_associated_payload
array
Contact Persons associated with the credit note.
get-a-credit-note-response
object
3 properties
convert-credit-note-to-draft-response
object
2 properties
get-credit-note-refund-response
object
3 properties
location_name
string
Name of the location
template_id
string
Unique ID of the creditnote template
convert-credit-note-to-open-response
object
2 properties
combo_type
string
Type of the composite item. Allowed values are assembly and kit .
template_type
string
amount_fcy
integer
void-a-credit-note-response
object
2 properties
balance
number
The unapplied credits.
amount_bcy
integer
city
string
City of the customer's billing address.
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
is_combo_product
boolean
Indicates whether the line item is a composite product.
report_name
string
creditnote_number
string
Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]
customfield_id
string
Unique ID of the custom field.
sort_column
string
Sort the credit notes by the following columns - customername, creditnotenumber, balance, total, date and createdtime. Allowed Values customername creditnotenu…
total
number
Total credits raised in this credit note.
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…
tds_tax_id
string
Unique ID to denote the TDS tax associated to the creditnote
tax_amount
string
Tax amount applied to the subscription.
account_name
string
Name of the account.
credited_amount
number
The total amount that is credited.
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.
state
string
State of the customer's billing address.
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…
email-a-credit-note-request
object
4 properties
3 required
gst_no
string
15 digit GST identification number of the customer.
contact_person_id
string
Unique ID of the Contact Person.
tax_name
string
Unique name for tax.
update-credit-note-refund-request
object
7 properties
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 itemgroups API
Zoho Inventory items API
#credit-notes