API Docs
/
No Results Found
Vendor Credits

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
Create a vendor credit
List vendor credits
Update vendor credit
Get vendor credit
Delete vendor credit
Convert to open
Void vendor credit
Submit a Vendor credit for approval
Approve a Vendor credit
Apply credits to a bill
List bills credited
Delete bills credited
Refund a vendor credit
List refunds of a vendor credit
Update vendor credit refund
Get vendor credit refund
Delete vendor credit refund
List vendor credit refunds
Add a comment
List vendor credit comments & history
Delete a comment

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
๐Ÿ‡ฎ๐Ÿ‡ณ India
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
๐Ÿ‡ฎ๐Ÿ‡ณ India
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
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
15 digit GST identification number of the vendor.
gst_treatment
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
tax_treatment
string
GCC 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.
pricebook_id
string
ID of the pricebook
is_reverse_charge_applied
boolean
๐Ÿ‡ฎ๐Ÿ‡ณ India
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
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
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
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
ID of the VAT Return the Vendor Credit is filed in
filed_in_vat_return_name
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Name of the VAT Return the Vendor Credit is filed in
filed_in_vat_return_type
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Type of the VAT Return the Vendor Credit is filed in
is_inclusive_tax
boolean
Not applicable ๐Ÿ‡บ๐Ÿ‡ธ United States
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 arrow
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
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
Type of the product. Allowed Values: goods, digital_service and service.
reverse_charge_tax_id
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
, GCC only
ID of the reverse charge tax
reverse_charge_tax_name
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Enter the tax name of the reverse charge
reverse_charge_tax_percentage
double
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Tax percentage of the reverse charge
reverse_charge_tax_amount
double
๐Ÿ‡ฎ๐Ÿ‡ณ India
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
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
๐Ÿ‡ฎ๐Ÿ‡ณ India
, ๐Ÿ‡ฆ๐Ÿ‡บ Australia
only
ID of the Tax Exemption associated
tax_exemption_code
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
, ๐Ÿ‡ฆ๐Ÿ‡บ Australia
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
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
HSN Code
acquisition_vat_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
ID of the VAT Acquistion
acquisition_vat_name
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
Name of the VAT Acquistion
acquisition_vat_percentage
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
Percentage of the VAT Acquistion
acquisition_vat_amount
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
Amount of the VAT Acquistion
reverse_charge_vat_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
ID of the Reverse Charge
reverse_charge_vat_name
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
Name of the Reverse Charge
reverse_charge_vat_percentage
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
Percentage of the Reverse Charge
reverse_charge_vat_amount
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
Percentage of the Reverse Charge
stock_on_hand
string
Stock on Hand for that Item
tags
array
Show Sub-Attributes arrow
tag_id
long
ID of the tag
tag_option_id
long
ID of the tag option
item_custom_fields
array
Show Sub-Attributes arrow
custom_field_id
long
ID of the Custom Field
label
string
Label of the Custom Field
value
string
Value of the Custom Field
index
integer
Index of the Custom Field
acquisition_vat_summary
array
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
Summary of the VAT Acquistion
Show Sub-Attributes arrow
tax
object
Show Sub-Attributes arrow
tax_name
string
Name of the Tax
tax_amount
double
Amount of the Tax
acquisition_vat_total
double
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
Total of the VAT Acquistion
reverse_charge_vat_summary
array
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
Summary of the Reverse Charge
Show Sub-Attributes arrow
tax
object
Show Sub-Attributes arrow
tax_name
string
Name of the Tax
tax_amount
double
Amount of the Tax
reverse_charge_vat_total
double
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe only
Total of the Reverse Charge
documents
array
Show Sub-Attributes arrow
document_id
long
ID of the Document
file_name
string
Name of the file
custom_fields
array
Show Sub-Attributes arrow
custom_field_id
long
ID of the Custom Field
label
string
Label of the Custom Field
value
string
Value of the Custom Field
index
integer
Index of the Custom Field
sub_total
double
total
double
total_credits_used
double
total_refunded_amount
double
balance
double
Balance in the Vendor Credit
notes
string
Notes for the Vendor Credit
comments
array
Show Sub-Attributes arrow
comment_id
string
ID of the Comment
vendor_credit_id
string
ID of the Vendor Credit
description
string
Description of the line item.
commented_by_id
string
ID of the User who caused the comment
commented_by
string
Name of the User who caused the comment
comment_type
string
Type of the comment
date
string
The date the vendor credit is created. [yyyy-mm-dd]
date_description
string
Description of the Date of the Comment
time
string
Time of the Comment
operation_type
string
Type of operation that caused the Comment
transaction_id
string
Transaction ID that caused the Comment
transaction_type
string
Transaction Type that caused the Comment
vendor_credit_refunds
array
Show Sub-Attributes arrow
vendor_credit_refund_id
string
ID of the Vendor Credit Refund
vendor_credit_id
string
ID of the Vendor Credit
date
string
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.
description
string
Description of the line item.
amount_bcy
double
Refund Amount in Base Currency
amount_fcy
double
Refund Amount in Foreign Currency
filed_in_vat_return_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
ID of the VAT Return the Vendor Credit is filed in
filed_in_vat_return_name
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Name of the VAT Return the Vendor Credit is filed in
filed_in_vat_return_type
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Type of the VAT Return the Vendor Credit is filed in
bills_credited
array
Show Sub-Attributes arrow
bill_id
string
ID of the Bill Credited
vendor_credit_bill_id
string
ID of the Vendor Credited Bill ID
date
string
Date of the Bill Credit
bill_number
string
Number of the Bill Credited
amount
double
Amount that is credited in the bill
created_time
string
Time of Vendor Credit Creation
last_modified_time
string
Last Modified Time of Vendor Credit

