VendorCredits

Read, Insert, Update and Delete Vendor Credits.

Table Specific Information

Select

The cmdlet will use the Zoho Inventory API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the cmdlet.

Id supports the '=' comparison.
VendorId supports the '=' comparison.
PriceBookId supports the '=' comparison.
Balance supports the '=' comparison.
CreatedTime supports the '=' comparison.
Date supports the '>,<,>=,<=,=' comparisons.
LastModifiedTime supports the '>,<,>=,<=,=' comparisons.
ReferenceNumber supports the '=,LIKE' comparisons.
Status supports the '=' comparison.
Total supports the '=,>,<,>=,<=' comparisons.
VendorCreditNumber supports the '=,LIKE' comparisons.
Notes supports the '=,LIKE' comparisons.
VendorName supports the '=' comparison.
CustomerName supports the '=,LIKE' comparisons.
ItemName supports the '=,LIKE' comparisons.
ItemDescription supports the '=,LIKE' comparisons.
ItemId supports the '=' comparison.
LineItemId supports the '=' comparison.
VendorCreditsFilter supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM VendorCredits WHERE Id = '3350895000000089001'

SELECT * FROM VendorCredits WHERE VendorCreditNumber = '983872973'

SELECT * FROM VendorCredits WHERE Date = '22-09-12'

SELECT * FROM VendorCredits WHERE Status = 'closed'

SELECT * FROM VendorCredits WHERE Total = '244'

SELECT * FROM VendorCredits WHERE ReferenceNumber = '2287678362612'

SELECT * FROM VendorCredits WHERE CustomerName = 'Ms. Name'

SELECT * FROM VendorCredits WHERE ItemName = 'item name'

SELECT * FROM VendorCredits WHERE ItemDescription = 'Item description'

SELECT * FROM VendorCredits WHERE Notes = 'my notes'

SELECT * FROM VendorCredits WHERE LastModifiedTime = '2014-08-28T22:53:31-0700'

SELECT * FROM VendorCredits WHERE LineItemId = '3359001'

Insert

Insert can be executed by specifying the VendorId 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 VendorCredits (VendorId) VALUES (324905600000085109)

Update

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE VendorCredits SET Notes = 'test2' WHERE Id = '3285934000000136008'

Delete

Delete can be executed by specifying the Id in the WHERE Clause For example:

DELETE FROM VendorCredits WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		ID of the vendor the vendor credit associated with the Vendor Credit
VendorId	Long	False		ID of the Vendor Involved in the Vendor Credit
PriceBookId	Long	False		ID of the Currency Involved in the Vendor Credit
Balance	Integer	True		Balance in the Vendor Credit
CreatedTime	Datetime	True		Time of Vendor Credit Creation
CurrencyCode	String	True		Code of the Currency Involved in the Vendor Credit
CurrencyId	String	True		ID of the Currency Involved in the Vendor Credit
SourceofSupply	String	True		Place from where the goods/services are supplied.
DestinationofSupply	String	True		Place where the goods/services are supplied to.
PlaceofSupply	String	True		The place of supply is where a transaction is considered to have occurred for VAT purposes.
GstNo	String	True		15 digit GST identification number of the customer/vendor..
GstTreatment	String	True		Choose whether the contact is GST registered/unregistered/consumer/overseas.
Date	Date	False		The date the vendor credit is created. [yyyy-mm-dd]
ExchangeRate	Integer	False		Exchange rate of the currency.
HasAttachment	Boolean	True		Boolean to check whether it has attachment or not
IsReverseChargeApplied	Boolean	True		Applicable for transactions where you pay reverse charge
IsUpdateCustomer	Boolean	False		Check if customer should be updated
IsInclusiveTax	Boolean	False		Check if tax is inclusive.
LastModifiedTime	Datetime	True		Search vendor credits by vendor credit last modfified time
ReferenceNumber	String	False		Search vendor credits by vendor credit reference number.
Status	String	True		Search vendor credits by vendor credit status. The allowed values are open, closed, void.
SourceofSupply	String	True		Place from where the goods/services are supplied.
Total	Integer	True		Search vendor credits by total amount.
Tags	String	False		tags
Notes	String	False		notes
TaxTreatment	String	True		VAT treatment for the vendor credit.
VendorCreditNumber	String	False		Number of the Vendor Credit
VendorName	String	True		Name of the Vendor Associated with the Vendor Credit
LineItems	String	False		Line items of a vendor credit.
VendorCreditRefunds	String	True		Vendor Credit Refunds.
Documents	String	False		Documents.
Comments	String	True		Comments.
BillsCredited	String	True		Bills Credited.
CustomerName	String	True		Search vendor credits by vendor name.
ItemName	String	True		Name of an item.
ItemDescription	String	True		Description of an item.
ItemId	Long	False	Items.ItemId	Id of an item.
LineItemId	Long	True		Id of lineitem.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

VendorCreditsFilter

String

Filter invoices by any status or payment expected date.

The allowed values are Status.All, Status.Draft, Status.Void, Status.Open, Status.Closed.

Cmdlets for Zoho Inventory