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.

End Points

POST

/creditnotes

/creditnotes/{creditnote_id}

GET

/creditnotes/{creditnote_id}

DELETE

/creditnotes/{creditnote_id}

POST

/creditnotes/{creditnote_id}/email

GET

/creditnotes/{creditnote_id}/email

POST

/creditnotes/{creditnote_id}/status/void

POST

/creditnotes/{creditnote_id}/status/draft

POST

/creditnotes/{creditnote_id}/status/open

POST

/creditnotes/{creditnote_id}/submit

POST

/creditnotes/{creditnote_id}/approve

GET

/creditnotes/{creditnote_id}/emailhistory

PUT

/creditnotes/{creditnote_id}/address/billing

PUT

/creditnotes/{creditnote_id}/address/shipping

GET

/creditnotes/templates

PUT

/creditnotes/{creditnote_id}/templates/{template_id}

POST

/creditnotes/{creditnote_id}/invoices

GET

/creditnotes/{creditnote_id}/invoices

DELETE

/creditnotes/{creditnote_id}/invoices/{creditnote_invoice_id}

POST

/creditnotes/{creditnote_id}/comments

GET

/creditnotes/{creditnote_id}/comments

DELETE

/creditnotes/{creditnote_id}/comments/{comment_id}

GET

/creditnotes/refunds

POST

/creditnotes/{creditnote_id}/refunds

GET

/creditnotes/{creditnote_id}/refunds

PUT

/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}

GET

/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}

DELETE

/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}

Attribute

creditnote_id

string

Unique ID of the credit note generated by the server.

creditnote_number

string

Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]

date

string

The date on which credit note is raised. Format [yyyy-mm-dd]

is_pre_gst

boolean

🇮🇳 only

Applicable for transactions that fall before july 1, 2017

place_of_supply

string

🇮🇳 , 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.

vat_treatment

string

🇬🇧 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).

vat_reg_no

string

Enter VAT registration number.

gst_no

string

🇮🇳 only

15 digit GST identification number of the customer.

cfdi_usage

string

🇲🇽 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

🇲🇽 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.

gst_treatment

string

🇮🇳 only

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

tax_treatment

string

GCC , 🇲🇽 , 🇰🇪 , 🇿🇦 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

🇿🇦 only

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

status

string

Status of the credit note. This can be open, closed or void.

customer_id

string

Customer ID of the customer for whom the credit note is raised.

customer_name

string

Name of the customer to whom the credit note is raised. Max-Length [100]

custom_fields

array

Additional fields for the Credit-Notes.

Show Sub-Attributes

index

integer

Index of the custom field. It can hold any value from 1 to 10.

value

string

Value of the custom field.

label

string

Label of the custom field.

data_type

string

Data type of the custom field.

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]

string

Email address of the customer.

total

double

Total credits raised in this credit note.

balance

double

The unapplied credits.

line_items

array

Line items of a credit note.

Show Sub-Attributes

item_id

string

Unique string generated for the item to which a refund is to be made.

line_item_id

string

Search credit notes by credit note line item id.

account_id

string

Unique ID to denote the account.

name

string

Name of the credit

description

string

A small description about the item.

item_order

integer

Enter order of the item

rate

double

Rate of the line item.

quantity

int32

Quantity of the item included.

unit

string

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

discount

double

Enter discount percentage.

tax_id

string

Unique to denote the tax associated to the creditnote

tds_tax_id

string

🇲🇽 only

Unique ID to denote the TDS tax associated to the creditnote

tax_exemption_id

string

🇮🇳 , 🇺🇸 , 🇦🇺 , 🇨🇦 only

Unique ID of the tax exemption.

tax_exemption_code

string

🇮🇳 , 🇺🇸 , 🇦🇺 , 🇨🇦 , 🇲🇽 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

Enter Enter goods or services .
For SouthAfrica Edition: service, goods, capital_service and capital_goods

hsn_or_sac

string

🇮🇳 , 🇰🇪 , 🇿🇦 only

Add HSN/SAC code for your goods/services

sat_item_key_code

string

🇲🇽 only

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

unitkey_code

string

🇲🇽 only

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

item_custom_fields

array

Enter custom field information

warehouse_id

string

ID of the warehouse

serial_numbers

string

Enter serial number

project_id

string

ID of the project

invoices

array

List of invoices for which the credit note has been raised. This contains invoice_id and amount.

Show Sub-Attributes

invoice_id

string

Invoice ID of the required invoice.

invoice_number

string

Invoice number of the required invoice.

amount

double

Amount paid for the invoice.

taxes

array

Taxes associated wit the subscription.

Show Sub-Attributes

tax_id

string

Unique to denote the tax associated to the creditnote

tax_name

string

Unique name for tax.

tax_amount

string

Tax amount applied to the subscription.

currency_code

string

Customer's currency code. This currency code is used in credit notes.

currency_symbol

string

Customer's currency symbol.

billing_address

object

Show Sub-Attributes

address

string

Billing address for the invoice

street2

string

city

string

City of the customer’s billing address.

state

string

State of the customer’s billing address.

zip

string

Zip code of the customer’s billing address.

country

string

Country of the customer’s billing address.

fax

string

Customer's fax number.

shipping_address

object

Show Sub-Attributes

address

string

Billing address for the invoice

street2

string

city

string

City of the customer’s billing address.

state

string

State of the customer’s billing address.

zip

string

Zip code of the customer’s billing address.

country

string

Country of the customer’s billing address.

fax

string

Customer's fax number.

created_time

string

Time at which the credit note was created.

updated_time

string

Time at which the credit note details were last updated.

template_id

string

Unique ID of the creditnote template

template_name

string

Name of the default template of the creditnote.

notes

string

A short note for the credit note. Max-length [5000]

terms

string

Terms & condition to be displayed in the credit note. Max-length [10000]

