Zoho Inventory vendor-credits API
Vendor-Credits Module
Zoho Inventory vendor-credits API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include vendor-credits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 21 operations across 13 paths, and defines 151 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
21 operations
13 paths
151 schemas
4 DELETE7 GET8 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory vendor-credits API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 21
Across 13 paths, the API surfaces 21 operations — 4 DELETE, 7 GET, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
vendor-credits 21
Vendor-Credits Module
POST
/vendorcredits
Create a vendor credit
GET
/vendorcredits
List vendor credits
PUT
/vendorcredits/{vendor_credit_id}
Update vendor credit
GET
/vendorcredits/{vendor_credit_id}
Get vendor credit
DELETE
/vendorcredits/{vendor_credit_id}
Delete vendor credit
POST
/vendorcredits/{vendor_credit_id}/status/open
Convert to open
POST
/vendorcredits/{vendor_credit_id}/status/void
Void vendor credit
POST
/vendorcredits/{vendor_credit_id}/submit
Submit a Vendor credit for approval
POST
/vendorcredits/{vendor_credit_id}/approve
Approve a Vendor credit
GET
/vendorcredits/{vendor_credit_id}/bills
List bills credited
POST
/vendorcredits/{vendor_credit_id}/bills
Apply credits to a bill
DELETE
/vendorcredits/{vendor_credit_id}/bills/{vendor_credit_bill_id}
Delete bills credited
POST
/vendorcredits/{vendor_credit_id}/refunds
Refund a vendor credit
GET
/vendorcredits/{vendor_credit_id}/refunds
List refunds of a vendor credit
PUT
/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}
Update vendor credit refund
GET
/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}
Get vendor credit refund
DELETE
/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}
Delete vendor credit refund
GET
/vendorcredits/refunds
List vendor credit refunds
POST
/vendorcredits/{vendor_credit_id}/comments
Add a comment
GET
/vendorcredits/{vendor_credit_id}/comments
List vendor credit comments & history
DELETE
/vendorcredits/{vendor_credit_id}/comments/{comment_id}
Delete a comment
Schemas 151
The contract defines 151 schemas that model the data the API accepts and returns. The most detailed are vendor_credit-response (44 properties), update-vendor-credit-request (20 properties), create-a-vendor-credit-request (20 properties), vendor_credit_refund (11 properties). Each schema is shown below with its type and property counts.
vendor_credit_number
string
Number of the Vendor Credit
transaction_id
string
Transaction ID that caused the Comment
item_custom_fields
array
List of custom fields associated with the line item
imported_transactions
array
reverse_charge_tax_amount
number
Tax amount of the reverse charge
taxes
array
vendor_name
string
Name of the Vendor Associated with the Vendor Credit
batches
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
update-vendor-credit-refund-request
object
7 properties
3 required
item_id
string
ID of the item.
sub_total
number
comments
array
account_id
string
ID of the account, the line item is associated with
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
documents
array
List of documents associated with the vendor credit
date
string
The date the vendor credit is created. [yyyy-mm-dd]
bills_credited
array
item_total
number
Total price of the Item
update-vendor-credit-request
object
20 properties
1 required
custom_fields
array
List of custom fields associated with the vendor credit
apply-credits-to-a-bill-request
object
1 property
1 required
value
string
Value of the Custom Field
reverse_charge_tax_id
string
ID of the reverse charge tax
batches-update
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
reverse_charge_tax_percentage
number
Tax percentage of the reverse charge
filed_in_vat_return_type
string
Type of the VAT Return the Vendor Credit is filed in
create-a-vendor-credit-response
object
3 properties
document_id
string
ID of the Document
stock_on_hand
string
Stock on Hand for that Item
reverse_charge_vat_amount
string
Percentage of the Reverse Charge
vat_treatment
string
VAT treatment for the invoice. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk . If the vendor i…
tags
array
List of tags associated with the line item
status
string
submit-a-vendor-credit-for-approval-response
object
2 properties
acquisition_vat_summary
array
Summary of the VAT Acquistion
label
string
Label of the Custom Field
total_refunded_amount
number
vendor_credit_refund_id
string
ID of the Vendor Credit Refund
transaction_type
string
Transaction Type that caused the Comment
hsn_or_sac
string
HSN Code
quantity
number
Quantity of the line item.
vendor_credit_refunds
array
acquisition_vat_amount
string
Amount of the VAT Acquistion
refund-a-vendor-credit-request
object
7 properties
3 required
is_update_customer
boolean
Check if customer should be updated
tax_percentage
number
Percentage of Tax
name
string
Name of the line item.
bill_id
string
Bill Associated with the Vendor Credit
bill_number
string
add-a-comment-request
object
1 property
1 required
customer_name
string
Vendor associated with the Entity
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
source_of_supply
string
Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)
time
string
Time of the Comment
vendor_credit-response
object
44 properties
acquisition_vat_total
number
Total of the VAT Acquistion
line_item_id
string
ID of the Line Item
currency_id
string
ID of the Currency Involved in the Vendor Credit
reference_number
string
Reference number for the refund recorded.
comment_id
string
ID of the Comment
location_id
string
Location ID
operation_type
string
Type of operation that caused the Comment
description
string
Description of the line item.
has_attachment
boolean
Check if Vendor Credit has attachment
storages
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
total_credits_used
number
update-vendor-credit-response
object
3 properties
date_description
string
Description of the Date of the Comment
list-vendor-credits-response
object
3 properties
amount
number
Amount that is credited in the bill
project_name
string
Name of the project.
notes
string
Notes for the Vendor Credit
currency_code
string
Code of the Currency Involved in the Vendor Credit
reverse_charge_vat_summary
array
Summary of the Reverse Charge
reverse_charge_vat_id
string
ID of the Reverse Charge
tax_treatment_code
string
Specify reason for using out of scope. Supported values for UAE are uaesametaxgroup , uaereimbursedexpense and uaeothers . Supported values for Bahrain are bah…
last_modified_time
string
Last Modified Time of Vendor Credit
imported_transaction_id
string
ID of the Imported Transaction
storages-update
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
is_inclusive_tax
boolean
Used to specify whether the line item rates are inclusive or exclusive of tax.
get-vendor-credit-response
object
3 properties
commented_by
string
Name of the User who caused the comment
sku
string
SKU of the Item
place_of_supply
string
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…
reverse_charge_vat_total
number
Total of the Reverse Charge
project_id
string
ID of the project
refund_mode
string
Mode of Refund
tax_treatment
string
VAT treatment for the vendor credit. Choose whether the vendor falls under: vatregistered , vatnotregistered , gccvatnotregistered , gccvatregistered , nongcc…
destination_of_supply
string
Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)
add-a-comment-response
object
3 properties
comment_type
string
Type of the comment
filed_in_vat_return_name
string
Name of the VAT Return the Vendor Credit is filed in
update-vendor-credit-refund-response
object
3 properties
refund-a-vendor-credit-response
object
3 properties
exchange_rate
number
Exchange rate of the currency.
list-vendor-credit-comments-and-history-response
object
3 properties
void-vendor-credit-response
object
2 properties
reverse_charge_tax_name
string
Enter the tax name of the reverse charge
unit
string
Unit of the line item e.g. kgs, Nos.
delete-a-comment-response
object
2 properties
approve-a-vendor-credit-response
object
2 properties
created_time
string
Time of Vendor Credit Creation
payee
string
Payee of the Transaction
item_order
integer
Order of the line item
tag_option_id
string
ID of the tag option
list-refunds-of-a-vendor-credit-response
object
3 properties
rate
number
Rate of the line item.
commented_by_id
string
ID of the User who caused the comment
product_type
string
Type of the product. Allowed Values: goods , digitalservice and service .
tax_exemption_code
string
Code of the Tax Exemption associated
tax_exemption_id
string
ID of the Tax Exemption associated
get-vendor-credit-refund-response
object
3 properties
is_reverse_charge_applied
boolean
Applicable for transactions where you pay reverse charge
file_name
string
Name of the file
tax_id
string
ID of the Tax associated with the Vendor Credit
vendor_credit_id
string
ID of the Vendor Credit
acquisition_vat_percentage
string
Percentage of the VAT Acquistion
vendor_credit_bill_id
string
ID of the Vendor Credited Bill ID
filed_in_vat_return_id
string
ID of the VAT Return the Vendor Credit is filed in
tag_id
string
ID of the tag
location_name
string
Name of the location.
convert-to-open-response
object
2 properties
delete-vendor-credit-refund-response
object
2 properties
amount_fcy
number
Refund Amount in Foreign Currency
balance
number
Balance in the Vendor Credit
amount_bcy
number
Refund Amount in Base Currency
pricebook_id
string
ID of the pricebook
delete-bills-credited-response
object
2 properties
list-bills-credited-response
object
3 properties
price_precision
integer
item_total_inclusive_of_tax
number
Total price of the Item inclusive of Tax
acquisition_vat_id
string
ID of the VAT Acquistion
create-a-vendor-credit-request
object
20 properties
1 required
delete-vendor-credit-response
object
2 properties
customfield_id
string
ID of the Custom Field
reverse_charge_vat_percentage
string
Percentage of the Reverse Charge
total
number
tds_tax_id
string
TDS Tax ID of the Tax associated with the Vendor Credit
acquisition_vat_name
string
Name of the VAT Acquistion
bcy_rate
number
Rate of the Item in Base Currency
tax_amount
number
Amount of the Tax
account_name
string
Name of the account the line item is associated with
tax_type
string
Type of the Tax
reverse_charge_vat_name
string
Name of the Reverse Charge
vendor_credit_refund
object
11 properties
apply-credits-to-a-bill-response
object
3 properties
tax
object
2 properties
list-vendor-credit-refunds-response
object
3 properties
gst_no
string
15 digit GST identification number of the vendor.
tax_name
string
Name of the Tax
vendor_id
string
ID of the vendor the vendor credit associated with the Vendor Credit
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho Inventory 12
Other APIs Zoho Inventory publishes across the network.
Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory compositeitems API
Zoho Inventory contact-persons API
Zoho Inventory contacts API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API
#vendor-credits