Credit Notes AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Create a new credit note to record credits issued to customers for returned items, overpayments, or adjustments. Supports multi-currency transactions, custom line items, tax calculations, and workflows.
OAuth Scope : ZohoBooks.creditnotes.CREATE

Arguments

customer_id

string

(Required)

Unique identifier for the customer contact. Retrieve customer IDs from the Get Customers API endpoint in the contacts section. This ID links the credit note to the specific customer record.

currency_id

string

Unique identifier for the currency used in the credit note. Can differ from customer currency if multi-currency is enabled. Retrieve currency IDs from the List Currencies API endpoint in the currency section.

contact_persons_associated

array

Contact Persons associated with the transaction.

Show Sub-Attributes

contact_person_id

string

Unique ID of the Contact Person.

communication_preference

object

Preferred modes of communication for the contact person at transaction level.

Show Sub-Attributes

is_email_enabled

boolean

Used to check if Email communication preference is enabled for the contact person at transaction level.

is_whatsapp_enabled

boolean

WhatsApp integration only

Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.

date

string

(Required)

The date on which the credit note is raised. Must be in yyyy-mm-dd format. This date determines the accounting period and affects tax calculations.

is_draft

boolean

Set to true to create the credit note in draft status. Draft credit notes are not finalized and can be modified before sending to customers.

exchange_rate

string

Exchange rate for converting the credit note currency to base currency. Required when currency differs from base currency. Retrieve rates from currency exchange rate APIs.

line_items

array

(Required)

Array of line items for the credit note. Each line item represents a product or service being credited to the customer.

Show Sub-Attributes

item_id

string

Unique identifier for the item in the line item. Retrieve item IDs from the List Items API endpoint in the items section. Links the line item to a specific product or service.

invoice_id

string

Invoice ID of the required invoice.

invoice_item_id

string

Unique identifier of the invoice line item that this credit note line item references. Use this when creating a credit note for a specific invoice line item.

description

string

Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document.

code

string

Unique code or SKU for the line item. Used for product identification and inventory tracking. Helps distinguish between different variants of the same product.

name

string

Name or title of the line item. Describes the product or service being credited. This name is displayed on the credit note document.

type

integer

Type of the credit note line item. Numeric value indicating the line item type (e.g., 1 for product, 2 for service). Used for categorization and reporting purposes.

account_id

string

Unique identifier for the chart of accounts entry. Retrieve account IDs from the List Chart of Accounts API endpoint. Determines which account the line item affects for accounting purposes.

account_name

string

Name of the chart of accounts entry. Displays the account name for reference and reporting purposes. Should match the account_id provided.

quantity

int32

Number of units being credited for this line item. Must be a positive number. Used to calculate the total amount for the line item.

tax_id

string

Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.

tds_tax_id

string

🇲🇽 Mexico

only

Unique ID to denote the TDS tax associated to the creditnote

tax_treatment_code

string

GCC only

Specify reason for using out of scope.
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.

product_type

string

Type of product or service for the line item. Standard values: goods or services. For South Africa: service, goods, capital_service, and capital_goods.

sat_item_key_code

string

🇲🇽 Mexico

only

Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.

unitkey_code

string

🇲🇽 Mexico

only

Add Unit Key Code for your goods/services. Download the CFDI Catalogs.

serial_numbers

string

Serial numbers of the items being credited. Used for tracking specific units of inventory or equipment. Important for warranty and return tracking.

location_id

string

Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.

project_id

string

Unique identifier for the project associated with the line item. Links the credit to a specific project for project-based accounting and reporting.

tags

array

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.

Show Sub-Attributes

tag_id

string

Tag's ID

tag_option_id

string

Tag Option's ID

location_id

string

Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.

creditnote_number

string

(Required)

Unique credit note number displayed in the interface. Auto-generated with CN prefix unless ignore_auto_number_generation is true. Max-Length [100]

gst_treatment

string

🇮🇳 India

only

Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .

tax_treatment

string

GCC , 🇲🇽 Mexico

, 🇰🇪 Kenya

, 🇿🇦 South Africa

only

VAT treatment for the credit note .Choose whether the contact falls under: 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).

is_reverse_charge_applied

boolean

🇿🇦 South Africa

only