{
    "creditnote_id": "90300000072369",
    "creditnote_number": "CN-29",
    "date": "2016-06-05",
    "is_pre_gst": true,
    "place_of_supply": "TN",
    "vat_treatment": "overseas",
    "vat_reg_no": "string",
    "gst_no": "22AAAAA0000A1Z5",
    "cfdi_usage": "acquisition_of_merchandise",
    "cfdi_reference_type": "return_of_merchandise",
    "gst_treatment": "business_gst",
    "tax_treatment": "vat_registered",
    "is_reverse_charge_applied": true,
    "status": "draft",
    "customer_id": "903000000000099",
    "customer_name": "Bowman Furniture",
    "custom_fields": [
        {
            "index": 1,
            "value": 129890,
            "label": "label",
            "data_type": "text"
        }
    ],
    "reference_number": "INV-384",
    "email": "benjamin.george@bowmanfurniture.com",
    "total": 450,
    "balance": 10,
    "line_items": [
        {
            "item_id": "90300000081501",
            "line_item_id": 903000006245,
            "account_id": "903000000000388",
            "name": "Basic Monthly",
            "description": "prorated amount for items",
            "item_order": 0,
            "rate": 0,
            "quantity": 1,
            "unit": "kgs",
            "discount": 10,
            "tax_id": "903000000000356",
            "tds_tax_id": "903000000000357",
            "tax_exemption_id": "903000006345",
            "tax_exemption_code": "GST FREE",
            "tax_treatment_code": "uae_others",
            "avatax_use_code": "string",
            "avatax_tax_code": "string",
            "product_type": "goods",
            "hsn_or_sac": 80540,
            "sat_item_key_code": 71121206,
            "unitkey_code": "box",
            "item_custom_fields": [
                "string"
            ],
            "warehouse_id": 90300000072378,
            "serial_numbers": "string",
            "project_id": 90300000087378
        }
    ],
    "invoices": [
        {
            "invoice_id": "90300000079426",
            "invoice_number": "INV-384",
            "amount": 450
        }
    ],
    "taxes": [
        {
            "tax_id": "903000000000356",
            "tax_name": "Basic Tax",
            "tax_amount": "2.50"
        }
    ],
    "currency_code": "USD",
    "currency_symbol": "$",
    "billing_address": {
        "address": "4900 Hopyard Rd, Suite 310",
        "street2": "McMillan Avenue",
        "city": "Pleasanton",
        "state": "CA",
        "zip": 94588,
        "country": "U.S.A",
        "fax": "+1-925-924-9600"
    },
    "shipping_address": {
        "address": "4900 Hopyard Rd, Suite 310",
        "street2": "McMillan Avenue",
        "city": "Pleasanton",
        "state": "CA",
        "zip": 94588,
        "country": "U.S.A",
        "fax": "+1-925-924-9600"
    },
    "created_time": "2016-06-05T02:30:08-0700",
    "updated_time": "2016-06-05T02:30:08-0700",
    "template_id": "90300000001336",
    "template_name": "Standard Template",
    "notes": "Offer for the referral",
    "terms": ""
}

Create a credit note

Details of an existing creditnote.
OAuth Scope : ZohoBooks.creditnotes.CREATE

Arguments

customer_id

string

(Required)

Customer ID of the customer for whom the credit note is raised.

currency_id

string

contact_persons

array

Contact Persons associated with the credit note.

date

string

(Required)

The date on which credit note is raised. Format [yyyy-mm-dd]

is_draft

boolean

Set to true if credit note has to be created in draft status.

exchange_rate

string

Exchange rate for the currency associated with the customer.

line_items

array

(Required)

Line items of a credit note.

Show Sub-Attributes

item_id

string

Unique string generated for the item to which a refund is to be made.

description

string

A small description about the item.

code

string

Unique code for the creditnote line item.

name

string

Name of the credit

type

integer

Type of the creditnote line item.

account_id

string

Unique ID to denote the account.

account_name

string

Name of the account.

quantity

int32

Quantity of the item included.

tax_id

string

Unique to denote the tax associated to the creditnote

tds_tax_id

string

🇲🇽 only

Unique ID to denote the TDS tax associated to the creditnote

tax_treatment_code

string

GCC only

product_type

string

Enter Enter goods or services .
For SouthAfrica Edition: service, goods, capital_service and capital_goods

sat_item_key_code

string

🇲🇽 only

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

unitkey_code

string

🇲🇽 only

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

serial_numbers

string

Enter serial number

warehouse_id

string

ID of the warehouse

warehouse_name

string

Name of the warehouse.

project_id

string

ID of the project

creditnote_number

string

(Required)

Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]

gst_treatment

string

🇮🇳 only

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

tax_treatment

string

GCC , 🇲🇽 , 🇰🇪 , 🇿🇦 only

is_reverse_charge_applied

boolean

🇿🇦 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

🇮🇳 only

15 digit GST identification number of the customer.

cfdi_usage

string

🇲🇽 only

cfdi_reference_type

string

🇲🇽 only

place_of_supply

string

🇮🇳 , GCC only

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]

custom_fields

array

Additional fields for the Credit-Notes.

notes

string

A short note for the credit note. Max-length [5000]

terms

string

Terms & condition to be displayed in the credit note. Max-length [10000]

template_id

string

Unique ID of the creditnote template

tax_id

string

Unique to denote the tax associated to the creditnote

tax_authority_id

string

🇺🇸 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

🇮🇳 , 🇺🇸 , 🇦🇺 , 🇨🇦 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

🇬🇧 only

is_inclusive_tax

boolean

Not applicable 🇺🇸 , 🇨🇦

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

invoice_id

Invoice ID of the required invoice.

ignore_auto_number_generation

Set to true if you need to provide your own credit note number.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/books/v3/creditnotes?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "customer_id": "903000000000099",
    "currency_id": "982000000567240",
    "contact_persons": [
        "903000006532"
    ],
    "date": "2016-06-05",
    "is_draft": true,
    "exchange_rate": "5.5",
    "line_items": [
        {
            "item_id": "90300000081501",
            "description": "prorated amount for items",
            "code": "basic-monthly",
            "name": "Basic Monthly",
            "type": 1,
            "account_id": "903000000000388",
            "account_name": "Sales",
            "quantity": 1,
            "tax_id": "903000000000356",
            "tds_tax_id": "903000000000357",
            "tax_treatment_code": "uae_others",
            "product_type": "goods",
            "sat_item_key_code": 71121206,
            "unitkey_code": "box",
            "serial_numbers": "string",
            "warehouse_id": 90300000072378,
            "warehouse_name": "string",
            "project_id": 90300000087378
        }
    ],
    "creditnote_number": "CN-29",
    "gst_treatment": "business_gst",
    "tax_treatment": "vat_registered",
    "is_reverse_charge_applied": true,
    "gst_no": "22AAAAA0000A1Z5",
    "cfdi_usage": "acquisition_of_merchandise",
    "cfdi_reference_type": "return_of_merchandise",
    "place_of_supply": "TN",
    "ignore_auto_number_generation": false,
    "reference_number": "INV-384",
    "custom_fields": [
        "string"
    ],
    "notes": "Offer for the referral",
    "terms": "",
    "template_id": "90300000001336",
    "tax_id": "903000000000356",
    "tax_authority_id": "903000006345",
    "tax_exemption_id": "903000006345",
    "avatax_use_code": "string",
    "avatax_exempt_no": "string",
    "vat_treatment": "overseas",
    "is_inclusive_tax": "fasle",
    "avatax_tax_code": "string"
}