Example

{ "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", "tax_treatment_code": "uae_others", "tax_exemption_id": "string", "tax_exemption_code": "string", "tax_name": "string", "tax_type": "string", "tax_percentage": 0, "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 } } ], "acquisition_vat_total": 0, "reverse_charge_vat_summary": [ { "tax": { "tax_name": "string", "tax_amount": 0 } } ], "reverse_charge_vat_total": 0, "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" }

Create a vendor credit

Create a vendor credit for a vendor.
oauthscope : ZohoBooks.debitnotes.CREATE

Arguments

vendor_id
string
(Required)
ID of the vendor the vendor credit associated with the Vendor Credit
vat_treatment
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
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).
vendor_credit_number
string
Mandatory if auto number generation is disabled.
gst_treatment
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
tax_treatment
string
GCC 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.
gst_no
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
15 digit GST identification number of the vendor.
source_of_supply
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
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
๐Ÿ‡ฎ๐Ÿ‡ณ India
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.
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 ๐Ÿ‡บ๐Ÿ‡ธ United States
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 arrow
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
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
HSN Code
reverse_charge_tax_id
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
, 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
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.
tags
array
Show Sub-Attributes arrow
tag_id
long
ID of the tag
tag_option_id
long
ID of the tag option
item_custom_fields
array
Show Sub-Attributes arrow
custom_field_id
long
ID of the Custom Field
label
string
Label of the Custom Field
value
string
Value of the Custom Field
index
integer
Index of the Custom Field
serial_numbers
array
project_id
string
ID of the project
notes
string
Notes for the Vendor Credit
documents
array
Show Sub-Attributes arrow
document_id
long
ID of the Document
file_name
string
Name of the file
custom_fields
array
Show Sub-Attributes arrow
custom_field_id
long
ID of the Custom Field
label
string
Label of the Custom Field
value
string
Value of the Custom Field
index
integer
Index of the Custom Field

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

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "vendor_id": "460000000020029", "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", "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 } ] }

Response Example

