Vendor Credits

Vendor credits are credits that you receive from your vendor, and is treated as an equivalent of physical cash that the vendor owes you. This helps you track the money you’re owed until it is either paid by said vendor at a later date i.e refunded, or subtracted from any future bill amount due to that vendor.

End Points

POST

/vendorcredits

GET

/vendorcredits

PUT

/vendorcredits/{vendor_credit_id}

GET

/vendorcredits/{vendor_credit_id}

DELETE

/vendorcredits/{vendor_credit_id}

POST

/vendorcredits/{vendor_credit_id}/status/open

POST

/vendorcredits/{vendor_credit_id}/status/void

POST

/vendorcredits/{vendor_credit_id}/submit

POST

/vendorcredits/{vendor_credit_id}/approve

POST

/vendorcredits/{vendor_credit_id}/bills

GET

/vendorcredits/{vendor_credit_id}/bills

DELETE

/vendorcredits/{vendor_credit_id}/bills/{vendor_credit_bill_id}

POST

/vendorcredits/{vendor_credit_id}/refunds

GET

/vendorcredits/{vendor_credit_id}/refunds

PUT

/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}

GET

/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}

DELETE

/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}

GET

/vendorcredits/refunds

POST

/vendorcredits/{vendor_credit_id}/comments

GET

/vendorcredits/{vendor_credit_id}/comments

DELETE

/vendorcredits/{vendor_credit_id}/comments/{comment_id}

Attribute

vendor_credit_id

string

ID of the Vendor Credit

vendor_credit_number

string

Number of the Vendor Credit

date

string

The date the vendor credit is created. [yyyy-mm-dd]

source_of_supply

string

🇮🇳 only

Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)

destination_of_supply

string

🇮🇳 only

Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)

place_of_supply

string

GCC only

The place of supply is where a transaction is considered to have occurred for VAT purposes. For the supply of goods, the place of supply is the location of the goods when the supply occurs. For the supply of services, the place of supply should be where the supplier is established. (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.

gst_no

string

🇮🇳 only

15 digit GST identification number of the vendor.

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 vendor credit. Choose whether the vendor falls under: vat_registered,vat_not_registered,gcc_vat_not_registered,gcc_vat_registered,non_gcc.
dz_vat_registered and dz_vat_not_registered are supported only for UAE.
home_country_mexico,border_region_mexico,non_mexico supported only for MX.

pricebook_id

string

ID of the pricebook

is_reverse_charge_applied

boolean

🇮🇳 only

Applicable for transactions where you pay reverse charge

status

string

reference_number

string

Reference number for the refund recorded.

vendor_id

string

ID of the vendor the vendor credit associated with the Vendor Credit

vendor_name

string

Name of the Vendor Associated with the Vendor Credit

currency_id

string

ID of the Currency Involved in the Vendor Credit

currency_code

string

Code of the Currency Involved in the Vendor Credit

exchange_rate

double

Exchange rate of the currency.

price_precision

integer

vat_treatment

string

🇬🇧 only

VAT treatment for the vendor credits. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the vendor is in an EU country & VAT registered, you are resides in Northen Ireland and purchasing Goods then his VAT treatment is eu_vat_registeredand if he resides outside the EU then his VAT treatment is overseas(For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).

filed_in_vat_return_id

string

🇬🇧 only

ID of the VAT Return the Vendor Credit is filed in

filed_in_vat_return_name

string

🇬🇧 only

Name of the VAT Return the Vendor Credit is filed in

filed_in_vat_return_type

string

🇬🇧 only

Type of the VAT Return the Vendor Credit is filed in

is_inclusive_tax

boolean

Not applicable 🇺🇸

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

line_items

object

Line items of a vendor credit.

Show Sub-Attributes

item_id

string

ID of the item.

line_item_id

string

ID of the Line Item

sku

string

SKU of the Item

account_id

string

ID of the account, the line item is associated with

product_type

string

🇬🇧 , Europe only

Type of the product. Allowed Values: goods, digital_service and service.

reverse_charge_tax_id

string

🇮🇳 , GCC only

ID of the reverse charge tax

reverse_charge_tax_name

string

🇮🇳 only

Enter the tax name of the reverse charge

reverse_charge_tax_percentage

double

🇮🇳 only

Tax percentage of the reverse charge

reverse_charge_tax_amount

double

🇮🇳 only

Tax amount of the reverse charge

account_name

string

Name of the account the line item is associated with

name

string

Name of the line item.

description

string

Description of the line item.

item_order

integer

Order of the line item

quantity

double

Quantity of the line item.

unit

string

Unit of the line item e.g. kgs, Nos.

bcy_rate

double

Rate of the Item in Base Currency

rate

double

Rate of the line item.

tax_id

string

ID of the Tax associated with the Vendor Credit

tds_tax_id

string

🇲🇽 only

TDS Tax ID of the Tax associated with the Vendor Credit

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 KSA are ksa_reimbursed_expense.

tax_exemption_id

string

🇮🇳 , 🇦🇺 only

ID of the Tax Exemption associated

tax_exemption_code

string

🇮🇳 , 🇦🇺 only

Code of the Tax Exemption associated

tax_name

string

Name of the Tax

tax_type

string

Type of the Tax

tax_percentage

double

Percentage of Tax

project_id

string

ID of the project

project_name

string

Name of the project.

item_total

double

Total price of the Item

item_total_inclusive_of_tax

double

Total price of the Item inclusive of Tax

hsn_or_sac

string

🇮🇳 only

HSN Code

acquisition_vat_id

string

🇬🇧 , Europe only

ID of the VAT Acquistion

acquisition_vat_name

string

🇬🇧 , Europe only

Name of the VAT Acquistion

acquisition_vat_percentage

string

🇬🇧 , Europe only

Percentage of the VAT Acquistion

acquisition_vat_amount

string

🇬🇧 , Europe only

Amount of the VAT Acquistion

reverse_charge_vat_id

string

🇬🇧 , Europe only

ID of the Reverse Charge

reverse_charge_vat_name

string

🇬🇧 , Europe only

Name of the Reverse Charge

reverse_charge_vat_percentage

string

🇬🇧 , Europe only

Percentage of the Reverse Charge

reverse_charge_vat_amount

string

🇬🇧 , Europe only

Percentage of the Reverse Charge

stock_on_hand

string

Stock on Hand for that Item

Create a vendor credit

Create a vendor credit for a vendor.
OAuth Scope : ZohoBooks.debitnotes.CREATE

Arguments

vendor_id

string

(Required)

ID of the vendor the vendor credit associated with the Vendor Credit

currency_id

string

ID of the Currency Involved in the Vendor Credit

vat_treatment

string

🇬🇧 only

vendor_credit_number

string

Mandatory if auto number generation is disabled.

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

gst_no

string

🇮🇳 only

15 digit GST identification number of the vendor.

source_of_supply

string

🇮🇳 only

Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)