{
    "code": 0,
    "message": "The credit note has been created.",
    "creditnote": {
        "creditnote_id": "90300000072369",
        "creditnote_number": "CN-29",
        "date": "2016-06-05",
        "is_pre_gst": true,
        "place_of_supply": "TN",
        "vat_treatment": "overseas",
        "vat_reg_no": "string",
        "gst_no": "22AAAAA0000A1Z5",
        "cfdi_usage": "acquisition_of_merchandise",
        "cfdi_reference_type": "return_of_merchandise",
        "gst_treatment": "business_gst",
        "tax_treatment": "vat_registered",
        "is_reverse_charge_applied": true,
        "status": "draft",
        "customer_id": "903000000000099",
        "customer_name": "Bowman Furniture",
        "custom_fields": [
            {
                "index": 1,
                "value": 129890,
                "label": "label",
                "data_type": "text"
            }
        ],
        "reference_number": "INV-384",
        "email": "benjamin.george@bowmanfurniture.com",
        "total": 450,
        "balance": 10,
        "line_items": [
            {
                "item_id": "90300000081501",
                "line_item_id": 903000006245,
                "account_id": "903000000000388",
                "name": "Basic Monthly",
                "description": "prorated amount for items",
                "item_order": 0,
                "rate": 0,
                "quantity": 1,
                "unit": "kgs",
                "discount": 10,
                "tax_id": "903000000000356",
                "tds_tax_id": "903000000000357",
                "tax_exemption_id": "903000006345",
                "tax_exemption_code": "GST FREE",
                "tax_treatment_code": "uae_others",
                "avatax_use_code": "string",
                "avatax_tax_code": "string",
                "product_type": "goods",
                "hsn_or_sac": 80540,
                "sat_item_key_code": 71121206,
                "unitkey_code": "box",
                "item_custom_fields": [
                    "string"
                ],
                "warehouse_id": 90300000072378,
                "serial_numbers": "string",
                "project_id": 90300000087378
            }
        ],
        "invoices": [
            {
                "invoice_id": "90300000079426",
                "invoice_number": "INV-384",
                "amount": 450
            }
        ],
        "taxes": [
            {
                "tax_id": "903000000000356",
                "tax_name": "Basic Tax",
                "tax_amount": "2.50"
            }
        ],
        "currency_code": "USD",
        "currency_symbol": "$",
        "billing_address": {
            "address": "4900 Hopyard Rd, Suite 310",
            "street2": "McMillan Avenue",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A",
            "fax": "+1-925-924-9600"
        },
        "shipping_address": {
            "address": "4900 Hopyard Rd, Suite 310",
            "street2": "McMillan Avenue",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A",
            "fax": "+1-925-924-9600"
        },
        "created_time": "2016-06-05T02:30:08-0700",
        "updated_time": "2016-06-05T02:30:08-0700",
        "template_id": "90300000001336",
        "template_name": "Standard Template",
        "notes": "Offer for the referral",
        "terms": ""
    }
}

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

customer_id

string

(Required)

Customer ID of the customer for whom the credit note is raised.

currency_id

string

contact_persons

array

Contact Persons associated with the credit note.

date

string

(Required)

The date on which credit note is raised. Format [yyyy-mm-dd]

is_draft

boolean

Set to true if credit note has to be created in draft status.

exchange_rate

string

Exchange rate for the currency associated with the customer.

line_items

array

(Required)

Line items of a credit note.

Show Sub-Attributes

item_id

string

Unique string generated for the item to which a refund is to be made.

line_item_id

string

Search credit notes by credit note line item id.

account_id

string

Unique ID to denote the account.

name

string

Name of the credit

description

string

A small description about the item.

item_order

integer

Enter order of the item

rate

double

Rate of the line item.

quantity

int32

Quantity of the item included.

unit

string

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

discount

double

Enter discount percentage.

tax_id

string

Unique to denote the tax associated to the creditnote

tds_tax_id

string

🇲🇽 only

Unique ID to denote the TDS tax associated to the creditnote

tax_exemption_id

string

🇮🇳 , 🇺🇸 , 🇦🇺 , 🇨🇦 only

Unique ID of the tax exemption.

tax_exemption_code

string

🇮🇳 , 🇺🇸 , 🇦🇺 , 🇨🇦 , 🇲🇽 only

Unique code of the tax exemption.

tax_treatment_code

string

GCC only

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

Enter Enter goods or services .
For SouthAfrica Edition: service, goods, capital_service and capital_goods

hsn_or_sac

string

🇮🇳 , 🇰🇪 , 🇿🇦 only

Add HSN/SAC code for your goods/services

sat_item_key_code

string

🇲🇽 only

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

unitkey_code

string

🇲🇽 only

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

item_custom_fields

array

Enter custom field information

warehouse_id

string

ID of the warehouse

serial_numbers

string

Enter serial number

project_id

string

ID of the project

creditnote_number

string

(Required)

Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]

gst_treatment

string

🇮🇳 only

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

tax_treatment

string

GCC , 🇲🇽 , 🇰🇪 , 🇿🇦 only

is_reverse_charge_applied

boolean

🇿🇦 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

🇮🇳 only

15 digit GST identification number of the customer.

cfdi_usage

string

🇲🇽 only

cfdi_reference_type

string

🇲🇽 only

place_of_supply

string

🇮🇳 , GCC only

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]

custom_fields

array

Additional fields for the Credit-Notes.

notes

string

A short note for the credit note. Max-length [5000]

terms

string

Terms & condition to be displayed in the credit note. Max-length [10000]

template_id

string

Unique ID of the creditnote template

tax_id

string

Unique to denote the tax associated to the creditnote

tax_authority_id

string

🇺🇸 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

🇮🇳 , 🇺🇸 , 🇦🇺 , 🇨🇦 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

🇬🇧 only

is_inclusive_tax

boolean

Not applicable 🇺🇸 , 🇨🇦

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

item_id

string

Unique string generated for the item to which a refund is to be made.

account_id

string

Unique ID to denote the account.

name

string

Name of the credit

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

A small description about the item.

unit

string

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

rate

double

Rate of the line item.

quantity

int32

