RetainerInvoices
Read, Insert, Update and Delete Retainer Invoice.
Table Specific Information
Select
The add-in 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 add-in.
- Id supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM RetainerInvoices WHERE Id = '3350895000000089001'
Insert
Insert can be executed by specifying the CustomerId 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 RetainerInvoices (CustomerId, LineItems) VALUES ('3285934000000079043', '[{\"description\":\"500GB, USB 2.0 interface 1400 rpm, protective hard case.\",\"item_order\":5,\"rate\":120}]')
Update
Update can be executed by specifying the Id, CustomerId and LineItems in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE RetainerInvoices SET CustomerId = 3285934000000079043, LineItems = '[{\"description\":\"Testupdate7777777.\",\"item_order\":2,\"rate\":120}]' WHERE Id = '3285934000000136008'
Delete
Delete can be executed by specifying the Id in the WHERE Clause
For example:
DELETE FROM RetainerInvoices WHERE Id = '3350895000000089001'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
ID of the retainerinvoice | |
| Balance | Double | False |
The unpaid amount | |
| ClientViewedTime | Boolean | False |
client viewed time for retainer invoice in client portal. | |
| CreatedTime | Datetime | False |
The time of creation of the retainer invoice | |
| CurrencyCode | String | False |
The currency code in which the retainer invoice is created. | |
| CurrencyId | Long | False |
The currency id of the currency | |
| CustomerId | Long | False |
ID of the customer the retainer invoice has to be created. | |
| CustomerName | String | False |
The name of the customer. | |
| Date | Date | False |
The date of creation of the retainer invoice. | |
| Notes | String | False |
The notes added below expressing gratitude or for conveying some information. | |
| Terms | String | False |
The terms added below expressing gratitude or for conveying some information. | |
| TemplateId | String | False |
ID of the pdf template associated with the retainer invoice. | |
| TemplateName | String | False |
Name of template. | |
| TemplateType | String | False |
Type of template. | |
| PlaceOfSupply | String | False |
Place where the goods/services are supplied to. | |
| HasAttachment | Boolean | False |
Boolean to check whether it has attachment or not | |
| IsEmailed | Boolean | False |
Boolean check to if the email was sent | |
| IsViewedByClient | Boolean | False |
Boolean is retainer invoice viewed by client in client portal. | |
| LastModifiedTime | Datetime | False |
The time of last modification of the retainer invoice | |
| LastPaymentDate | String | False |
The last payment date of the retainer invoice | |
| ProjectOrEstimateName | String | False |
Project or estiminated name | |
| ReferenceNumber | String | False |
The reference number of the retainer invoice. | |
| RetainerinvoiceNumber | String | False |
number of the retainer invoice. | |
| Status | String | False |
retainer invoice status. | |
| Total | Double | False |
The total amount to be paid | |
| IgnoreAutoNumberGeneration | Boolean | False |
Ignore auto invoice number generation for this invoice. | |
| LineItems | String | False |
Line items of a retainer invoice. | |
| PaymentOptionsPaymentGateways | String | False |
Payment options for the retainer invoice, online payment gateways and bank accounts. Will be displayed in the pdf. | |
| CustomFields | String | False |
Custom Fields of a retainer invoice. |
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 |
| StatusFilter | String |
Filter retainer invoices by any status or payment expected date. The allowed values are Status.All, Status.Sent, Status.Draft, Status.OverDue, Status.Paid, Status.Void, Status.Unpaid, Status.PartiallyPaid, Status.Viewed, Date.PaymentExpectedDate. |