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.2.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
The identity and technical contract details declared by the specification.
tag_option_id
string
ID of the tag option
add-a-comment-response
object
3 properties
acquisition_vat_amount
string
Amount of the VAT Acquistion
amount
number
Amount that is credited in the bill
reverse_charge_tax_amount
number
Tax amount of the reverse charge
update-vendor-credit-request
object
20 properties
1 required
sku
string
SKU of the Item
reference_number
string
Reference number for the refund recorded.
tax_percentage
number
Percentage of Tax
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…
reverse_charge_vat_summary
array
Summary of the Reverse Charge
created_time
string
Time of Vendor Credit Creation
commented_by_id
string
ID of the User who caused the comment
reverse_charge_vat_percentage
string
Percentage of the Reverse Charge
customer_name
string
Vendor associated with the Entity
refund-a-vendor-credit-request
object
7 properties
3 required
tags
array
List of tags associated with the line item
has_attachment
boolean
Check if Vendor Credit has attachment
list-refunds-of-a-vendor-credit-response
object
3 properties
amount_bcy
number
Refund Amount in Base Currency
delete-bills-credited-response
object
2 properties
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)
document_id
string
ID of the Document
update-vendor-credit-refund-request
object
7 properties
3 required
vendor_id
string
ID of the vendor the vendor credit associated with the Vendor Credit
bcy_rate
number
Rate of the Item in Base Currency
storages-update
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
item_total
number
Total price of the Item
account_id
string
ID of the account, the line item is associated with
transaction_type
string
Transaction Type that caused the Comment
custom_fields
array
List of custom fields associated with the vendor credit
filed_in_vat_return_type
string
Type of the VAT Return the Vendor Credit is filed in
refund-a-vendor-credit-response
object
3 properties
submit-a-vendor-credit-for-approval-response
object
2 properties
total_credits_used
number
comment_type
string
Type of the comment
balance
number
Balance in the Vendor Credit
reverse_charge_vat_id
string
ID of the Reverse Charge
unit
string
Unit of the line item e.g. kgs, Nos.
imported_transactions
array
total_refunded_amount
number
account_name
string
Name of the account the line item is associated with
hsn_or_sac
string
HSN Code
item_custom_fields
array
List of custom fields associated with the line item
approve-a-vendor-credit-response
object
2 properties
vendor_credit-response
object
44 properties
stock_on_hand
string
Stock on Hand for that Item
imported_transaction_id
string
ID of the Imported Transaction
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…
rate
number
Rate of the line item.
tax_exemption_code
string
Code of the Tax Exemption associated
refund_mode
string
Mode of Refund
documents
array
List of documents associated with the vendor credit
tax_treatment
string
VAT treatment for the vendor credit. Choose whether the vendor falls under: vatregistered , vatnotregistered , gccvatnotregistered , gccvatregistered , nongcc…
acquisition_vat_total
number
Total of the VAT Acquistion
list-vendor-credits-response
object
3 properties
product_type
string
Type of the product. Allowed Values: goods , digitalservice and service .
list-vendor-credit-refunds-response
object
3 properties
gst_no
string
15 digit GST identification number of the vendor.
is_reverse_charge_applied
boolean
Applicable for transactions where you pay reverse charge
apply-credits-to-a-bill-request
object
1 property
1 required
delete-vendor-credit-response
object
2 properties
item_id
string
ID of the item.
comment_id
string
ID of the Comment
tax_amount
number
Amount of the Tax
date
string
The date the vendor credit is created. [yyyy-mm-dd]
destination_of_supply
string
Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)
tds_tax_id
string
TDS Tax ID of the Tax associated with the Vendor Credit
update-vendor-credit-refund-response
object
3 properties
reverse_charge_vat_amount
string
Percentage of the Reverse Charge
last_modified_time
string
Last Modified Time of Vendor Credit
exchange_rate
number
Exchange rate of the currency.
vendor_credit_refund_id
string
ID of the Vendor Credit Refund
currency_id
string
ID of the Currency Involved in the Vendor Credit
item_order
integer
Order of the line item
quantity
number
Quantity of the line item.
vendor_credit_bill_id
string
ID of the Vendor Credited Bill ID
description
string
Description of the line item.
tag_id
string
ID of the tag
list-vendor-credit-comments-and-history-response
object
3 properties
reverse_charge_tax_id
string
ID of the reverse charge tax
get-vendor-credit-response
object
3 properties
list-bills-credited-response
object
3 properties
project_id
string
ID of the project
label
string
Label of the Custom Field
name
string
Name of the line item.
item_total_inclusive_of_tax
number
Total price of the Item inclusive of Tax
pricebook_id
string
ID of the pricebook
customfield_id
string
ID of the Custom Field
reverse_charge_vat_total
number
Total of the Reverse Charge
create-a-vendor-credit-request
object
20 properties
1 required
vendor_credit_id
string
ID of the Vendor Credit
vendor_credit_refunds
array
batches
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
file_name
string
Name of the file
delete-vendor-credit-refund-response
object
2 properties
notes
string
Notes for the Vendor Credit
tax_exemption_id
string
ID of the Tax Exemption associated
acquisition_vat_name
string
Name of the VAT Acquistion
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
create-a-vendor-credit-response
object
3 properties
add-a-comment-request
object
1 property
1 required
apply-credits-to-a-bill-response
object
3 properties
time
string
Time of the Comment
tax_name
string
Name of the Tax
tax_id
string
ID of the Tax associated with the Vendor Credit
date_description
string
Description of the Date of the Comment
reverse_charge_tax_name
string
Enter the tax name of the reverse charge
location_name
string
Name of the location.
currency_code
string
Code of the Currency Involved in the Vendor Credit
location_id
string
Location ID
line_item_id
string
ID of the Line Item
reverse_charge_tax_percentage
number
Tax percentage of the reverse charge
delete-a-comment-response
object
2 properties
operation_type
string
Type of operation that caused the Comment
acquisition_vat_summary
array
Summary of the VAT Acquistion
is_update_customer
boolean
Check if customer should be updated
acquisition_vat_id
string
ID of the VAT Acquistion
transaction_id
string
Transaction ID that caused the Comment
get-vendor-credit-refund-response
object
3 properties
payee
string
Payee of the Transaction
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…
filed_in_vat_return_id
string
ID of the VAT Return the Vendor Credit is filed in
convert-to-open-response
object
2 properties
bill_id
string
Bill Associated with the Vendor Credit
value
string
Value of the Custom Field
tax_type
string
Type of the Tax
vendor_credit_number
string
Number of the Vendor Credit
vendor_credit_refund
object
11 properties
update-vendor-credit-response
object
3 properties
filed_in_vat_return_name
string
Name of the VAT Return the Vendor Credit is filed in
vendor_name
string
Name of the Vendor Associated with the Vendor Credit
void-vendor-credit-response
object
2 properties
storages
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
commented_by
string
Name of the User who caused the comment
acquisition_vat_percentage
string
Percentage of the VAT Acquistion
is_inclusive_tax
boolean
Used to specify whether the line item rates are inclusive or exclusive of 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_vat_name
string
Name of the Reverse Charge
amount_fcy
number
Refund Amount in Foreign Currency
project_name
string
Name of the project.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Zoho Inventory publishes across the network.