destination_of_supply

string

🇮🇳 only

Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)

place_of_supply

string

GCC only

pricebook_id

string

ID of the pricebook

reference_number

string

Reference number for the refund recorded.

is_update_customer

boolean

Check if customer should be updated

date

string

The date the vendor credit is created. [yyyy-mm-dd]

exchange_rate

double

Exchange rate of the currency.

is_inclusive_tax

boolean

Not applicable 🇺🇸

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

line_items

array

Line items of a vendor credit.

Show Sub-Attributes

item_id

string

ID of the item.

line_item_id

string

ID of the Line Item

account_id

string

ID of the account, the line item is associated with

name

string

Name of the line item.

hsn_or_sac

string

🇮🇳 only

HSN Code

reverse_charge_tax_id

string

🇮🇳 , GCC only

ID of the reverse charge tax

warehouse_id

string

ID of the warehouse

description

string

Description of the line item.

item_order

integer

Order of the line item

quantity

double

Quantity of the line item.

unit

string

Unit of the line item e.g. kgs, Nos.

rate

double

Rate of the line item.

tax_id

string

ID of the Tax associated with the Vendor Credit

tds_tax_id

string

🇲🇽 only

TDS Tax ID of the Tax associated with the Vendor Credit

tax_treatment_code

string

GCC only

Query Parameters

ignore_auto_number_generation

Ignore auto number generation for this vendor credit only. On enabling this option vendor credit number is mandatory.

bill_id

