RecurringInvoices
Retrieves list of all recurring invoices.
Table Specific Information
Select
The cmdlet uses the Zoho Books API to process WHERE clause conditions built with the following columns and operators:
- RecurrenceName supports the '=' comparison.
- CustomerId supports the '=' comparison.
- CustomerName supports the '=' comparison.
- Status supports the '=' comparison.
- RecurringInvoiceFilter supports the '=' comparison.
- LineItemId supports the '=' comparison.
- TaxId supports the '=' comparison.
- Notes supports the '=' comparison.
- ItemId supports the '=' comparison.
- ItemName supports the '=' comparison.
- ItemDescription supports the '=' comparison.
The rest of the filter is executed client-side in the cmdlet
For example:
SELECT * FROM RecurringInvoices WHERE RecurrenceName = 'Office Rent' AND EndDate = '2018-06-21'
SELECT * FROM RecurringInvoices WHERE ItemName = 'Standard Plan'
Columns
| Name | Type | References | SupportedOperators | Description |
| RecurringInvoiceId [KEY] | String | Id of a recurring invoice. | ||
| RecurrenceName | String | Name of a recurrence. | ||
| ChildEntityType | String | Entity type of a child. | ||
| CreatedTime | Datetime | Time at which the recurring invoice was created. | ||
| CustomerId | String |
Contacts.ContactId | Id of the customer or vendor. | |
| CustomerName | String | Name of the customer or vendor. | ||
| EndDate | Date | End date for the statement. | ||
| LastFourDigits | String | It store the last four digits of customer's card details. | ||
| LastModifiedTime | Datetime | The time of last modification of the recurring invoice. | ||
| LastSentDate | Date | Date recurring invoice was last sent. | ||
| NextInvoiceDate | Date | Date when recurring invoice will be send next. | ||
| RecurrenceFrequency | String | Frequency of the recurrence. | ||
| ReferenceNumber | String | Reference number of recurring invoice. | ||
| StartDate | Date | Starting date of recurring invoice. | ||
| Status | String | Status of the recurring invoice.
The allowed values are active, stopped, expired. | ||
| Total | Decimal | Total of recurring invoices. |
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 | |
| RecurringInvoiceFilter | String | Filter recurring invoice by status.
The allowed values are Status.All, Status.Active, Status.Stopped, Status.Expired. | |
| LineItemId | String | Id of a line item. | |
| TaxId | String | Id of tax. | |
| Notes | String | Notes for this recurring invoice. | |
| ItemId | String | Id of an item. | |
| ItemName | String | Name of an item. | |
| ItemDescription | String | Description of an item. |