Quantity of the item included.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("X-Unique-Identifier-Key", "cf_unique_cf");
headers_data.put("X-Unique-Identifier-Value", "unique Value");
headers_data.put("X-Upsert", "true");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695")
  .put(body)
  .addHeader("X-Unique-Identifier-Key", "cf_unique_cf")
  .addHeader("X-Unique-Identifier-Value", "unique Value")
  .addHeader("X-Upsert", "true")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    'X-Unique-Identifier-Key': 'cf_unique_cf',
    'X-Unique-Identifier-Value': 'unique Value',
    'X-Upsert': 'true',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'X-Unique-Identifier-Key': "cf_unique_cf",
    'X-Unique-Identifier-Value': "unique Value",
    'X-Upsert': "true",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/books/v3/creditnotes?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes?organization_id=10234695",
  "headers": {
    "X-Unique-Identifier-Key": "cf_unique_cf",
    "X-Unique-Identifier-Value": "unique Value",
    "X-Upsert": "true",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-Unique-Identifier-Key: cf_unique_cf' \
  --header 'X-Unique-Identifier-Value: unique Value' \
  --header 'X-Upsert: true' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "customer_id": "903000000000099",
    "currency_id": "982000000567240",
    "contact_persons": [
        "903000006532"
    ],
    "date": "2016-06-05",
    "is_draft": true,
    "exchange_rate": "5.5",
    "line_items": [
        {
            "item_id": "90300000081501",
            "line_item_id": 903000006245,
            "account_id": "903000000000388",
            "name": "Basic Monthly",
            "description": "prorated amount for items",
            "item_order": 0,
            "rate": 0,
            "quantity": 1,
            "unit": "kgs",
            "discount": 10,
            "tax_id": "903000000000356",
            "tds_tax_id": "903000000000357",
            "tax_exemption_id": "903000006345",
            "tax_exemption_code": "GST FREE",
            "tax_treatment_code": "uae_others",
            "avatax_use_code": "string",
            "avatax_tax_code": "string",
            "product_type": "goods",
            "hsn_or_sac": 80540,
            "sat_item_key_code": 71121206,
            "unitkey_code": "box",
            "item_custom_fields": [
                "string"
            ],
            "warehouse_id": 90300000072378,
            "serial_numbers": "string",
            "project_id": 90300000087378
        }
    ],
    "creditnote_number": "CN-29",
    "gst_treatment": "business_gst",
    "tax_treatment": "vat_registered",
    "is_reverse_charge_applied": true,
    "gst_no": "22AAAAA0000A1Z5",
    "cfdi_usage": "acquisition_of_merchandise",
    "cfdi_reference_type": "return_of_merchandise",
    "place_of_supply": "TN",
    "ignore_auto_number_generation": false,
    "reference_number": "INV-384",
    "custom_fields": [
        "string"
    ],
    "notes": "Offer for the referral",
    "terms": "",
    "template_id": "90300000001336",
    "tax_id": "903000000000356",
    "tax_authority_id": "903000006345",
    "tax_exemption_id": "903000006345",
    "avatax_use_code": "string",
    "avatax_exempt_no": "string",
    "vat_treatment": "overseas",
    "is_inclusive_tax": "fasle",
    "item_id": "90300000081501",
    "account_id": "903000000000388",
    "name": "Basic Monthly",
    "avatax_tax_code": "string",
    "description": "prorated amount for items",
    "unit": "kgs",
    "rate": 0,
    "quantity": 1
}

{
    "code": 0,
    "message": "The credit note has been updated.",
    "creditnote": {
        "creditnote_id": "90300000072369",
        "creditnote_number": "CN-29",
        "date": "2016-06-05",
        "is_pre_gst": true,
        "place_of_supply": "TN",
        "vat_treatment": "overseas",
        "vat_reg_no": "string",
        "gst_no": "22AAAAA0000A1Z5",
        "cfdi_usage": "acquisition_of_merchandise",
        "cfdi_reference_type": "return_of_merchandise",
        "gst_treatment": "business_gst",
        "tax_treatment": "vat_registered",
        "is_reverse_charge_applied": true,
        "status": "draft",
        "customer_id": "903000000000099",
        "customer_name": "Bowman Furniture",
        "custom_fields": [
            {
                "index": 1,
                "value": 129890,
                "label": "label",
                "data_type": "text"
            }
        ],
        "reference_number": "INV-384",
        "email": "benjamin.george@bowmanfurniture.com",
        "total": 450,
        "balance": 10,
        "line_items": [
            {
                "item_id": "90300000081501",
                "description": "prorated amount for items",
                "code": "basic-monthly",
                "name": "Basic Monthly",
                "type": 1,
                "account_id": "903000000000388",
                "account_name": "Sales",
                "quantity": 1,
                "tax_id": "903000000000356",
                "tax_treatment_code": "uae_others",
                "product_type": "goods",
                "serial_numbers": "string",
                "warehouse_id": 90300000072378,
                "warehouse_name": "string",
                "project_id": 90300000087378
            }
        ],
        "invoices": [
            {
                "invoice_id": "90300000079426",
                "invoice_number": "INV-384",
                "amount": 450
            }
        ],
        "taxes": [
            {
                "tax_id": "903000000000356",
                "tax_name": "Basic Tax",
                "tax_amount": "2.50"
            }
        ],
        "currency_code": "USD",
        "currency_symbol": "$",
        "billing_address": {
            "address": "4900 Hopyard Rd, Suite 310",
            "street2": "McMillan Avenue",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A",
            "fax": "+1-925-924-9600",
            "attention": " "
        },
        "shipping_address": {
            "address": "4900 Hopyard Rd, Suite 310",
            "street2": "McMillan Avenue",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A",
            "fax": "+1-925-924-9600",
            "attention": " "
        },
        "created_time": "2016-06-05T02:30:08-0700",
        "updated_time": "2016-06-05T02:30:08-0700",
        "template_id": "90300000001336",
        "template_name": "Standard Template",
        "notes": "Offer for the referral",
        "terms": ""
    }
}

List all Credit Notes

List all the Credit Notes.
OAuth Scope : ZohoBooks.creditnotes.READ

Query Parameters

creditnote_number

Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]

date

The date on which credit note is raised. Format [yyyy-mm-dd]

status

Status of the credit note. This can be open, closed or void.

total

Total credits raised in this credit note.

reference_number

Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100]

customer_name

Name of the customer to whom the credit note is raised. Max-Length [100]

item_name

Search credit notes by item name.Max_lenght [100]

customer_id

Customer ID of the customer for whom the credit note is raised.

item_description

description for the item.Variants item_description_startswith and item_description_contains. Max-length [100]

item_id

Unique string generated for the item to which a refund is to be made.

line_item_id

Search credit notes by credit note line item id.

tax_id

Unique to denote the tax associate dto the creditnote

filter_by

Filter credit notes by statuses. Allowed values Status.All Status.Open Status.Draft Status.Closed and Status.Void

search_text

Search credit notes by credit note number or customer name or credit note reference number. Max-length [100]

sort_column

