Credit Notes
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. Note
While creating credit notes from Sales Order Invoice or Sales Return, it is recommended to use the same values which are used in the Invoice for corresponding nodes in the credit note.
Attribute
place of contact
given for the contact will be taken)For GCC Edition: Supported codes for UAE Emirates states include
AB
,AJ
,DU
,FU
,RA
,SH
,UM
Supported codes for the GCC countries include
AE
,SA
,BH
,KW
,OM
,QA
.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
).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
. business_gst
, business_none
, overseas
, consumer
.vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
,dz_vat_registered
and dz_vat_not_registered
.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX.open
, closed
or void
.invoice_id
and amount
.Create a credit note
To create a credit note for a customer.
OAuth Scope : ZohoInventory.creditnotes.CREATE
Arguments
business_gst
, business_none
, overseas
, consumer
.vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
,dz_vat_registered
and dz_vat_not_registered
.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)For GCC Edition: Supported codes for UAE Emirates states include
AB
,AJ
,DU
,FU
,RA
,SH
,UM
Supported codes for the GCC countries include
AE
,SA
,BH
,KW
,OM
,QA
.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 all Credit Notes
List all the Credit Notes.
OAuth Scope : ZohoInventory.creditnotes.READ
Query Parameters
open
, closed
or void
.item_description_startswith
and item_description_contains
. Max-length [100]Status.All
Status.Open
Status.Draft
Status.Closed
and Status.Void
customer_name
creditnote_number
balance
total
date
and created_time
Update a credit note
To update the details of an existing creditnote.
OAuth Scope : ZohoInventory.creditnotes.UPDATE
Arguments
business_gst
, business_none
, overseas
, consumer
.vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
,dz_vat_registered
and dz_vat_not_registered
.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)For GCC Edition: Supported codes for UAE Emirates states include
AB
,AJ
,DU
,FU
,RA
,SH
,UM
Supported codes for the GCC countries include
AE
,SA
,BH
,KW
,OM
,QA
.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
Fetch the details of an existing creditnote.
OAuth Scope : ZohoInventory.creditnotes.READ
Query Parameters
true
, false
, on
and off
json
, pdf
and html
Delete a credit note
Delete an existing credit note.
OAuth Scope : ZohoInventory.creditnotes.DELETE
Email a credit note
Email a credit note.
OAuth Scope : ZohoInventory.creditnotes.CREATE
Arguments
Query Parameters
Get email content
Get email content of a credit note.
OAuth Scope : ZohoInventory.creditnotes.READ
Query Parameters
Void a Credit Note
Mark the credit note as Void.
OAuth Scope : ZohoInventory.creditnotes.CREATE
Convert Credit Note to Draft.
Convert a voided credit note to Draft.
OAuth Scope : ZohoInventory.creditnotes.CREATE
Convert credit note to Open
Convert a credit note in Draft status to Open.
OAuth Scope : ZohoInventory.creditnotes.CREATE
Submit a credit note for approval
Submit a credit note for approval.
OAuth Scope : ZohoInventory.creditnotes.CREATE
Approve a credit note.
Approve a credit note.
OAuth Scope : ZohoInventory.creditnotes.CREATE
Email history
Get email history of a credit code.
OAuth Scope : ZohoInventory.creditnotes.READ
Update billing address
Updates the billing address for an existing credit note.
OAuth Scope : ZohoInventory.creditnotes.UPDATE
Arguments
Update Shipping address
Updates the shipping address for an existing credit note.
OAuth Scope : ZohoInventory.creditnotes.UPDATE
Arguments
List the credit note templates
Get all credit note pdf templates.
OAuth Scope : ZohoInventory.creditnotes.READ
Update a credit note template
Update the pdf template associated with the credit note.
OAuth Scope : ZohoInventory.creditnotes.UPDATE
Apply credits to invoices
Apply credit note to existing invoices.
OAuth Scope : ZohoInventory.creditnotes.CREATE
Arguments
invoice_id
and amount
.List invoices credited
List invoices to which the credit note is applied.
OAuth Scope : ZohoInventory.creditnotes.READ
Delete credits applied to an invoice
Delete the credits applied to an invoice.
OAuth Scope : ZohoInventory.creditnotes.DELETE
Add a comment
Add a comment to an existing credit note.
OAuth Scope : ZohoInventory.creditnotes.CREATE
Arguments
List credit note comments & history
Get history and comments of a credit note.
OAuth Scope : ZohoInventory.creditnotes.READ
Delete a Comment
Delete a credit note comment.
OAuth Scope : ZohoInventory.creditnotes.DELETE
List credit note refunds
List all refunds with pagination.
OAuth Scope : ZohoInventory.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 : ZohoInventory.creditnotes.CREATE
Arguments
List refunds of a credit note
List all refunds of an existing credit note.
OAuth Scope : ZohoInventory.creditnotes.READ
Update credit note refund
Update the refunded transaction.
OAuth Scope : ZohoInventory.creditnotes.UPDATE
Arguments
Get credit note refund
Fetch the refund of a particular credit note.
OAuth Scope : ZohoInventory.creditnotes.READ
Delete credit note refund
Delete a credit note refund.
OAuth Scope : ZohoInventory.creditnotes.DELETE