Bill Associated with the Vendor Credit

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/vendorcredits?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/vendorcredits?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/vendorcredits?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/vendorcredits?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/vendorcredits?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/vendorcredits?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "vendor_id": "460000000020029",
    "currency_id": "3000000000083",
    "vat_treatment": "string",
    "vendor_credit_number": "DN-00002",
    "gst_treatment": "business_gst",
    "tax_treatment": "vat_registered",
    "gst_no": "22AAAAA0000A1Z5",
    "source_of_supply": "TN",
    "destination_of_supply": "TN",
    "place_of_supply": "DU",
    "pricebook_id": "string",
    "reference_number": "string",
    "is_update_customer": false,
    "date": "2014-08-28",
    "exchange_rate": 1,
    "is_inclusive_tax": false,
    "line_items": [
        {
            "item_id": "460000000020071",
            "line_item_id": "460000000020077",
            "account_id": "460000000020097",
            "name": "Premium Plan - Web hosting",
            "hsn_or_sac": "string",
            "reverse_charge_tax_id": 460000000057089,
            "warehouse_id": "string",
            "description": "string",
            "item_order": 0,
            "quantity": 1,
            "unit": "Nos",
            "rate": 30,
            "tax_id": "string",
            "tds_tax_id": "string",
            "tax_treatment_code": "uae_others",
            "tags": [
                {
                    "tag_id": 0,
                    "tag_option_id": 0
                }
            ],
            "item_custom_fields": [
                {
                    "custom_field_id": 0,
                    "label": "string",
                    "value": "string",
                    "index": 0
                }
            ],
            "serial_numbers": [
                "string"
            ],
            "project_id": 90300000087378
        }
    ],
    "notes": "string",
    "documents": [
        {
            "document_id": 0,
            "file_name": "string"
        }
    ],
    "custom_fields": [
        {
            "custom_field_id": 0,
            "label": "string",
            "value": "string",
            "index": 0
        }
    ]
}

{
    "code": 0,
    "message": "Vendor credit has been created.",
    "vendor_credit": {
        "vendor_credit_id": "3000000002075",
        "vendor_credit_number": "DN-00002",
        "date": "2014-08-28",
        "source_of_supply": "TN",
        "destination_of_supply": "TN",
        "place_of_supply": "DU",
        "gst_no": "22AAAAA0000A1Z5",
        "gst_treatment": "business_gst",
        "tax_treatment": "vat_registered",
        "pricebook_id": "string",
        "is_reverse_charge_applied": true,
        "status": "open",
        "reference_number": "string",
        "vendor_id": "460000000020029",
        "vendor_name": "Bowman and Co",
        "currency_id": "3000000000083",
        "currency_code": "USD",
        "exchange_rate": 1,
        "price_precision": 2,
        "vat_treatment": "string",
        "filed_in_vat_return_id": "string",
        "filed_in_vat_return_name": "string",
        "filed_in_vat_return_type": "string",
        "is_inclusive_tax": false,
        "line_items": {
            "item_id": "460000000020071",
            "line_item_id": "460000000020077",
            "sku": "string",
            "account_id": "460000000020097",
            "product_type": "string",
            "reverse_charge_tax_id": 460000000057089,
            "reverse_charge_tax_name": "intra",
            "reverse_charge_tax_percentage": 10,
            "reverse_charge_tax_amount": 100,
            "account_name": "IT and Internet Expenses",
            "name": "Premium Plan - Web hosting",
            "description": "string",
            "item_order": 0,
            "quantity": 1,
            "unit": "Nos",
            "bcy_rate": 30,
            "rate": 30,
            "tax_id": "string",
            "tds_tax_id": "string",
            "tax_treatment_code": "uae_others",
            "tax_exemption_id": "string",
            "tax_exemption_code": "string",
            "tax_name": "string",
            "tax_type": "string",
            "tax_percentage": 0.1,
            "project_id": 90300000087378,
            "project_name": "Sample Project",
            "item_total": 30,
            "item_total_inclusive_of_tax": 30,
            "hsn_or_sac": "string",
            "acquisition_vat_id": "string",
            "acquisition_vat_name": "string",
            "acquisition_vat_percentage": "string",
            "acquisition_vat_amount": "string",
            "reverse_charge_vat_id": "string",
            "reverse_charge_vat_name": "string",
            "reverse_charge_vat_percentage": "string",
            "reverse_charge_vat_amount": "string",
            "stock_on_hand": "string",
            "tags": [
                {
                    "tag_id": 0,
                    "tag_option_id": 0
                }
            ],
            "item_custom_fields": [
                {
                    "custom_field_id": 0,
                    "label": "string",
                    "value": "string",
                    "index": 0
                }
            ]
        },
        "acquisition_vat_summary": [
            {
                "tax": {
                    "tax_name": "string",
                    "tax_amount": 0.1
                }
            }
        ],
        "acquisition_vat_total": 0.1,
        "reverse_charge_vat_summary": [
            {
                "tax": {
                    "tax_name": "string",
                    "tax_amount": 0.1
                }
            }
        ],
        "reverse_charge_vat_total": 0.1,
        "documents": [
            {
                "document_id": 0,
                "file_name": "string"
            }
        ],
        "custom_fields": [
            {
                "custom_field_id": 0,
                "label": "string",
                "value": "string",
                "index": 0
            }
        ],
        "sub_total": 30,
        "total": 30,
        "total_credits_used": 0,
        "total_refunded_amount": 0,
        "balance": 30,
        "notes": "string",
        "comments": [
            {
                "comment_id": "3000000002089",
                "vendor_credit_id": "3000000002075",
                "description": "string",
                "commented_by_id": "3000000000741",
                "commented_by": "rajdeep.a",
                "comment_type": "system",
                "date": "2014-08-28",
                "date_description": "32 minutes ago",
                "time": "10:52 PM",
                "operation_type": "Added",
                "transaction_id": "460000000069087",
                "transaction_type": "vendor_credit"
            }
        ],
        "vendor_credit_refunds": [
            {
                "vendor_credit_refund_id": "3000000003151",
                "vendor_credit_id": "3000000002075",
                "date": "2014-08-28",
                "refund_mode": "cash",
                "reference_number": "string",
                "description": "string",
                "amount_bcy": 13,
                "amount_fcy": 13,
                "filed_in_vat_return_id": "string",
                "filed_in_vat_return_name": "string",
                "filed_in_vat_return_type": "string"
            }
        ],
        "bills_credited": [
            {
                "bill_id": "460000000057075",
                "vendor_credit_bill_id": "string",
                "date": "2014-08-28",
                "bill_number": "string",
                "amount": 13
            }
        ],
        "created_time": "2014-08-28T22:53:31-0700",
        "last_modified_time": "2014-08-28T22:53:31-0700"
    }
}