(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

gst_no

string

🇮🇳 India

only

15 digit GST identification number of the customer.

cfdi_usage

string

🇲🇽 Mexico

only

Choose CFDI Usage.
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.

cfdi_reference_type

string

🇲🇽 Mexico

only

Choose CFDI Reference Type.
Allowed values: credit_note, debit_note, return_of_merchandise, substitution_previous_cfdi, transfer_of_goods, invoice_generated_from_order, cfdi_for_advance.

place_of_supply

string

🇮🇳 India

, GCC only

Place where the goods/services are supplied to. (If not given, 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.

ignore_auto_number_generation

boolean

Set to true to provide a custom credit note number instead of auto-generated CN prefix. When true, you must specify creditnote_number manually.

reference_number

string

Optional reference number for tracking purposes. Can be any custom string or auto-generated. Useful for linking to external systems or internal tracking. Max-Length [100]

custom_fields

array

Additional fields for the Credit-Notes.

tags

array

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.

Show Sub-Attributes

tag_id

string

Tag's ID

tag_option_id

string

Tag Option's ID

notes

string

Additional notes or comments for the credit note. Displayed on the credit note document for customer reference. Max-length [5000]

terms

string

Terms and conditions displayed on the credit note document. Include payment terms, return policies, or other business conditions. Max-length [10000]

template_id

string

Unique identifier for the credit note PDF template. Retrieve template IDs from the List Credit Note Templates API endpoint. Determines the visual layout and branding of the credit note document.

tax_id

string

Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.

tax_authority_id

string

🇺🇸 United States

only

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 NY tax authority.

tax_exemption_id

string

🇮🇳 India

, 🇺🇸 United States

, 🇦🇺 Australia

, 🇨🇦 Canada

only

Unique ID of the tax exemption.

avatax_use_code

string

Avalara Integration only

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 a custom code. Max-length [25]

avatax_exempt_no

string

Avalara Integration only

Exemption certificate number of the customer. Max-length [25]

vat_treatment

string

🇬🇧 United Kingdom

only

(Optional) VAT treatment for the invoices. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is 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).

is_inclusive_tax

boolean

Not applicable 🇺🇸 United States

, 🇨🇦 Canada

Used to specify whether the line item rates are inclusive or exclusive of tax.

avatax_tax_code

string

Avalara Integration only

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]

Query Parameters

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

customer_id

string

(Required)

Unique identifier for the customer contact. Retrieve customer IDs from the Get Customers API endpoint in the contacts section. This ID links the credit note to the specific customer record.

currency_id

string

Unique identifier for the currency used in the credit note. Can differ from customer currency if multi-currency is enabled. Retrieve currency IDs from the List Currencies API endpoint in the currency section.

contact_persons_associated

array

Contact Persons associated with the transaction.

Show Sub-Attributes

contact_person_id

string

Unique ID of the Contact Person.

communication_preference

object

Preferred modes of communication for the contact person at transaction level.

Show Sub-Attributes

is_email_enabled

boolean

Used to check if Email communication preference is enabled for the contact person at transaction level.

is_whatsapp_enabled

boolean

WhatsApp integration only

Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.

date

string

(Required)

The date on which the credit note is raised. Must be in yyyy-mm-dd format. This date determines the accounting period and affects tax calculations.

is_draft

boolean

Set to true to create the credit note in draft status. Draft credit notes are not finalized and can be modified before sending to customers.

exchange_rate

string

Exchange rate for converting the credit note currency to base currency. Required when currency differs from base currency. Retrieve rates from currency exchange rate APIs.

line_items

array

(Required)

Line items of a credit note.

Show Sub-Attributes

item_id

string

Unique identifier for the item in the line item. Retrieve item IDs from the List Items API endpoint in the items section. Links the line item to a specific product or service.

line_item_id

string

Search credit notes by credit note line item id.

account_id

string

Unique identifier for the chart of accounts entry. Retrieve account IDs from the List Chart of Accounts API endpoint. Determines which account the line item affects for accounting purposes.

name

string

Name or title of the line item. Describes the product or service being credited. This name is displayed on the credit note document.

description

string

Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document.

item_order

integer

Enter order of the item

rate

double

Rate of the line item.

quantity

int32

Number of units being credited for this line item. Must be a positive number. Used to calculate the total amount for the line item.

unit

string

Unit of the line item. E.g: kgs, Nos.

discount

double

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., 10%). For example, on Rs.1000, a 10% discount results in Rs.900, while a flat Rs.200 discount results in Rs.800.

tax_id

string

Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.

tds_tax_id

string

🇲🇽 Mexico

only

Unique ID to denote the TDS tax associated to the creditnote

tax_exemption_id

string

🇮🇳 India

, 🇺🇸 United States

, 🇦🇺 Australia

, 🇨🇦 Canada

only

Unique ID of the tax exemption.

tax_exemption_code

string

🇮🇳 India

, 🇺🇸 United States

, 🇦🇺 Australia

, 🇨🇦 Canada

, 🇲🇽 Mexico

only

Unique code of the tax exemption.

tax_treatment_code

string

GCC only

Specify reason for using out of scope.
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.

avatax_use_code

string

Avalara Integration only

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 a custom code. Max-length [25]

avatax_tax_code

string

Avalara Integration only

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]

product_type

string

Type of product or service for the line item. Standard values: goods or services. For South Africa: service, goods, capital_service, and capital_goods.

hsn_or_sac

string

🇮🇳 India

, 🇰🇪 Kenya

, 🇿🇦 South Africa

only

Add HSN/SAC code for your goods/services

sat_item_key_code

string

🇲🇽 Mexico