Sort credit notes by following columns customer_name, creditnote_number, balance, total, date and created_time. Allowed Values customer_name creditnote_number balance total date and created_time

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/creditnotes?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/creditnotes?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "creditnotes": {
        "creditnote_id": "90300000072369",
        "creditnote_number": "CN-29",
        "status": "draft",
        "reference_number": "INV-384",
        "date": "2016-06-05",
        "total": 450,
        "balance": 10,
        "customer_id": "903000000000099",
        "customer_name": "Bowman Furniture",
        "currency_id": "982000000567240",
        "currency_code": "USD",
        "created_time": "2016-06-05T02:30:08-0700",
        "last_modified_time": "2016-06-05T02:30:08-0700",
        "is_emailed": true
    }
}

Update a credit note

Details of an existing creditnote.
OAuth Scope : ZohoBooks.creditnotes.UPDATE

Arguments

customer_id

string

(Required)

Customer ID of the customer for whom the credit note is raised.

currency_id

string

contact_persons

array

Contact Persons associated with the credit note.

date

string

(Required)

The date on which credit note is raised. Format [yyyy-mm-dd]

is_draft

boolean

Set to true if credit note has to be created in draft status.

exchange_rate

string

Exchange rate for the currency associated with the customer.

line_items

array

(Required)

Line items of a credit note.

Show Sub-Attributes

item_id

string

Unique string generated for the item to which a refund is to be made.

line_item_id

string

Search credit notes by credit note line item id.

account_id

string

Unique ID to denote the account.

name

string

Name of the credit

description

string

A small description about the item.

item_order

integer

Enter order of the item

rate

double

Rate of the line item.

quantity

int32

Quantity of the item included.

unit

string

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

discount

double

Enter discount percentage.

tax_id

string

Unique to denote the tax associated to the creditnote

tds_tax_id

string

🇲🇽 only

Unique ID to denote the TDS tax associated to the creditnote

tax_exemption_id

string

🇮🇳 , 🇺🇸 , 🇦🇺 , 🇨🇦 only

Unique ID of the tax exemption.

tax_exemption_code

string

🇮🇳 , 🇺🇸 , 🇦🇺 , 🇨🇦 , 🇲🇽 only

Unique code of the tax exemption.

tax_treatment_code

string

GCC only

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

Enter Enter goods or services .
For SouthAfrica Edition: service, goods, capital_service and capital_goods

hsn_or_sac

string

🇮🇳 , 🇰🇪 , 🇿🇦 only

Add HSN/SAC code for your goods/services

sat_item_key_code

string

🇲🇽 only

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

unitkey_code

string

🇲🇽 only

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

item_custom_fields

array

Enter custom field information

warehouse_id

string

ID of the warehouse

serial_numbers

string

Enter serial number

project_id

string

ID of the project

creditnote_number

string

(Required)

Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]

gst_treatment

string

🇮🇳 only

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

tax_treatment

string

GCC , 🇲🇽 , 🇰🇪 , 🇿🇦 only

is_reverse_charge_applied

boolean

🇿🇦 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

🇮🇳 only

15 digit GST identification number of the customer.

cfdi_usage

string

🇲🇽 only

cfdi_reference_type

string

🇲🇽 only

place_of_supply

string

🇮🇳 , GCC only

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]

custom_fields

array

Additional fields for the Credit-Notes.

notes

string

A short note for the credit note. Max-length [5000]

terms

string

Terms & condition to be displayed in the credit note. Max-length [10000]

template_id

string

Unique ID of the creditnote template

tax_id

string

Unique to denote the tax associated to the creditnote

tax_authority_id

string

🇺🇸 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

🇮🇳 , 🇺🇸 , 🇦🇺 , 🇨🇦 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

🇬🇧 only

is_inclusive_tax

boolean

Not applicable 🇺🇸 , 🇨🇦

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

item_id

string

Unique string generated for the item to which a refund is to be made.

account_id

string

Unique ID to denote the account.

name

string

Name of the credit

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

A small description about the item.

unit

string

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

rate

double

Rate of the line item.

quantity

int32

Quantity of the item included.

Query Parameters

ignore_auto_number_generation

Set to true if you need to provide your own credit note number.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/books/v3/creditnotes/90300000072369?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "customer_id": "903000000000099",
    "currency_id": "982000000567240",
    "contact_persons": [
        "903000006532"
    ],
    "date": "2016-06-05",
    "is_draft": true,
    "exchange_rate": "5.5",
    "line_items": [
        {
            "item_id": "90300000081501",
            "line_item_id": 903000006245,
            "account_id": "903000000000388",
            "name": "Basic Monthly",
            "description": "prorated amount for items",
            "item_order": 0,
            "rate": 0,
            "quantity": 1,
            "unit": "kgs",
            "discount": 10,
            "tax_id": "903000000000356",
            "tds_tax_id": "903000000000357",
            "tax_exemption_id": "903000006345",
            "tax_exemption_code": "GST FREE",
            "tax_treatment_code": "uae_others",
            "avatax_use_code": "string",
            "avatax_tax_code": "string",
            "product_type": "goods",
            "hsn_or_sac": 80540,
            "sat_item_key_code": 71121206,
            "unitkey_code": "box",
            "item_custom_fields": [
                "string"
            ],
            "warehouse_id": 90300000072378,
            "serial_numbers": "string",
            "project_id": 90300000087378
        }
    ],
    "creditnote_number": "CN-29",
    "gst_treatment": "business_gst",
    "tax_treatment": "vat_registered",
    "is_reverse_charge_applied": true,
    "gst_no": "22AAAAA0000A1Z5",
    "cfdi_usage": "acquisition_of_merchandise",
    "cfdi_reference_type": "return_of_merchandise",
    "place_of_supply": "TN",
    "ignore_auto_number_generation": false,
    "reference_number": "INV-384",
    "custom_fields": [
        "string"
    ],
    "notes": "Offer for the referral",
    "terms": "",
    "template_id": "90300000001336",
    "tax_id": "903000000000356",
    "tax_authority_id": "903000006345",
    "tax_exemption_id": "903000006345",
    "avatax_use_code": "string",
    "avatax_exempt_no": "string",
    "vat_treatment": "overseas",
    "is_inclusive_tax": "fasle",
    "item_id": "90300000081501",
    "account_id": "903000000000388",
    "name": "Basic Monthly",
    "avatax_tax_code": "string",
    "description": "prorated amount for items",
    "unit": "kgs",
    "rate": 0,
    "quantity": 1
}