List vendor credits

List vendor credits with pagination.
OAuth Scope : ZohoBooks.debitnotes.READ

Query Parameters

vendor_credit_number

Search vendor credits by vendor credit number. Variants: vendor_credit_number.startswith and vendor_credit_number.contains

date

General Format: yyyy-mm-dd. Search vendor credits by date. Variants: date_start, date_end, date_before and date_after

status

Search vendor credits by vendor credit status. Allowed statuses are open, closed and void. Allowed Values: open, closed and void

total

Search vendor credits by total amount. Variants: total.start, total.end, total.less_than, total.less_equals, total.greater_than and total.greater_equals

reference_number

Search vendor credits by vendor credit reference number. Variants: reference_number.startswith and reference_number.contains

customer_name

Search vendor credits by vendor name. Variants: customer_name.startswith and customer_name.contains

item_name

Search vendor credits by item name. Variants: item_name.startswith and item_name.contains

item_description

Search vendor credits by vendor credit item description. Variants: item_description.startswith and item_description.contains

notes

Search vendor credits by vendor credit notes. Variants: notes.startswith and notes.contains

custom_field

Search vendor credits by custom field. Variants : custom_field_startswith and custom_field_contains

last_modified_time

Search vendor credits by vendor credit last modfified time

customer_id

Search vendor credits by vendor credit customer ID

line_item_id

Search vendor credits by vendor credit line item ID

item_id

Search vendor credits by vendor credit item ID

tax_id

Search vendor credits by vendor credit tax ID

filter_by

Filter vendor credits by statuses. Allowed Values: Status.All, Status.Open, Status.Draft, Status.Closed and Status.Void.

search_text

Search vendor credits by vendor credit number or vendor name or vendor credit reference number.

sort_column

Sort vendor credits by following columns vendor_name, vendorcredit_number, balance, total, date and created_time. Allowed Values: vendor_name, vendor_credit_number, balance, total, date, created_time, last_modified_time and reference_number.

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits?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/vendorcredits?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/vendorcredits?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/vendorcredits?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/vendorcredits?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/vendorcredits?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "vendorcredits": [
        {
            "vendor_credit_id": "3000000002075",
            "vendor_credit_number": "DN-00002",
            "status": "open",
            "reference_number": "string",
            "date": "2014-08-28",
            "total": 30,
            "balance": 30,
            "vendor_id": "460000000020029",
            "vendor_name": "Bowman and Co",
            "currency_id": "3000000000083",
            "currency_code": "USD",
            "created_time": "2014-08-28T22:53:31-0700",
            "last_modified_time": "2014-08-28T22:53:31-0700",
            "has_attachment": false,
            "exchange_rate": 1
        },
        {...},
        {...}
    ]
}