{ "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", "tax_treatment_code": "uae_others", "tax_exemption_id": "string", "tax_exemption_code": "string", "tax_name": "string", "tax_type": "string", "tax_percentage": 0, "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 } } ], "acquisition_vat_total": 0, "reverse_charge_vat_summary": [ { "tax": { "tax_name": "string", "tax_amount": 0 } } ], "reverse_charge_vat_total": 0, "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.
oauthscope : 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.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "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.
oauthscope : ZohoBooks.debitnotes.UPDATE

Arguments

vendor_id
string
(Required)
ID of the vendor the vendor credit associated with the Vendor Credit
vat_treatment
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
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).
vendor_credit_number
string
Mandatory if auto number generation is disabled.
gst_treatment
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
tax_treatment
string
GCC 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.
gst_no
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
15 digit GST identification number of the vendor.
source_of_supply
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
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
๐Ÿ‡ฎ๐Ÿ‡ณ India
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.
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 ๐Ÿ‡บ๐Ÿ‡ธ United States
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 arrow
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
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
HSN Code
reverse_charge_tax_id
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
, 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
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.
tags
array
Show Sub-Attributes arrow
tag_id
long
ID of the tag
tag_option_id
long
ID of the tag option
item_custom_fields
array
Show Sub-Attributes arrow
custom_field_id
long
ID of the Custom Field
label
string
Label of the Custom Field
value
string
Value of the Custom Field
index
integer
Index of the Custom Field
serial_numbers
array
project_id
string
ID of the project
notes
string
Notes for the Vendor Credit
documents
array
Show Sub-Attributes arrow
document_id
long
ID of the Document
file_name
string
Name of the file
custom_fields
array
Show Sub-Attributes arrow
custom_field_id
long
ID of the Custom Field
label
string
Label of the Custom Field
value
string
Value of the Custom Field
index
integer
Index of the Custom Field

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id} -X PUT -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "vendor_id": "460000000020029", "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", "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 } ] }

Response Example

{ "code": 0, "message": "Vendor credit information has been updated.", "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", "taxes": [ { "tax_name": "string", "tax_amount": 0 } ], "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, "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 } } ], "acquisition_vat_total": 0, "reverse_charge_vat_summary": [ { "tax": { "tax_name": "string", "tax_amount": 0 } } ], "reverse_charge_vat_total": 0, "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": "string", "refund_mode": "cash", "reference_number": "string", "description": "string", "amount_bcy": 13, "amount_fcy": 13 } ], "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" } }

Get vendor credit

Get details of a vendor credit.
oauthscope : ZohoBooks.debitnotes.READ

Query Parameters

print
Export vendor credit pdf with default print option. Allowed Values: true, false, on and off.
accept
You can get vendor credit details as json/pdf/html. Default format is html. Allowed Values: json, xml, csv, xls, pdf, html and jhtml.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id} -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "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, "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 } } ], "acquisition_vat_total": 0, "reverse_charge_vat_summary": [ { "tax": { "tax_name": "string", "tax_amount": 0 } } ], "reverse_charge_vat_total": 0, "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.
oauthscope : ZohoBooks.debitnotes.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id} -X DELETE

Response Example

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

Convert to open

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

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/status/open -X POST

Response Example

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

Void vendor credit

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

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/status/void -X POST

Response Example

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

Submit a Vendor credit for approval

Submit a Vendor credit for approval.
oauthscope : ZohoBooks.debitnotes.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/submit -X POST

Response Example

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

Approve a Vendor credit

Approve a Vendor credit.
oauthscope : ZohoBooks.debitnotes.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/approve -X POST

Response Example

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

Apply credits to a bill

Apply vendor credit to existing bills.
oauthscope : ZohoBooks.debitnotes.CREATE

Arguments

bills
(Required)
Amount applied from vendor credits to specified bills.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/bills -X POST -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "bills": null }

Response Example

{ "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.
oauthscope : ZohoBooks.debitnotes.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/bills

Response Example

{ "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.
oauthscope : ZohoBooks.debitnotes.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/bills/{vendor_credit_bill_id} -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Refund a vendor credit

Refund vendor credit amount.
oauthscope : 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.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/refunds -X POST -d '{"field":"value","field":"value"}'

Body Parameters

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

Response Example

{ "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.
oauthscope : ZohoBooks.debitnotes.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/refunds

Response Example

{ "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.
oauthscope : 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.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id} -X PUT -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

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

Response Example

{ "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.
oauthscope : ZohoBooks.debitnotes.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id} -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "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.
oauthscope : ZohoBooks.debitnotes.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id} -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

List vendor credit refunds

List all refunds with pagination.
oauthscope : 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
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.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/refunds -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "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.
oauthscope : ZohoBooks.debitnotes.CREATE

Arguments

description
string
(Required)
Description of the Comment

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/comments -X POST -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "description": "Credits applied to Bill 1" }

Response Example

{ "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.
oauthscope : ZohoBooks.debitnotes.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/comments

Response Example

{ "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.
oauthscope : ZohoBooks.debitnotes.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorcredits/{vendor_credit_id}/comments/{comment_id} -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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