RetainerInvoiceDetails
To list, add, update and delete of a retainer invoice.
Table Specific Information
Select
The 本製品 uses the Zoho Books API to process WHERE clause conditions built with the following column and operator:
- RetainerInvoiceId supports the '=' comparison.
NOTE: RetainerInvoiceId is required to query RetainerInvoiceDetails.
The rest of the filter is executed client-side in the 本製品.
For example:
SELECT * FROM RetainerInvoiceDetails WHERE RetainerInvoiceId = '1894663000000085023'
Insert
Insert can be executed by specifying CustomerId, LineItems columns. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.
Insert INTO RetainerInvoiceLineItems#TEMP(description,rate) values('Cloth description','1700')
Insert INTO RetainerInvoiceDetails(CustomerId, LineItems) values('3285934000000104002',RetainerInvoiceLineItems#TEMP)
Update
Update can be executed by specifying the RetainerINVOICEID in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
Insert INTO RetainerInvoiceLineItems#TEMP(description,rate) values('Cloth description updated','1700')
Update RetainerInvoiceDetails set CustomerId='3285934000000104002',LineItems='RetainerInvoiceLineItems#TEMP' WHERE RetainerINVOICEID='3285934000000268036'
Delete
Delete can be executed by specifying the RetainerINVOICEID in the WHERE Clause
For example:
DELETE FROM RetainerInvoiceDetails WHERE RetainerINVOICEID = '3285934000000268036'
Columns
| Name | Type | ReadOnly | References | SupportedOperators | Description |
| RetainerInvoiceId [KEY] | String | True |
RetainerInvoices.RetainerInvoiceId |
Id of retainer invoice. | |
| RetainerinvoiceNumber | String | True |
Number of a retainer invoice. | ||
| AllowPartialPayments | Boolean | True |
Check if the retainer invoice allows partial payments. | ||
| AttachmentName | String | True |
Name of the attachment. | ||
| Balance | Decimal | True |
Total amount left. | ||
| BillingAddress | String | True |
Billing address of a retainer invoice. | ||
| BillingAddressAttention | String | True |
Name of a person in billing address. | ||
| BillingAddressCity | String | True |
City of a billing address. | ||
| BillingAddressCountry | String | True |
Country of a billing address. | ||
| BillingAddressFax | String | True |
Fax of a billing address. | ||
| BillingAddressPhone | String | True |
Phone number of a billing address. | ||
| BillingAddressState | String | True |
State of a billing address. | ||
| BillingAddressStreet2 | String | True |
Street two of a billing address. | ||
| BillingAddressZip | String | True |
ZIP code of a billing address. | ||
| CanSendInMail | Boolean | True |
Check if retainer invoice can be send in mail. | ||
| ClientViewedTime | Datetime | True |
Last time when client viewed retainer invoice. | ||
| ColorCode | String | True |
Color code of retainer invoice. | ||
| ContactPersons | String | False |
Contact Persons | ||
| CreatedById | String | True |
Users.UserId |
Id of a user who has created retainer invoice. | |
| CreatedTime | Datetime | True |
Time at which the retainer invoice was created. | ||
| CurrencyCode | String | True |
Currency code of the customer's currency. | ||
| CurrencyId | String | True |
Currencies.CurrencyId |
Currency ID of the customer's currency. | |
| CurrencySymbol | String | True |
Symbol of currency used for retainer invoice. | ||
| CurrentSubStatus | String | True |
Current sub status of a retainer invoice. | ||
| CurrentSubStatusId | String | True |
Current sub status ID of a retainer invoice. | ||
| CustomerId | String | False |
Contacts.ContactId |
ID of the customer or vendor. | |
| CustomerName | String | True |
Name of the customer or vendor. | ||
| Date | Date | False |
Date of a retainer invoice. | ||
| ExchangeRate | Decimal | True |
Exchange rate of the currency. | ||
| InvoiceUrl | String | True |
URL of invoice. | ||
| IsEmailed | Boolean | True |
Check if the retainer invoice is emailed. | ||
| IsInclusiveTax | Boolean | True |
Check if the retainer invoice is inclusive of tax. | ||
| IsPreGst | Boolean | True |
Check if the retainer invoice is applied by pre GST. | ||
| IsViewedByClient | Boolean | True |
Check if retainer invoice is viewed by client. | ||
| LastModifiedById | String | True |
Users.UserId |
Id of a user who has last modified the retainer invoice. | |
| LastModifiedTime | Datetime | True |
The time of last modification of the retainer invoice. | ||
| LastPaymentDate | Date | True |
Date of payment which was last paid. | ||
| Notes | String | False |
Notes of retainer invoice. | ||
| Orientation | String | True |
Orientation of a page. | ||
| PageHeight | String | True |
Height of a page. | ||
| PageWidth | String | True |
Width of a page. | ||
| PaymentDrawn | Decimal | True |
The payment which was drawn for retainer invoice. | ||
| PaymentOptionPaymentGateways | String | False |
Payment options for the retainer invoice, online payment gateways and bank accounts. | ||
| PaymentMade | Decimal | True |
Payment which was made for the invoice. | ||
| PricePrecision | Integer | True |
The precision for the price. | ||
| ReferenceNumber | String | False |
Reference number of a retainer invoice. | ||
| RoundoffValue | Decimal | True |
Round Off value. | ||
| ShippingAddress | String | True |
Shipment Address. | ||
| ShippingAddressAttention | String | True |
Name of a person of shipping address. | ||
| ShippingAddressCity | String | True |
City of a shipping address. | ||
| ShippingAddressCountry | String | True |
Country of a shipping address. | ||
| ShippingAddressFax | String | True |
Fax of a shipping address. | ||
| ShippingAddressPhone | String | True |
Phone number of a shipping address. | ||
| ShippingAddressState | String | True |
State of a shipping address. | ||
| ShippingAddressStreet2 | String | True |
Street two details of a shipping address. | ||
| ShippingAddressZip | String | True |
Zip code of a shipping address. | ||
| Status | String | True |
Status of the retainer invoice. | ||
| SubTotal | Decimal | True |
Sub total of retainer invoices. | ||
| SubmittedBy | String | True |
Detail of the user who has submitted the retainer invoice. | ||
| SubmittedDate | Date | True |
Date of submission of retainer invoice. | ||
| TemplateId | String | False |
ID of a template. | ||
| TemplateName | String | True |
Name of a template. | ||
| TemplateType | String | True |
Type of a template. | ||
| Terms | String | False |
Terms and Conditions apply of a retainer invoice. | ||
| Total | Decimal | True |
Total of retainer invoices. | ||
| TransactionRoundingType | String | True |
Type of round off used for transaction. | ||
| VatTreatment | String | True |
VAT treatment for the retainer invoice. | ||
| PlaceOfSupply | String | False |
The place of supply is where a transaction is considered to have occurred for VAT purposes. | ||
| TaxSpecification | String | True |
Working of tax when specifying special tax options and tax methods for earnings codes. | ||
| UnusedRetainerPayments | Decimal | True |
Payment of the retainer invoice which is unused. | ||
| LineItems | String | False |
Line items of an estimate. |