Update vendor credit

Update an existing vendor credit.
OAuth Scope : ZohoBooks.debitnotes.UPDATE

Arguments

vendor_id

string

(Required)

ID of the vendor the vendor credit associated with the Vendor Credit

currency_id

string

ID of the Currency Involved in the Vendor Credit

vat_treatment

string

🇬🇧 only

vendor_credit_number

string

Mandatory if auto number generation is disabled.

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

gst_no

string

🇮🇳 only

15 digit GST identification number of the vendor.

source_of_supply

string

🇮🇳 only

Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)

destination_of_supply

string

🇮🇳 only

Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)

place_of_supply

string

GCC only

pricebook_id

string

ID of the pricebook

reference_number

string

Reference number for the refund recorded.

is_update_customer

boolean

Check if customer should be updated

date

string

The date the vendor credit is created. [yyyy-mm-dd]

exchange_rate

double

Exchange rate of the currency.

is_inclusive_tax

boolean

Not applicable 🇺🇸

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

line_items

array

Line items of a vendor credit.

Show Sub-Attributes

item_id

string

ID of the item.

line_item_id

string

ID of the Line Item

account_id

string

ID of the account, the line item is associated with

name

string

Name of the line item.

hsn_or_sac

string

🇮🇳 only

HSN Code

reverse_charge_tax_id

string

🇮🇳 , GCC only

ID of the reverse charge tax

warehouse_id

string

ID of the warehouse

description

string

Description of the line item.

item_order

integer

Order of the line item

quantity

double

Quantity of the line item.

unit

string

Unit of the line item e.g. kgs, Nos.

rate

double

Rate of the line item.

tax_id

string

ID of the Tax associated with the Vendor Credit

tds_tax_id

string

🇲🇽 only

TDS Tax ID of the Tax associated with the Vendor Credit

tax_treatment_code

string

GCC only

Get vendor credit

Get details of a vendor credit.
OAuth Scope : ZohoBooks.debitnotes.READ

Query Parameters

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

