Invoices
Retrieves list of all invoices.
Table Specific Information
Select
The 本製品 uses the Zoho Books API to process WHERE clause conditions built with the following columns and operators:
- InvoiceNumber supports the '=' comparison.
- ProjectId supports the '=' comparison.
- Balance supports the '=' comparison.
- CustomerId supports the '=' comparison.
- CustomerName supports the '=' comparison.
- Date supports the '=,<,>' comparisons.
- DueDate supports the '=,<,>' comparisons.
- LastModifiedTime supports the '=' comparison.
- ReferenceNumber supports the '=' comparison.
- Status supports the '=' comparison.
- Total supports the '=' comparison.
- Email supports the '=' comparison.
- RecurringInvoiceId supports the '=' comparison.
- ItemId supports the '=' comparison.
- ItemName supports the '=' comparison.
- ItemDescription supports the '=' comparison.
- InvoiceFilter supports the '=' comparison.
The rest of the filter is executed client-side in the 本製品.
For example:
SELECT * FROM Invoices WHERE InvoiceNumber = 'INV-000057' AND CustomerName = 'OldTech Industries' AND Date = '2016-03-02'
SELECT * FROM Invoices WHERE DueDate > '2019-07-02'
SELECT * FROM Invoices ORDER BY CreatedTime DESC
Columns
| Name | Type | References | SupportedOperators | Description |
| InvoiceId [KEY] | String | Id of an invoice. | ||
| InvoiceNumber | String | Number of an invoice. | ||
| Adjustment | Decimal | Adjustments made to the invoices. | ||
| Balance | Decimal | The unpaid amount. | ||
| CompanyName | String | Name of the conpany. | ||
| CreatedTime | Datetime | Time at which the invoice was created. | ||
| CustomerId | String |
Contacts.ContactId | Id of the customer the invoice has to be created. | |
| CustomerName | String | The name of the customer. | ||
| Date | Date | =,<,> | Date of an invoice. | |
| DueDate | Date | =,<,> | Date of when the invoice is due. | |
| DueDays | String | Number of due day left for invoice. | ||
| HasAttachment | Boolean | Check if the invoice has attachment. | ||
| InvoiceURL | String | URL of Invoice. | ||
| LastModifiedTime | Datetime | The time of last modification of the invoice. | ||
| ProjectName | String | Name of the project. | ||
| ReferenceNumber | String | The reference number of the invoice. | ||
| Status | String | Status of the invoice.
使用できる値は次のとおりです。sent, draft, overdue, paid, void, unpaid, partially_paid, viewed | ||
| Total | Decimal | Total of invoices. | ||
| AchPaymentInitiated | Boolean | Indicates if an ACH payment was initiated. | ||
| BillingAddress | String | Billing address of an invoice. | ||
| BillingAddressAttention | String | Name of a person in billing address. | ||
| BillingAddressCity | String | City of a billing address. | ||
| BillingAddressCountry | String | Country of a billing address. | ||
| BillingAddressFax | String | Fax of a billing address. | ||
| BillingAddressPhone | String | Phone number of a billing address. | ||
| BillingAddressState | String | State of a billing address. | ||
| BillingAddressStreet2 | String | Street two of a billing address. | ||
| BillingAddressZip | String | ZIP code of a billing address. | ||
| ClientViewedTime | Datetime | Time when the invoice was viewed by the client. | ||
| ColorCode | String | Color code for the invoice. | ||
| Country | String | Country of the invoice. | ||
| CreatedBy | String | User who created the invoice. | ||
| CurrencyCode | String | The currency code in which the invoice is created | ||
| CurrencyId | String | The currency id of the currency. | ||
| CurrencySymbol | String | Currency symbol of the invoice. | ||
| CurrentSubStatus | String | Current sub-status of the invoice. | ||
| CurrentSubStatusId | String | ID of the current sub-status. | ||
| Documents | String | Documents attached to the invoice. | ||
| ExchangeRate | Decimal | Exchange rate of the currency. | ||
| IsEmailed | Boolean | Boolean check to see if the mail has been sent. | ||
| IsPreGst | Boolean | Applicable for transactions that fall before july 1, 2017 | ||
| IsViewedByClient | Boolean | Indicates if the invoice has been viewed by the client. | ||
| IsViewedInMail | Boolean | Indicates if the invoice has been viewed in mail. | ||
| LastPaymentDate | Date | Date of the last payment received for the invoice. | ||
| LastReminderSentDate | Date | The date the last email was sent | ||
| MailFirstViewedTime | Datetime | Time when the mail was first viewed. | ||
| MailLastViewedTime | Datetime | Time when the mail was last viewed. | ||
| NoOfCopies | Integer | Number of copies of the invoice. | ||
| PaymentExpectedDate | Date | Expected date of payment. | ||
| Phone | String | Phone number associated with the invoice. | ||
| RemindersSent | Integer | Number of reminders sent for the invoice. | ||
| SalespersonId | String | Salesperson ID associated with the invoice. | ||
| SalespersonName | String | Salesperson name associated with the invoice. | ||
| ScheduleTime | Datetime | Scheduled time for the invoice. | ||
| ShippingAddress | String | Shipment Address. | ||
| ShippingAddressAttention | String | Name of a person of shipping address. | ||
| ShippingAddressCity | String | City of a shipping address. | ||
| ShippingAddressCountry | String | Country of a shipping address. | ||
| ShippingAddressFax | String | Fax of a shipping address. | ||
| ShippingAddressPhone | String | Phone number of a shipping address. | ||
| ShippingAddressState | String | State of a shipping address. | ||
| ShippingAddressStreet2 | String | Street two details of a shipping address. | ||
| ShippingAddressZip | String | Zip code of a shipping address. | ||
| ShippingCharge | Decimal | Shipping charge applied to the invoice. | ||
| ShowNoOfCopies | Boolean | Indicates if the number of copies should be shown. | ||
| TemplateId | String | Template ID used for the invoice. | ||
| TemplateType | String | Type of template used. | ||
| TransactionType | String | Type of transaction for the invoice. | ||
| Type | String | Type of the invoice. | ||
| UnprocessedPaymentAmount | Decimal | Unprocessed payment amount for the invoice. | ||
| UpdatedTime | Datetime | Time when the invoice was last updated. | ||
| WriteOffAmount | Decimal | Write-off amount for the invoice. | ||
| ZcrmPotentialId | String | Zoho CRM Potential ID. | ||
| ZcrmPotentialName | String | Zoho CRM Potential Name. |
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 | |
| String | Email address of an invoice. | ||
| RecurringInvoiceId | String | Id of the recurring invoice from which the invoice is created. | |
| ItemId | String | Id of an item. | |
| ItemName | String | Name of an item. | |
| ItemDescription | String | Description of an item. | |
| InvoiceFilter | String | Filter invoices by any status or payment expected date.
使用できる値は次のとおりです。Status.All, Status.Sent, Status.Draft, Status.OverDue, Status.Paid, Status.Void, Status.Unpaid, Status.PartiallyPaid, Status.Viewed, Date.PaymentExpectedDate |