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.
Attribute
place of contact
given for the contact will be taken)Supported codes for UAE emirates are :
Abu Dhabi -
AB
,Ajman -
AJ
,Dubai -
DU
,Fujairah -
FU
,Ras al-Khaimah -
RA
,Sharjah -
SH
,Umm al-Quwain -
UM
Supported codes for the GCC countries are :
United Arab Emirates -
AE
,Saudi Arabia -
SA
,Bahrain -
BH
,Kuwait -
KW
,Oman -
OM
,Qatar -
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
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).vat_registered
)Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
open
, closed
or void
.Supported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.goods
or services
.For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
invoice_id
and amount
.Create a credit note
Details of an existing creditnote.
OAuth Scope : ZohoBooks.creditnotes.CREATE
Arguments
Supported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.goods
or services
.For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
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
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).vat_registered
)Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
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)Supported codes for UAE emirates are :
Abu Dhabi -
AB
,Ajman -
AJ
,Dubai -
DU
,Fujairah -
FU
,Ras al-Khaimah -
RA
,Sharjah -
SH
,Umm al-Quwain -
UM
Supported codes for the GCC countries are :
United Arab Emirates -
AE
,Saudi Arabia -
SA
,Bahrain -
BH
,Kuwait -
KW
,Oman -
OM
,Qatar -
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
Update a credit note using a custom field's unique value
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 : ZohoBooks.invoices.UPDATE
Arguments
Supported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.goods
or services
.For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
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
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).vat_registered
)Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
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)Supported codes for UAE emirates are :
Abu Dhabi -
AB
,Ajman -
AJ
,Dubai -
DU
,Fujairah -
FU
,Ras al-Khaimah -
RA
,Sharjah -
SH
,Umm al-Quwain -
UM
Supported codes for the GCC countries are :
United Arab Emirates -
AE
,Saudi Arabia -
SA
,Bahrain -
BH
,Kuwait -
KW
,Oman -
OM
,Qatar -
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
).List all Credit Notes
List all the Credit Notes.
OAuth Scope : ZohoBooks.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
Details of an existing creditnote.
OAuth Scope : ZohoBooks.creditnotes.UPDATE
Arguments
Supported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.goods
or services
.For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
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
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).vat_registered
)Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
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)Supported codes for UAE emirates are :
Abu Dhabi -
AB
,Ajman -
AJ
,Dubai -
DU
,Fujairah -
FU
,Ras al-Khaimah -
RA
,Sharjah -
SH
,Umm al-Quwain -
UM
Supported codes for the GCC countries are :
United Arab Emirates -
AE
,Saudi Arabia -
SA
,Bahrain -
BH
,Kuwait -
KW
,Oman -
OM
,Qatar -
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
Details of an existing creditnote.
OAuth Scope : ZohoBooks.creditnotes.READ
Query Parameters
true
, false
, on
and off
json
, pdf
and html
Delete a credit note
Delete an existing credit note.
OAuth Scope : ZohoBooks.creditnotes.DELETE
Email a credit note
Email a credit note.
OAuth Scope : ZohoBooks.creditnotes.CREATE
Arguments
Query Parameters
Get email content
Get email content of a credit note.
OAuth Scope : ZohoBooks.creditnotes.READ
Query Parameters
Void a Credit Note
Mark the credit note as Void.
OAuth Scope : ZohoBooks.creditnotes.CREATE
Convert Credit Note to Draft.
Convert a voided credit note to Draft.
OAuth Scope : ZohoBooks.creditnotes.CREATE
Convert to Open
Convert a credit note in Draft status to Open.
OAuth Scope : ZohoBooks.creditnotes.CREATE
Submit a credit note for approval
Submit an estimate for approval.
OAuth Scope : ZohoBooks.creditnotes.CREATE
Approve a credit note.
Approve a credit note.
OAuth Scope : ZohoBooks.creditnotes.CREATE
Email history
Get email history of a credit code.
OAuth Scope : ZohoBooks.creditnotes.READ
Update billing address
Updates the billing address for an existing credit note alone.
OAuth Scope : ZohoBooks.creditnotes.UPDATE
Arguments
Update Shipping address
Updates the shipping address for an existing credit note alone.
OAuth Scope : ZohoBooks.creditnotes.UPDATE
Arguments
List credit note template
Get all credit note pdf templates.
OAuth Scope : ZohoBooks.creditnotes.READ
Update a credit note template
Update the pdf template associated with the credit note.
OAuth Scope : ZohoBooks.creditnotes.UPDATE
Credit to an invoice
Apply credit note to existing invoices.
OAuth Scope : ZohoBooks.creditnotes.CREATE
Arguments
invoice_id
and amount
.List invoices credited
List invoices to which the credit note is applied.
OAuth Scope : ZohoBooks.creditnotes.READ
Delete invoices credited
Delete the credits applied to an invoice.
OAuth Scope : ZohoBooks.creditnotes.DELETE
Add a comment
Add a comment to an existing credit note.
OAuth Scope : ZohoBooks.creditnotes.CREATE
Arguments
List credit note comments & history
Get history and comments of a credit note.
OAuth Scope : ZohoBooks.creditnotes.READ
Delete a Comment
Delete a credit note comment.
OAuth Scope : ZohoBooks.creditnotes.DELETE
List credit note refunds
List all refunds with pagination.
OAuth Scope : ZohoBooks.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 : ZohoBooks.creditnotes.CREATE
Arguments
List refunds of a credit note
List all refunds of an existing credit note.
OAuth Scope : ZohoBooks.creditnotes.READ
Update credit note refund
Update the refunded transaction.
OAuth Scope : ZohoBooks.creditnotes.UPDATE
Arguments
Get credit note refund
Get refund of a particular credit note.
OAuth Scope : ZohoBooks.creditnotes.READ
Delete credit note refund
Delete a credit note refund.
OAuth Scope : ZohoBooks.creditnotes.DELETE