You can get vendor credit details as json/pdf/html. Default format is html. Allowed Values: json, xml, csv, xls, pdf, html and jhtml.

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075?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/vendorcredits/3000000002075?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/vendorcredits/3000000002075?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/vendorcredits/3000000002075?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/vendorcredits/3000000002075?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/vendorcredits/3000000002075?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "vendor_credit": {
        "vendor_credit_id": "3000000002075",
        "vendor_credit_number": "DN-00002",
        "date": "2014-08-28",
        "status": "open",
        "reference_number": "string",
        "source_of_supply": "TN",
        "destination_of_supply": "TN",
        "place_of_supply": "DU",
        "gst_no": "22AAAAA0000A1Z5",
        "gst_treatment": "business_gst",
        "tax_treatment": "vat_registered",
        "pricebook_id": "string",
        "is_reverse_charge_applied": true,
        "vendor_id": "460000000020029",
        "vendor_name": "Bowman and Co",
        "currency_id": "3000000000083",
        "currency_code": "USD",
        "exchange_rate": 1,
        "price_precision": 2,
        "vat_treatment": "string",
        "filed_in_vat_return_id": "string",
        "filed_in_vat_return_name": "string",
        "filed_in_vat_return_type": "string",
        "is_inclusive_tax": false,
        "line_items": {
            "item_id": "460000000020071",
            "line_item_id": "460000000020077",
            "sku": "string",
            "account_id": "460000000020097",
            "product_type": "string",
            "reverse_charge_tax_id": 460000000057089,
            "reverse_charge_tax_name": "intra",
            "reverse_charge_tax_percentage": 10,
            "reverse_charge_tax_amount": 100,
            "account_name": "IT and Internet Expenses",
            "name": "Premium Plan - Web hosting",
            "description": "string",
            "item_order": 0,
            "quantity": 1,
            "unit": "Nos",
            "bcy_rate": 30,
            "rate": 30,
            "tax_id": "string",
            "tax_treatment_code": "uae_others",
            "tax_exemption_id": "string",
            "tax_exemption_code": "string",
            "tax_name": "string",
            "tax_type": "string",
            "tax_percentage": 0.1,
            "item_total": 30,
            "item_total_inclusive_of_tax": 30,
            "hsn_or_sac": "string",
            "acquisition_vat_id": "string",
            "acquisition_vat_name": "string",
            "acquisition_vat_percentage": "string",
            "acquisition_vat_amount": "string",
            "reverse_charge_vat_id": "string",
            "reverse_charge_vat_name": "string",
            "reverse_charge_vat_percentage": "string",
            "reverse_charge_vat_amount": "string",
            "stock_on_hand": "string",
            "tags": [
                {
                    "tag_id": 0,
                    "tag_option_id": 0
                }
            ],
            "item_custom_fields": [
                {
                    "custom_field_id": 0,
                    "label": "string",
                    "value": "string",
                    "index": 0
                }
            ],
            "project_id": 90300000087378,
            "project_name": "Sample Project"
        },
        "acquisition_vat_summary": [
            {
                "tax": {
                    "tax_name": "string",
                    "tax_amount": 0.1
                }
            }
        ],
        "acquisition_vat_total": 0.1,
        "reverse_charge_vat_summary": [
            {
                "tax": {
                    "tax_name": "string",
                    "tax_amount": 0.1
                }
            }
        ],
        "reverse_charge_vat_total": 0.1,
        "documents": [
            {
                "document_id": 0,
                "file_name": "string"
            }
        ],
        "custom_fields": [
            {
                "custom_field_id": 0,
                "label": "string",
                "value": "string",
                "index": 0
            }
        ],
        "sub_total": 30,
        "total": 30,
        "total_credits_used": 0,
        "total_refunded_amount": 0,
        "balance": 30,
        "notes": "string",
        "comments": [
            {
                "comment_id": "3000000002089",
                "vendor_credit_id": "3000000002075",
                "description": "string",
                "commented_by_id": "3000000000741",
                "commented_by": "rajdeep.a",
                "comment_type": "system",
                "date": "2014-08-28",
                "date_description": "32 minutes ago",
                "time": "10:52 PM",
                "operation_type": "Added",
                "transaction_id": "460000000069087",
                "transaction_type": "vendor_credit"
            }
        ],
        "vendor_credit_refunds": [
            {
                "vendor_credit_refund_id": "3000000003151",
                "vendor_credit_id": "3000000002075",
                "date": "2014-08-28",
                "refund_mode": "cash",
                "reference_number": "string",
                "description": "string",
                "amount_bcy": 13,
                "amount_fcy": 13,
                "filed_in_vat_return_id": "string",
                "filed_in_vat_return_name": "string",
                "filed_in_vat_return_type": "string"
            }
        ],
        "bills_credited": [
            {
                "bill_id": "460000000057075",
                "vendor_credit_bill_id": "string",
                "date": "2014-08-28",
                "bill_number": "string",
                "amount": 13
            }
        ],
        "created_time": "2014-08-28T22:53:31-0700",
        "last_modified_time": "2014-08-28T22:53:31-0700"
    }
}

Delete vendor credit

Delete a vendor credit.
OAuth Scope : ZohoBooks.debitnotes.DELETE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075?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/vendorcredits/3000000002075?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/vendorcredits/3000000002075?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/vendorcredits/3000000002075?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/vendorcredits/3000000002075?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/vendorcredits/3000000002075?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

Convert to open

Change an existing vendor credit status to open.
OAuth Scope : ZohoBooks.debitnotes.CREATE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/status/open?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The status of the vendor credit has been changed to open."
}

Void vendor credit

Mark an existing vendor credit as void.
OAuth Scope : ZohoBooks.debitnotes.CREATE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/status/void?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The vendor credit has been voided."
}

Submit a Vendor credit for approval

Submit a Vendor credit for approval.
OAuth Scope : ZohoBooks.debitnotes.CREATE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/submit?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

Approve a Vendor credit

Approve a Vendor credit.
OAuth Scope : ZohoBooks.debitnotes.CREATE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/approve?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "You have approved the vendor credit."
}

Apply credits to a bill

Apply vendor credit to existing bills.
OAuth Scope : ZohoBooks.debitnotes.CREATE

Arguments

bills

array

(Required)

Amount applied from vendor credits to specified bills.

