CreditNotes

List, Insert,Update and Delete Credit Notes.

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.
Balance supports the '=' comparison.
CreatedTime supports the '=' comparison.
CreditnoteNumber supports the '=' comparison.
CurrencyCode supports the '=' comparison.
CustomerId supports the '=' comparison.
CustomerName supports the '=' comparison.
Date supports the '=' comparison.
ReferenceNumber supports the '=' comparison.
Status supports the '=' comparison.
Total supports the '=' comparison.
ItemId supports the '=' comparison.
ItemName supports the '=' comparison.
CreditNoteFilter supports the '=' comparison.
ItemDescription supports the '=, LIKE' comparisons.

For example, the following queries are processed server side:

SELECT * FROM CreditNotes WHERE Id = '3350895000000089001'

SELECT * FROM CreditNotes WHERE CreditnoteNumber = '837872'

SELECT * FROM CreditNotes WHERE Date = '2016-06-05'

SELECT * FROM CreditNotes WHERE Status = 'open'

SELECT * FROM CreditNotes WHERE Total = '500'

SELECT * FROM CreditNotes WHERE ReferenceNumber = '5000000089001'

SELECT * FROM CreditNotes WHERE CustomerName = 'name'

SELECT * FROM CreditNotes WHERE ItemName = 'item1'

SELECT * FROM CreditNotes WHERE CustomerId = '987652367'

SELECT * FROM CreditNotes WHERE ItemDescription = 'new item'

SELECT * FROM CreditNotes WHERE ItemId = '298755'

Insert

Insert can be executed by specifying the CustomerId, CreditnoteNumber and LineItems 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 CreditNotes (CustomerId, Date, CreditnoteNumber, LineItems) VALUES (3249056000000113107,, '12-12-22', 'CN-00006', '[{\"item_id\": \"3249056000000083053\", \"description\": \"prorated amount for items\",\"type\": 1, \"invoice_id\": \"3249056000000186055\",\"tax_id\": \"3249056000000158109\"}]')

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 CreditNotes SET Balance = 5000 WHERE Id = 3249056000000185047

Delete

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

DELETE FROM CreditNotes WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique ID of the credit note generated by the server.
Balance	Integer	True		The unapplied credits.
CreatedTime	Datetime	True		Time at which the credit note was created..
CreditnoteNumber	String	False		Unique number generated which will be displayed in the interface and credit notes.
CurrencyCode	String	True		Customer currency code.
CurrencyId	String	True		Unique Id of currencies.
CustomerId	String	False	Contacts.Id	Customer ID of the customer for whom the credit note is raised..
CustomerName	String	True		Name of the customer to whom the credit note is raised.
Date	Date	False		The date on which the credit note was raised.
Email	String	True		Email address of the customer.
GstNo	String	True		15 digit GST identification number of the customer.
GstTreatment	String	True		Choose whether the contact is GST registered/unregistered/consumer/overseas.
IsPreGst	Boolean	True		Applicable for transactions that were created before July 1, 2017.
IsDraft	Boolean	False		Set to true if credit note has to be created in draft status.
IsEmailed	Boolean	True		Boolean to check whether emailed or not.
ExchangeRate	String	False		Exchange rate for the currency associated with the customer.
LastModifiedTime	Datetime	True		Time at which the credit note details were last modified.
PlaceOfSupply	String	True		Place where the goods/services are supplied to.
IgnoreAutoGenerationNumber	Boolean	False		Set to true if you need to provide your own credit note number.
ReferenceNumber	String	False		Reference number generated for the payment. A string of your choice can also be used as the reference number.
Status	String	True		Status of the credit note. The allowed values are open, closed, void.
Total	Integer	False		Total credits raised in this credit note.
Notes	String	False		A short note for the credit note
TaxTreatment	String	True		Place where the goods/services are supplied to.
TemplateId	Long	False		Unique ID of the creditnote template
TaxAuthorityId	Long	False	TaxAuthorities.Id	Unique ID of the tax authority. Tax authority depends on the location of the customer.
TaxExemptionId	Long	False	TaxExemptions.Id	Unique ID of the tax exemption
TaxId	Long	False	Taxes.Id	Unique ID to denote the tax associated with the credit note.
TemplateName	String	True		Name of the default template of the creditnote.
Terms	String	False		Terms and condition to be displayed in the credit note.
Total	Integer	True		Total credits raised in this credit note.
UpdatedTime	Datetime	True		Time at which the credit note details were last updated.
VatRegNo	String	True		vat_reg_no
VatTreatment	String	True		VAT treatment for the credit notes.
LineItems	String	True		Line items of credit notes.
Invoices	String	True		List of invoices for which the credit note has been raised.
Taxes	String	True		Taxes associated with the subscription.
ItemId	String	False	Items.Id	Id of an item.
ItemName	String	True		Name of an item.
ItemDescription	String	True		Description of an item.

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

CreditNoteFilter

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