VendorCreditDetails

List, add, update and delete details of a vendor credit.

Table Specific Information

Select

The driver uses the Zoho Books API to process WHERE clause conditions built with the following column and operator:

VendorCreditId supports the '=' and IN operators.

NOTE: VendorCreditId is required to query VendorCreditDetails.

The rest of the filter is executed client-side in the driver.

For example:

    SELECT * FROM VendorCreditDetails WHERE VendorCreditId = '1894545000000083308'
	SELECT * FROM VendorCreditDetails WHERE VendorCreditId IN (SELECT VendorCreditId FROM VendorCredits)
	SELECT * FROM VendorCreditDetails WHERE VendorCreditId IN ('1894545000000083308','1894545000000083309')

Insert

INSERT can be executed by specifying the VendorId, LineItems, and VendorCreditNumber columns. The columns that are not read-only can be inserted optionally. The following is an example of how to insert into this table.

INSERT INTO VendorCreditLineItems#TEMP (Name, itemid, rate, quantity) VALUES ('Cloth-Jeans3', '3285934000000104097', '1700', '1')

INSERT INTO VendorCreditDetails (VendorId, lineitems, VendorCreditNumber) VALUES ('3285934000000104023', VendorCreditLineItems#Temp, '9')

INSERT can also be executed by specifying the LineItems column as a JSON array. The following is an example of how to insert using JSON array into this table.

INSERT INTO VendorCreditDetails (VendorId, LineItems, VendorCreditNumber) VALUES ('3285934000000104023', '[{"Name":"Cloth-Jeans3", "ItemId":"3285934000000104097", "Rate":"1700", "Quantity":"1"}]','9')

Update

UPDATE can be executed by specifying the VendorCreditId in the WHERE Clause. The columns that are not read-only can be updated. The VendorCreditNumber and LineItems columns are required for updating. For example:

INSERT INTO VendorCreditLineItems#TEMP (Name,itemid,rate,quantity) VALUES ('Cloth-Jeans3','3285934000000104097','1700','1')

UPDATE VendorCreditDetails SET VendorId = '3285934000000104002', VendorCreditNumber = 'DN-00001', LineItems = 'VendorCreditLineItems#TEMP' WHERE VendorCreditID = '3285934000000259151'

UPDATE can also be executed by specifying the LineItems column as a JSON array. The following is an example of how to update using JSON array into this table.

UPDATE VendorCreditDetails SET VendorId = '1484772000000063218', VendorCreditNumber = 'DN-00002', LineItems = '[{"Name":"Cloth-Jeans", "ItemId":"3285934000000104097", "Rate":"1700", "Quantity":"1"}]' WHERE VendorCreditID = '1484772000000063218'

Delete

DELETE can be executed by specifying the VendorCreditId in the WHERE Clause For example:

DELETE FROM VendorCreditDetails WHERE VendorCreditId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
VendorCreditId [KEY]	String	True	VendorCredits.VendorCreditId		Id of a vendor credit.
VendorCreditNumber	String	False			Number of vendor credit.
VendorId	String	False			Id of the vendor the vendor credit has been made.
VendorName	String	True			Name of the vendor the vendor credit has been made.
Adjustment	Decimal	True			Adjustments made to the vendor credit.
AdjustmentDescription	String	True			Description of adjustments made to the vendor credit.
ApproverId	String	True	Users.UserId		Id of a approver.
ApproversList	String	True			List of approvers.
Balance	Decimal	True			Total balance of vendor credit.
BillId	String	False	Bills.BillId		Id of a Bill.
BillNumber	String	True			Number of a Bill.
BillsCredited	String	True			BillsCredited.
CanAmendTransactions	Boolean	True			CanAmendTransactions.
ColorCode	String	True			Color code of vendor credit.
Comments	String	True			Comments.
ContactCategory	String	True			Category of a contact.
CreatedTime	Datetime	True			Time at which the vendor credit was created.
CurrencyCode	String	True			Currency code of the customer's currency.
CustomFields	String	True			Custom Fields defined for Journal.
CurrencyId	String	True	Currencies.CurrencyId		Currency Id of the customer's currency.
CurrencySymbol	String	True			CurrencySymbol.
CurrentSubStatus	String	True			Current sub status of a vendor credit.
CurrentSubStatusId	String	True			Current sub status Id of a vendor credit.
Documents	String	False			List of files to be attached to a particular transaction.
Date	Date	False			Vendor Credit date.
DestinationOfSupply	String	False			Place where the goods/services are supplied to.
Discount	String	True			Discount amount applied to vendor credit.
DiscountAccountId	String	True	BankAccounts.AccountId		Account Id of the discount.
DiscountAmount	Decimal	True			Amount of the discount.
DiscountAppliedOnAmount	Decimal	True			Amount applied on discount.
DiscountSetting	String	True			Settings of discount.
ExchangeRate	Decimal	False			Exchange rate applied for vendor credits.
FiledInVatReturnId	String	True			VAT return Id of bill which was filed.
FiledInVatReturnName	String	True			VAT return name of bill which was filed.
FiledInVatReturnType	String	True			VAT return type of bill which was filed.
GstNo	String	False			GST number.
GstReturnDetailsReturnPeriod	String	True			Return period of GST return details.
GstReturnDetailsStatus	String	True			Status of GST return details.
GstTreatment	String	False			Choose whether the vendor credit is GST registered/unregistered/consumer/overseas.
HasNextVendorcredit	Boolean	True			Check if there is nect vendor credit.
IsDiscountBeforeTax	Boolean	True			Check if discount is applicable before tax.
IsInclusiveTax	Boolean	False			Check if tax is inclusive.
IsUpdateCustomer	Boolean	False			Check if customer should be updated.
IsPreGst	Boolean	True			Check if pre GST is applied.
IsReverseChargeApplied	Boolean	True			Check if the reverse charge is applied.
LastModifiedTime	Datetime	True			The time of last modification of the vendor credits.
Notes	String	False			Notes of vendor credit.
Orientation	String	True			Orientation of vendor credit.
PageHeight	String	True			Height of a page.
PageWidth	String	True			Width of a page.
PricebookId	String	False			Id of the pricebook.
PricePrecision	Integer	True			The precision for the price.
ReasonForDebitNote	String	True			Specified reason for debit note.
ReferenceNumber	String	False			Reference number of vendor credit.
SourceOfSupply	String	False			Source of supply.
Status	String	True			Status of the vendor credit.
SubTotal	Decimal	True			Sub total of vendor credits.
SubTotalInclusiveOfTax	Decimal	True			Amount if the subtotal is inclusive of tax.
SubmittedBy	String	True			Detail of the user who has submitted the vendor credit.
SubmittedDate	Date	True			Date when vendor credit was submitted.
SubmitterId	String	True	Users.UserId		Id of vendor credit submitter.
TaxTreatment	String	False			VAT treatment for the Vendor Credit.
TemplateId	String	True			Id of a template.
TemplateName	String	True			Name of a template.
TemplateType	String	True			Type of a template.
Total	Decimal	True			Total of vendor credits.
TotalCreditsUsed	Decimal	True			Total credits used for this vendor credit.
TotalRefundedAmount	Decimal	True			Total amount refunded for a vendor credit.
PlaceOfSupply	String	False			The place of supply is where a transaction is considered to have occurred for VAT purposes.
VatTreatment	String	False			VAT treatment for the vendor credit.
LineItems	String	False			Line items of an estimate.