Show Sub-Attributes

bill_id

string

(Required)

Bill Associated with the Vendor Credit

amount_applied

double

(Required)

Amount applied to the bill.

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/vendorcredits/3000000002075/bills?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/vendorcredits/3000000002075/bills?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/vendorcredits/3000000002075/bills?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/vendorcredits/3000000002075/bills?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/vendorcredits/3000000002075/bills?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/vendorcredits/3000000002075/bills?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "bills": [
        {
            "bill_id": "460000000057075",
            "amount_applied": 10
        }
    ]
}

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

List bills credited

List bills to which the vendor credit is applied.
OAuth Scope : ZohoBooks.debitnotes.READ

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075/bills?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/vendorcredits/3000000002075/bills?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/vendorcredits/3000000002075/bills?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/vendorcredits/3000000002075/bills?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/vendorcredits/3000000002075/bills?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/vendorcredits/3000000002075/bills?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "bills_credited": [
        {
            "vendor_credit_id": "3000000002075",
            "bill_id": "460000000057075",
            "vendor_credit_bill_id": "string",
            "date": "2014-08-28",
            "bill_number": "string"
        },
        {...},
        {...}
    ]
}

Delete bills credited

Delete the credits applied to a bill. Note: You should pass the vendor_credit_bill_id from "Get vendor credits > bills credited > vendor_credit_bill_id" section
OAuth Scope : ZohoBooks.debitnotes.DELETE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075/bills/?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/vendorcredits/3000000002075/bills/?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/vendorcredits/3000000002075/bills/?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/vendorcredits/3000000002075/bills/?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/vendorcredits/3000000002075/bills/?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/vendorcredits/3000000002075/bills/?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "Credits applied to the bill have been deleted."
}

Refund a vendor credit

Refund vendor credit amount.
OAuth Scope : ZohoBooks.debitnotes.CREATE

Arguments

date

string

(Required)

Date of Vendor Credit Refund

refund_mode

string

Mode of Refund

reference_number

string

Reference number for the refund recorded.

amount

double

(Required)

exchange_rate

double

Exchange rate of the currency.

account_id

string

(Required)

ID of the account, the line item is associated with

description

string

Description of the line 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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/refunds?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "date": "2014-08-30",
    "refund_mode": "cash",
    "reference_number": "string",
    "amount": 13,
    "exchange_rate": 1,
    "account_id": "460000000020097",
    "description": "string"
}

{
    "code": 0,
    "message": "The refund information for this vendor credit has been saved.",
    "vendor_credit_refund": {
        "vendor_credit_refund_id": "3000000003151",
        "vendor_credit_id": "3000000002075",
        "date": "2014-08-28",
        "refund_mode": "cash",
        "reference_number": "string",
        "amount": 13,
        "exchange_rate": 1,
        "account_id": "460000000020097",
        "account_name": "IT and Internet Expenses",
        "description": "string",
        "imported_transactions": [
            {
                "imported_transaction_id": "460000000013297",
                "date": "2014-08-28",
                "amount": 13,
                "payee": "John Roberts",
                "description": "string",
                "reference_number": "string",
                "status": "open",
                "account_id": "460000000020097"
            }
        ]
    }
}

List refunds of a vendor credit

List all refunds of an existing vendor credit.
OAuth Scope : ZohoBooks.debitnotes.READ

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/refunds?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "vendor_credit_refunds": [
        {
            "vendor_credit_refund_id": "3000000003151",
            "vendor_credit_id": "3000000002075",
            "date": "2017-01-22",
            "refund_mode": "cash",
            "reference_number": "string",
            "amount": 13,
            "vendor_credit_number": "DN-00002",
            "customer_name": "Bowman and Co",
            "description": "Cheque deposit",
            "amount_bcy": 13,
            "amount_fcy": 13
        },
        {...},
        {...}
    ]
}

Update vendor credit refund

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

Arguments

date

string

(Required)

The date the vendor credit is created. [yyyy-mm-dd]

refund_mode

string

Mode of Refund

reference_number

string

Reference number for the refund recorded.

amount

double

(Required)

exchange_rate

double

Exchange rate of the currency.

account_id

string

(Required)

ID of the account, the line item is associated with

description

string

Description of the line 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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "date": "2014-08-28",
    "refund_mode": "cash",
    "reference_number": "string",
    "amount": 13,
    "exchange_rate": 1,
    "account_id": "460000000020097",
    "description": "string"
}