only

Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.

unitkey_code

string

🇲🇽 Mexico

only

Add Unit Key Code for your goods/services. Download the CFDI Catalogs.

item_custom_fields

array

Enter custom field information

location_id

string

Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.

location_name

string

Name of the location.

serial_numbers

string

Serial numbers of the items being credited. Used for tracking specific units of inventory or equipment. Important for warranty and return tracking.

project_id

string

Unique identifier for the project associated with the line item. Links the credit to a specific project for project-based accounting and reporting.

tags

array

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.

Show Sub-Attributes

tag_id

string

Tag's ID

tag_name

string

Tag's Name

tag_option_id

string

Tag Option's ID

tag_option_name

string

Tag Option's Name

is_tag_mandatory

boolean

Used to check if the tag is mandatory

location_id

string

Unique identifier for the business location associated with the line item. Retrieve location IDs from the List Locations API endpoint in the locations section. Determines tax settings and business rules for this line item.

creditnote_number

string

(Required)

Unique credit note number displayed in the interface. Auto-generated with CN prefix unless ignore_auto_number_generation is true. Max-Length [100]

gst_treatment

string

🇮🇳 India

only

Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .

tax_treatment

string

GCC , 🇲🇽 Mexico

, 🇰🇪 Kenya

, 🇿🇦 South Africa

only

VAT treatment for the credit note .Choose whether the contact falls under: 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).

is_reverse_charge_applied

boolean

🇿🇦 South Africa

only

(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

gst_no

string

🇮🇳 India

only

15 digit GST identification number of the customer.

cfdi_usage

string

🇲🇽 Mexico

only

Choose CFDI Usage.
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.

cfdi_reference_type

string

🇲🇽 Mexico

only

Choose CFDI Reference Type.
Allowed values: credit_note, debit_note, return_of_merchandise, substitution_previous_cfdi, transfer_of_goods, invoice_generated_from_order, cfdi_for_advance.

place_of_supply

string

🇮🇳 India

, GCC only

Place where the goods/services are supplied to. (If not given, 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.

ignore_auto_number_generation

boolean

Set to true to provide a custom credit note number instead of auto-generated CN prefix. When true, you must specify creditnote_number manually.

reference_number

string

Optional reference number for tracking purposes. Can be any custom string or auto-generated. Useful for linking to external systems or internal tracking. Max-Length [100]

custom_fields

array

Additional fields for the Credit-Notes.

tags

array

Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.

Show Sub-Attributes

tag_id

string

Tag's ID

tag_option_id

string

Tag Option's ID

notes

string

Additional notes or comments for the credit note. Displayed on the credit note document for customer reference. Max-length [5000]

terms

string

Terms and conditions displayed on the credit note document. Include payment terms, return policies, or other business conditions. Max-length [10000]

template_id

string

Unique identifier for the credit note PDF template. Retrieve template IDs from the List Credit Note Templates API endpoint. Determines the visual layout and branding of the credit note document.

tax_id

string

Unique identifier for the tax applied to the line item. Retrieve tax IDs from the List Taxes API endpoint in the taxes section. Determines tax calculations for this specific line item.

tax_authority_id

string

🇺🇸 United States

only

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 NY tax authority.

tax_exemption_id

string

🇮🇳 India

, 🇺🇸 United States

, 🇦🇺 Australia

, 🇨🇦 Canada

only

Unique ID of the tax exemption.

avatax_use_code

string

Avalara Integration only

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 a custom code. Max-length [25]

avatax_exempt_no

string

Avalara Integration only

Exemption certificate number of the customer. Max-length [25]

vat_treatment

string

🇬🇧 United Kingdom

only

(Optional) VAT treatment for the invoices. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is 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).

is_inclusive_tax

boolean

Not applicable 🇺🇸 United States

, 🇨🇦 Canada

Used to specify whether the line item rates are inclusive or exclusive of tax.

item_id

string

Unique identifier for the item in the line item. Retrieve item IDs from the List Items API endpoint in the items section. Links the line item to a specific product or service.

account_id

string

Unique identifier for the chart of accounts entry. Retrieve account IDs from the List Chart of Accounts API endpoint. Determines which account the line item affects for accounting purposes.

name

string

Name or title of the line item. Describes the product or service being credited. This name is displayed on the credit note document.

avatax_tax_code

string

Avalara Integration only

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]

description

string

Detailed description of the line item. Provides additional information about the product or service being credited. Displayed on the credit note document.

unit

string

Unit of the line item. E.g: kgs, Nos.

rate

double

Rate of the line item.

quantity

int32

Number of units being credited for this line item. Must be a positive number. Used to calculate the total amount for the line item.

Query Parameters

Headers

Retrieve a paginated list of credit notes with comprehensive filtering, sorting, and search capabilities. Use query parameters to filter by date, status, amount, customer details, items, taxes, and custom fields.
OAuth Scope : ZohoBooks.creditnotes.READ

Query Parameters