{
    "code": 0,
    "message": "The credit note has been updated.",
    "creditnote": {
        "creditnote_id": "90300000072369",
        "creditnote_number": "CN-29",
        "date": "2016-06-05",
        "is_pre_gst": true,
        "place_of_supply": "TN",
        "vat_treatment": "overseas",
        "vat_reg_no": "string",
        "gst_no": "22AAAAA0000A1Z5",
        "cfdi_usage": "acquisition_of_merchandise",
        "cfdi_reference_type": "return_of_merchandise",
        "gst_treatment": "business_gst",
        "tax_treatment": "vat_registered",
        "is_reverse_charge_applied": true,
        "status": "draft",
        "customer_id": "903000000000099",
        "customer_name": "Bowman Furniture",
        "custom_fields": [
            {
                "index": 1,
                "value": 129890,
                "label": "label",
                "data_type": "text"
            }
        ],
        "reference_number": "INV-384",
        "email": "benjamin.george@bowmanfurniture.com",
        "total": 450,
        "balance": 10,
        "line_items": [
            {
                "item_id": "90300000081501",
                "description": "prorated amount for items",
                "code": "basic-monthly",
                "name": "Basic Monthly",
                "type": 1,
                "account_id": "903000000000388",
                "account_name": "Sales",
                "quantity": 1,
                "tax_id": "903000000000356",
                "tax_treatment_code": "uae_others",
                "product_type": "goods",
                "serial_numbers": "string",
                "warehouse_id": 90300000072378,
                "warehouse_name": "string",
                "project_id": 90300000087378
            }
        ],
        "invoices": [
            {
                "invoice_id": "90300000079426",
                "invoice_number": "INV-384",
                "amount": 450
            }
        ],
        "taxes": [
            {
                "tax_id": "903000000000356",
                "tax_name": "Basic Tax",
                "tax_amount": "2.50"
            }
        ],
        "currency_code": "USD",
        "currency_symbol": "$",
        "billing_address": {
            "address": "4900 Hopyard Rd, Suite 310",
            "street2": "McMillan Avenue",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A",
            "fax": "+1-925-924-9600",
            "attention": " "
        },
        "shipping_address": {
            "address": "4900 Hopyard Rd, Suite 310",
            "street2": "McMillan Avenue",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A",
            "fax": "+1-925-924-9600",
            "attention": " "
        },
        "created_time": "2016-06-05T02:30:08-0700",
        "updated_time": "2016-06-05T02:30:08-0700",
        "template_id": "90300000001336",
        "template_name": "Standard Template",
        "notes": "Offer for the referral",
        "terms": ""
    }
}

Get a credit note

Details of an existing creditnote.
OAuth Scope : ZohoBooks.creditnotes.READ

Query Parameters

Export credit note pdf with default print option. Allowed Values: true, false, on and off

You can get credit note details as json/pdf/html. Default format is html. Allowed Values: json, pdf and html

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/creditnotes/90300000072369?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "creditnote": {
        "creditnote_id": "90300000072369",
        "creditnote_number": "CN-29",
        "date": "2016-06-05",
        "is_pre_gst": true,
        "place_of_supply": "TN",
        "vat_treatment": "overseas",
        "vat_reg_no": "string",
        "gst_no": "22AAAAA0000A1Z5",
        "cfdi_usage": "acquisition_of_merchandise",
        "cfdi_reference_type": "return_of_merchandise",
        "gst_treatment": "business_gst",
        "tax_treatment": "vat_registered",
        "is_reverse_charge_applied": true,
        "status": "draft",
        "customer_id": "903000000000099",
        "customer_name": "Bowman Furniture",
        "custom_fields": [
            {
                "index": 1,
                "value": 129890,
                "label": "label",
                "data_type": "text"
            }
        ],
        "reference_number": "INV-384",
        "email": "benjamin.george@bowmanfurniture.com",
        "total": 450,
        "balance": 10,
        "line_items": [
            {
                "item_id": "90300000081501",
                "description": "prorated amount for items",
                "code": "basic-monthly",
                "name": "Basic Monthly",
                "type": 1,
                "account_id": "903000000000388",
                "account_name": "Sales",
                "quantity": 1,
                "tax_id": "903000000000356",
                "tax_treatment_code": "uae_others",
                "product_type": "goods",
                "serial_numbers": "string",
                "warehouse_id": 90300000072378,
                "warehouse_name": "string",
                "project_id": 90300000087378,
                "project_name": "Sample Project"
            }
        ],
        "invoices": [
            {
                "invoice_id": "90300000079426",
                "invoice_number": "INV-384",
                "amount": 450
            }
        ],
        "taxes": [
            {
                "tax_id": "903000000000356",
                "tax_name": "Basic Tax",
                "tax_amount": "2.50"
            }
        ],
        "currency_code": "USD",
        "currency_symbol": "$",
        "created_time": "2016-06-05T02:30:08-0700",
        "updated_time": "2016-06-05T02:30:08-0700",
        "billing_address": {
            "address": "4900 Hopyard Rd, Suite 310",
            "street2": "McMillan Avenue",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A",
            "fax": "+1-925-924-9600",
            "attention": " "
        },
        "shipping_address": {
            "address": "4900 Hopyard Rd, Suite 310",
            "street2": "McMillan Avenue",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A",
            "fax": "+1-925-924-9600",
            "attention": " "
        },
        "template_id": "90300000001336",
        "template_name": "Standard Template",
        "notes": "Offer for the referral",
        "terms": ""
    }
}

Delete a credit note

Delete an existing credit note.
OAuth Scope : ZohoBooks.creditnotes.DELETE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/books/v3/creditnotes/90300000072369?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The credit note has been deleted."
}

Email a credit note

Email a credit note.
OAuth Scope : ZohoBooks.creditnotes.CREATE

Arguments

to_mail_ids

array

(Required)

The email IDs to which the credit note is to be mailed.

cc_mail_ids

array

The email IDs that have to be copied when the credit note is to be mailed.

subject

string

(Required)

The subject of the email. Max-length [1000]

body

string

(Required)

The body of the email. Max-length [5000]

Query Parameters

customer_id

Customer ID of the customer for whom the credit note is raised.

attachments

The files to be attached with the email.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/email?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/email?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/email?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/books/v3/creditnotes/90300000072369/email?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/email?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/email?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "to_mail_ids": [
        "benjamin.george@bowmanfurniture.com",
        "paul@bowmanfurniture.com"
    ],
    "cc_mail_ids": [
        "accounts@bowmanfurniture.com"
    ],
    "subject": "Credit note for subscription.",
    "body": "Please find attached the credit note for your subscription."
}

{
    "code": 0,
    "message": "Your creditnote has been sent."
}

Get email content

Get email content of a credit note.
OAuth Scope : ZohoBooks.creditnotes.READ