{
    "code": 0,
    "message": "The refund information has been saved.",
    "vendor_credit_refund": {
        "vendor_credit_refund_id": "3000000003151",
        "vendor_credit_id": "3000000002075",
        "date": "2014-08-28",
        "refund_mode": "cash",
        "reference_number": "string",
        "amount": 13,
        "exchange_rate": 1,
        "account_id": "460000000020097",
        "account_name": "IT and Internet Expenses",
        "description": "string",
        "imported_transactions": [
            {
                "imported_transaction_id": "460000000013297",
                "date": "2014-08-28",
                "amount": 13,
                "payee": "John Roberts",
                "description": "string",
                "reference_number": "string",
                "status": "open",
                "account_id": "460000000020097"
            }
        ]
    }
}

Get vendor credit refund

Get refund of a particular vendor credit.
OAuth Scope : ZohoBooks.debitnotes.READ

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "vendor_credit_refund": {
        "vendor_credit_refund_id": "3000000003151",
        "vendor_credit_id": "3000000002075",
        "date": "2014-08-28",
        "refund_mode": "cash",
        "reference_number": "string",
        "amount": 13,
        "exchange_rate": 1,
        "account_id": "460000000020097",
        "account_name": "IT and Internet Expenses",
        "description": "string",
        "imported_transactions": [
            {
                "imported_transaction_id": "460000000013297",
                "date": "2014-08-28",
                "amount": 13,
                "payee": "John Roberts",
                "description": "string",
                "reference_number": "string",
                "status": "open",
                "account_id": "460000000020097"
            }
        ]
    }
}

Delete vendor credit refund

Delete a vendor credit refund.
OAuth Scope : ZohoBooks.debitnotes.DELETE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?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/vendorcredits/3000000002075/refunds/3000000003151?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

List vendor credit refunds

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

Query Parameters

customer_id

Search vendor credits by vendor credit customer ID

last_modified_time

Search vendor credits by vendor credit last modfified time

sort_column

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/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/vendorcredits/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/vendorcredits/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/vendorcredits/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/vendorcredits/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/vendorcredits/refunds?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "vendor_credit_refunds": [
        {
            "vendor_credit_refund_id": "3000000003151",
            "vendor_credit_id": "3000000002075",
            "date": "2017-01-22",
            "refund_mode": "cash",
            "reference_number": "string",
            "amount": 13,
            "vendor_credit_number": "DN-00002",
            "customer_name": "Bowman and Co",
            "description": "Cheque deposit",
            "amount_bcy": 13,
            "amount_fcy": 13
        },
        {...},
        {...}
    ]
}

Add a comment

Add a comment to an existing vendor credit.
OAuth Scope : ZohoBooks.debitnotes.CREATE

Arguments

description

string

(Required)

Description of the Comment

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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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 Bill 1"
}

{
    "code": 0,
    "message": "Comments added.",
    "comment": {
        "comment_id": "3000000002089",
        "vendor_credit_id": "3000000002075",
        "description": "Credits applied to Bill 1",
        "commented_by_id": "3000000000741",
        "commented_by": "rajdeep.a",
        "date": "2017-01-18"
    }
}

List vendor credit comments & history

Get history and comments of a vendor credit.
OAuth Scope : ZohoBooks.debitnotes.READ

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/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/vendorcredits/3000000002075/comments?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "comments": [
        {
            "comment_id": "3000000002089",
            "vendor_credit_id": "3000000002075",
            "description": "Credits applied to Bill 1",
            "commented_by_id": "3000000000741",
            "commented_by": "rajdeep.a",
            "comment_type": "system",
            "date": "2017-01-18",
            "date_description": "32 minutes ago",
            "time": "10:52 PM",
            "operation_type": "Added",
            "transaction_id": "460000000069087",
            "transaction_type": "vendor_credit"
        },
        {...},
        {...}
    ]
}

Delete a comment

Delete a vendor credit comment.
OAuth Scope : ZohoBooks.debitnotes.DELETE

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/vendorcredits/3000000002075/comments/3000000002089?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/vendorcredits/3000000002075/comments/3000000002089?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/vendorcredits/3000000002075/comments/3000000002089?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/vendorcredits/3000000002075/comments/3000000002089?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/vendorcredits/3000000002075/comments/3000000002089?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/vendorcredits/3000000002075/comments/3000000002089?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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