Credit Notes
A credit note is a promisory note issued to a person, when we owe him money. Credit notes are created when a refund is to be made to a customer. A credit note object allows you to keep track of all credit note related information.
Possible error codes:
Error Code | Message |
---|---|
1002 | Credit Note does not exists |
12003 | Credit notes that are in closed status cannot be applied to invoices |
12004 | Credit notes that are in void status cannot be applied to invoices |
12005 | Credits cannot be applied to invoices in the draft status |
12006 | Credits cannot be applied to invoices in the closed status |
12007 | Credits cannot be applied to invoices in the void status |
12018 | The specified Credit Note Number already exists |
Attribute
Maximum Length [100]
Date Format [yyyy-mm-dd]
open
, closed
or void
.Maximum Length of the name [100]
Maximum Length [100]
Maximum length [5000]
Maximum length [10000]
Create a credit note
Details of an existing creditnote.
OAuth Scope : ZohoInvoice.creditnotes.CREATE
Arguments
Date Format [yyyy-mm-dd]
Maximum length [25]
Maximum length [25]
Maximum Length [100]
business_gst
, business_none
, overseas
, consumer
.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX.Allowed values:
acquisition_of_merchandise
, return_discount_bonus
, general_expense
, buildings
, furniture_office_equipment
, transport_equipment
, computer_equipmentdye_molds_tools
, telephone_communication
, satellite_communication
, other_machinery_equipment
, hospital_expense
, medical_expense_disability
, funeral_expense
, donation
, interest_mortage_loans
, contribution_sar
, medical_expense_insurance_pormium
, school_transportation_expense
, deposit_saving_account
, payment_educational_service
, no_tax_effect
, payment
, payroll
.Allowed values:
credit_note
, debit_note
, return_of_merchandise
, substitution_previous_cfdi
, transfer_of_goods
, invoice_generated_from_order
, cfdi_for_advance
.place of contact
given for the contact will be taken)Maximum Length [100]
Maximum length [5000]
Maximum length [10000]
Maximum length [25]
Maximum length [25]
Maximum length [25]
uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered
, if he resides outside of the UK then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).Query Parameters
List Credit Notes
List all the Credit Notes.
OAuth Scope : ZohoInvoice.creditnotes.READ
Query Parameters
Maximum Length [100]
Date Format [yyyy-mm-dd]
open
, closed
or void
.Maximum Length [100]
Maximum Length of the name [100]
Maximum length [100]
item_description_startswith
and item_description_contains
. Maximum length [100]
Status.All
Status.Open
Status.Draft
Status.Closed
and Status.Void
Maximum length [100]
customer_name
creditnote_number
balance
total
date
and created_time
Update a credit note
Update Details of an existing creditnote.
OAuth Scope : ZohoInvoice.creditnotes.UPDATE
Arguments
Date Format [yyyy-mm-dd]
Maximum length [25]
Maximum length [25]
Maximum Length [100]
business_gst
, business_none
, overseas
, consumer
.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX.Allowed values:
acquisition_of_merchandise
, return_discount_bonus
, general_expense
, buildings
, furniture_office_equipment
, transport_equipment
, computer_equipmentdye_molds_tools
, telephone_communication
, satellite_communication
, other_machinery_equipment
, hospital_expense
, medical_expense_disability
, funeral_expense
, donation
, interest_mortage_loans
, contribution_sar
, medical_expense_insurance_pormium
, school_transportation_expense
, deposit_saving_account
, payment_educational_service
, no_tax_effect
, payment
, payroll
.Allowed values:
credit_note
, debit_note
, return_of_merchandise
, substitution_previous_cfdi
, transfer_of_goods
, invoice_generated_from_order
, cfdi_for_advance
.place of contact
given for the contact will be taken)Maximum Length [100]
Maximum length [5000]
Maximum length [10000]
Maximum length [25]
Maximum length [25]
Maximum length [25]
uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered
, if he resides outside of the UK then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).Query Parameters
Get a credit note
Details of an existing creditnote.
OAuth Scope : ZohoInvoice.creditnotes.READ
Query Parameters
true
, false
, on
and off
json
, pdf
and html
Delete a credit note
Delete an existing credit note.
OAuth Scope : ZohoInvoice.creditnotes.DELETE
Email a credit note
Email a credit note.
OAuth Scope : ZohoInvoice.creditnotes.CREATE
Arguments
Maximum length [1000]
Maximum length [5000]
Query Parameters
Void a credit note
To mark a credit note as invalid/nullify it content.
OAuth Scope : ZohoInvoice.creditnotes.CREATE
Open a voided credit note
Convert a voided credit note to open.
OAuth Scope : ZohoInvoice.creditnotes.CREATE
Email history
Get email history of a credit code.
OAuth Scope : ZohoInvoice.creditnotes.READ
Update billing address
Updates the billing address for an existing credit note alone.
OAuth Scope : ZohoInvoice.creditnotes.UPDATE
Arguments
Update Shipping address
Updates the shipping address for an existing credit note alone.
OAuth Scope : ZohoInvoice.creditnotes.UPDATE
Arguments
List credit note templates
Get all credit note pdf templates.
OAuth Scope : ZohoInvoice.creditnotes.READ
Update a credit note template
Update the pdf template associated with the credit note.
OAuth Scope : ZohoInvoice.creditnotes.UPDATE
Credit to an invoice
Apply credit note to existing invoices.
OAuth Scope : ZohoInvoice.creditnotes.CREATE
Arguments
List invoices credited
List invoices to which the credit note is applied.
OAuth Scope : ZohoInvoice.creditnotes.READ
Delete invoices credited
Delete the credits applied to an invoice.
OAuth Scope : ZohoInvoice.creditnotes.DELETE
Add a comment
Add a comment to an existing credit note.
OAuth Scope : ZohoInvoice.creditnotes.CREATE
Arguments
List credit note comments & history
Get history and comments of a credit note.
OAuth Scope : ZohoInvoice.creditnotes.READ
Delete a Comment
Delete a credit note comment.
OAuth Scope : ZohoInvoice.creditnotes.DELETE
List credit note refunds
List all refunds with pagination.
OAuth Scope : ZohoInvoice.creditnotes.READ
Query Parameters
refund_mode
, reference_number
, date
, creditnote_number
, customer_name
, amount_bcy
and amount_fcy
Refund credit note
Refund credit note amount.
OAuth Scope : ZohoInvoice.creditnotes.CREATE
Arguments
Date Format [yyyy-mm-dd]
Maximum Length [100]
List refunds of a credit note
List all refunds of an existing credit note.
OAuth Scope : ZohoInvoice.creditnotes.READ
Update credit note refund
Update the refunded transaction.
OAuth Scope : ZohoInvoice.creditnotes.UPDATE
Arguments
Date Format [yyyy-mm-dd]
Maximum Length [100]
Get credit note refund
Get refund of a particular credit note.
OAuth Scope : ZohoInvoice.creditnotes.READ
Delete credit note refund
Delete a credit note refund.
OAuth Scope : ZohoInvoice.creditnotes.DELETE