Query Parameters

email_template_id

Get the email content based on a specific email template. If this param is not inputted, then the content will be based on the email template associated with the customer. If no template is associated with the customer, then default template will be used.

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/email?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/email?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/email?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/creditnotes/90300000072369/email?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/email?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/email?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "body": "The credit note is attached with this email.",
            "error_list": [],
            "subject": "Credit Note from Zillium Inc(Credit Note #: CN-00001)",
            "emailtemplates": [
                {
                    "selected": "fasle",
                    "name": "Default",
                    "email_template_id": "460000000000085"
                }
            ],
            "to_contacts": [
                {
                    "first_name": "Will",
                    "selected": "fasle",
                    "phone": "+1-925-921-9201",
                    "email": "willsmith@bowmanfurniture.com",
                    "contact_person_id": "460000000026051",
                    "last_name": "Parker",
                    "salutation": "Mr.",
                    "mobile": "+1-4054439760"
                }
            ],
            "file_name": "CN-00001.pdf",
            "from_emails": [
                {
                    "user_name": "John Smith",
                    "selected": "fasle",
                    "email": "willsmith@bowmanfurniture.com"
                }
            ],
            "customer_id": "46000000002609"
        },
        {...},
        {...}
    ]
}

Void a Credit Note

Mark the credit note as Void.
OAuth Scope : ZohoBooks.creditnotes.CREATE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/void?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/void?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/void?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/books/v3/creditnotes/90300000072369/status/void?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/status/void?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/void?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The credit note has been marked as void."
}

Convert Credit Note to Draft.

Convert a voided credit note to Draft.
OAuth Scope : ZohoBooks.creditnotes.CREATE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/draft?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/draft?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/draft?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/books/v3/creditnotes/90300000072369/status/draft?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/status/draft?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/draft?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The credit note has been marked as Draft."
}

Convert to Open

Convert a credit note in Draft status to Open.
OAuth Scope : ZohoBooks.creditnotes.CREATE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/open?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/open?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/open?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/books/v3/creditnotes/90300000072369/status/open?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/status/open?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/status/open?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "Status of the credit note has been changed to open."
}

Submit a credit note for approval

Submit an estimate for approval.
OAuth Scope : ZohoBooks.creditnotes.CREATE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/submit?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/submit?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/submit?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/books/v3/creditnotes/90300000072369/submit?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/submit?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/submit?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The Credit Note has been successfully submitted for approval."
}

Approve a credit note.

Approve a credit note.
OAuth Scope : ZohoBooks.creditnotes.CREATE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/approve?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/approve?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/approve?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/books/v3/creditnotes/90300000072369/approve?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/approve?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/approve?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "You have approved the Credit Note."
}

Email history

Get email history of a credit code.
OAuth Scope : ZohoBooks.creditnotes.READ

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/emailhistory?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "email_history": [
        {
            "mailhistory_id": 982000000570005,
            "from": "gator@zillum.com",
            "to_mail_ids": [
                "benjamin.george@bowmanfurniture.com",
                "paul@bowmanfurniture.com"
            ],
            "subject": "Credit note for subscription.",
            "date": "2016-06-05"
        },
        {...},
        {...}
    ]
}

Update billing address

Updates the billing address for an existing credit note alone.
OAuth Scope : ZohoBooks.creditnotes.UPDATE

Arguments

address

string

Billing address for the invoice

city

string

City of the customer’s billing address.

state

string

State of the customer’s billing address.

zip

string

Zip code of the customer’s billing address.

country

string

Country of the customer’s billing address.

fax

string

Customer's fax number.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/address/billing?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/address/billing?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/address/billing?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/books/v3/creditnotes/90300000072369/address/billing?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/address/billing?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/address/billing?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "address": "4900 Hopyard Rd, Suite 310",
    "city": "Pleasanton",
    "state": "CA",
    "zip": 94588,
    "country": "USA",
    "fax": "+1-925-924-9600"
}

{
    "code": 0,
    "message": "Billing address updated"
}

Update Shipping address

Updates the shipping address for an existing credit note alone.
OAuth Scope : ZohoBooks.creditnotes.UPDATE

Arguments

address

string

Billing address for the invoice

city

string

City of the customer’s billing address.

state

string

State of the customer’s billing address.

zip

string

Zip code of the customer’s billing address.

country

string

Country of the customer’s billing address.

fax

string

Customer's fax number.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/books/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/address/shipping?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "address": "Suite 125, McMillan Avenue",
    "city": "San Francisco",
    "state": "CA",
    "zip": 94134,
    "country": "USA",
    "fax": "+1-925-924-9600"
}

{
    "code": 0,
    "message": "Shipping address updated"
}

List credit note template

Get all credit note pdf templates.
OAuth Scope : ZohoBooks.creditnotes.READ

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/templates?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/templates?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/templates?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/creditnotes/templates?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/templates?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/templates?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "templates": [
        {
            "template_name": "Standard Template",
            "template_id": "90300000001336",
            "template_type": "professional"
        },
        {...},
        {...}
    ]
}

Update a credit note template

Update the pdf template associated with the credit note.
OAuth Scope : ZohoBooks.creditnotes.UPDATE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695"
type: PUT
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695")
  .put(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("PUT", "/books/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/templates/90300000001336?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The credit note has been updated."
}

Credit to an invoice

Apply credit note to existing invoices.
OAuth Scope : ZohoBooks.creditnotes.CREATE

Arguments

invoices

array

List of invoices for which the credit note has been raised. This contains invoice_id and amount.

Show Sub-Attributes

invoice_id

string

(Required)

Invoice ID of the required invoice.

amount_applied

double

(Required)

The total amount applied form the credit note on an invoice.

invoice_id

string

(Required)

Invoice ID of the required invoice.

amount_applied

double

(Required)

The total amount applied form the credit note on an invoice.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "invoices": [
        {
            "invoice_id": "90300000079426",
            "amount_applied": 41.82
        }
    ],
    "invoice_id": "90300000079426",
    "amount_applied": 41.82
}

{
    "code": 0,
    "message": "Credits have been applied to the invoice(s)."
}

List invoices credited

List invoices to which the credit note is applied.
OAuth Scope : ZohoBooks.creditnotes.READ

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "invoices_credited": [
        {
            "creditnote_id": "90300000072369",
            "invoice_id": "90300000079426",
            "creditnote_invoice_id": "982000000567172",
            "date": "2016-06-05",
            "invoice_number": "INV-384",
            "creditnote_number": "CN-29",
            "credited_amount": 12.02
        },
        {...},
        {...}
    ]
}

Delete invoices credited

