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