VendorCreditDetails
To list, add, update and delete details of a vendor credit.
Table Specific Information
Select
The provider will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the provider.
Note: VendorCreditId is required in order to query VendorCreditDetails.
- VendorCreditId supports the '=' comparison.
SELECT * FROM VendorCreditDetails WHERE VendorCreditId = '1894545000000083308'
Insert
Insert can be executed by specifying the ContactName column. The columns that are not read-only can be inserted optionally. 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')
Update
Update can be executed by specifying the VendorCreditId in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
Insert INTO VendorCreditLineItems#TEMP(Name,itemid,rate,quantity) values('Cloth-Jeans3','3285934000000104097','1700','1')
Update VendorCreditDetails set CustomerId='3285934000000104002',LineItems='VendorCreditLineItems#TEMP' WHERE VendorCreditID='3285934000000259151'
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. | |
Balance | Decimal | True |
Total balance of vendor credit. | ||
BillId | String | False |
Bills.BillId |
ID of a Bill. | |
BillNumber | String | True |
Number of a Bill. | ||
ColorCode | String | True |
Color code of vendor credit. | ||
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. | |
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. |