Delete the credits applied to an invoice.
OAuth Scope : ZohoBooks.creditnotes.DELETE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/books/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/invoices/982000000567172?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "Credits applied to an invoice have been deleted."
}

Add a comment

Add a comment to an existing credit note.
OAuth Scope : ZohoBooks.creditnotes.CREATE

Arguments

description

string

A small description about the item.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/books/v3/creditnotes/90300000072369/comments?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/comments?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "description": "Credits applied to invoice INV-00004"
}

{
    "code": 0,
    "message": "Comments added."
}

List credit note comments & history

Get history and comments of a credit note.
OAuth Scope : ZohoBooks.creditnotes.READ

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/creditnotes/90300000072369/comments?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/comments?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "Comments of the credit note are displayed successfully.",
    "comments": [
        {
            "comment_id": "982000000570001",
            "creditnote_id": "90300000072369",
            "description": "Credits applied to invoice INV-00004",
            "commented_by_id": "982000000554041",
            "commented_by": "Sujin Kumar",
            "comment_type": "system",
            "date": "2016-06-05",
            "date_description": "7 hours ago",
            "time": "10:43 PM",
            "operation_type": "Updated",
            "transaction_id": "903000002072369",
            "transaction_type": "email"
        },
        {...},
        {...}
    ]
}

Delete a Comment

Delete a credit note comment.
OAuth Scope : ZohoBooks.creditnotes.DELETE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/books/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/comments/982000000570001?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The comment has been deleted."
}

List credit note refunds

List all refunds with pagination.
OAuth Scope : ZohoBooks.creditnotes.READ

Query Parameters

customer_id

Customer ID of the customer for whom the credit note is raised.

sort_column

Sort refunds list. Allowed Values: refund_mode, reference_number, date, creditnote_number, customer_name, amount_bcy and amount_fcy

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/refunds?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/refunds?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/refunds?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/creditnotes/refunds?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/refunds?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/refunds?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The list of credit note refunds are displayed successfully.",
    "creditnote_refunds": [
        {
            "creditnote_refund_id": "982000000567158",
            "creditnote_id": "90300000072369",
            "date": "2016-06-05",
            "refund_mode": "cash",
            "payment_form": "cash",
            "reference_number": "INV-384",
            "creditnote_number": "CN-29",
            "customer_name": "Bowman Furniture",
            "description": "",
            "amount_bcy": 10,
            "amount_fcy": 10
        },
        {...},
        {...}
    ],
    "page_context": {
        "page": 1,
        "per_page": 200,
        "has_more_page": false,
        "report_name": "Credit Notes Refund",
        "sort_column": "created_time",
        "sort_order": "D"
    }
}

Refund credit note

Refund credit note amount.
OAuth Scope : ZohoBooks.creditnotes.CREATE

Arguments

date

string

The date on which credit note is raised. Format [yyyy-mm-dd]

refund_mode

string

The method of refund.

payment_form

string

🇲🇽 only

Mode of Vendor Payment

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]

amount

double

Amount paid for the invoice.

exchange_rate

string

Exchange rate for the currency associated with the customer.

from_account_id

string

The account from which credit note is refunded.

description

string

A small description about the item.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "date": "2016-06-05",
    "refund_mode": "cash",
    "payment_form": "cash",
    "reference_number": "INV-384",
    "amount": 450,
    "exchange_rate": "5.5",
    "from_account_id": " ",
    "description": "prorated amount for items"
}

{
    "code": 0,
    "message": "The credit note amount is refunded successfully.",
    "creditnote_refund": {
        "creditnote_refund_id": "982000000567158",
        "creditnote_id": "90300000072369",
        "date": "2016-06-05",
        "refund_mode": "cash",
        "payment_form": "cash",
        "reference_number": "INV-384",
        "amount": 450,
        "customer_name": "Bowman Furniture",
        "description": "prorated amount for items"
    }
}

List refunds of a credit note

List all refunds of an existing credit note.
OAuth Scope : ZohoBooks.creditnotes.READ

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The refunds of the existing credit note are displayed successfully.",
    "creditnote_refunds": [
        {
            "creditnote_refund_id": "982000000567158",
            "creditnote_id": "90300000072369",
            "date": "2016-06-05",
            "refund_mode": "cash",
            "payment_form": "cash",
            "reference_number": "INV-384",
            "creditnote_number": "CN-29",
            "customer_name": "Bowman Furniture",
            "description": "",
            "amount_bcy": 10,
            "amount_fcy": 10
        },
        {...},
        {...}
    ],
    "page_context": {
        "page": 1,
        "per_page": 200,
        "has_more_page": false,
        "report_name": "Credit Notes Refund",
        "sort_column": "created_time",
        "sort_order": "D"
    }
}

Update credit note refund

Update the refunded transaction.
OAuth Scope : ZohoBooks.creditnotes.UPDATE

Arguments

date

string

The date on which credit note is raised. Format [yyyy-mm-dd]

refund_mode

string

The method of refund.

payment_form

string

🇲🇽 only

Mode of Vendor Payment

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]

amount

double

Amount paid for the invoice.

exchange_rate

string

Exchange rate for the currency associated with the customer.

from_account_id

string

The account from which credit note is refunded.

description

string

A small description about the item.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "date": "2016-06-05",
    "refund_mode": "cash",
    "payment_form": "cash",
    "reference_number": "INV-384",
    "amount": 450,
    "exchange_rate": "5.5",
    "from_account_id": " ",
    "description": "prorated amount for items"
}

{
    "code": 0,
    "message": "The credit note refund is updated successfully.",
    "creditnote_refund": {
        "creditnote_refund_id": "982000000567158",
        "creditnote_id": "90300000072369",
        "date": "2016-06-05",
        "refund_mode": "cash",
        "payment_form": "cash",
        "reference_number": "INV-384",
        "amount": 450,
        "customer_name": "Bowman Furniture",
        "description": "prorated amount for items"
    }
}

Get credit note refund

Get refund of a particular credit note.
OAuth Scope : ZohoBooks.creditnotes.READ

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The refund of the credit note is displayed successfully.",
    "creditnote_refund": {
        "creditnote_refund_id": "982000000567158",
        "creditnote_id": "90300000072369",
        "date": "2016-06-05",
        "refund_mode": "cash",
        "payment_form": "cash",
        "reference_number": "INV-384",
        "amount": 450,
        "customer_name": "Bowman Furniture",
        "description": "prorated amount for items"
    }
}

Delete credit note refund

Delete a credit note refund.
OAuth Scope : ZohoBooks.creditnotes.DELETE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/books/v3/creditnotes/90300000072369/refunds/982000000567158?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The refund has been successfully deleted."
}