CreditNotes
Retrieves list of all the Credit Notes.
Table Specific Information
Select
The add-in uses the Zoho Books API to process WHERE clause conditions built with the following columns and operators:
- CreditnoteNumber 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.
- CreditNoteFilter supports the '=' comparison.
- LineItemId supports the '=' comparison.
- TaxId 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 add-in.
For example:
SELECT * FROM CreditNotes WHERE CreditnoteNumber = 'CN-00006' AND ReferenceNumber = 'Ref-0075' AND CustomerName = 'AWS Stores'
SELECT * FROM CreditNotes WHERE CreditNoteFilter = 'Status.All'
Columns
| Name | Type | References | SupportedOperators | Description |
| CreditnoteId [KEY] | String | Id of credit note. | ||
| Balance | Decimal | Total amount of credit note left. | ||
| ColorCode | String | Color code of a credit note. | ||
| CreatedTime | Datetime | Time at which the credit note was created. | ||
| CreditnoteNumber | String | Number of a credit note. | ||
| CurrencyCode | String | Currency code of the customer's currency. | ||
| CurrencyId | String |
Currencies.CurrencyId | Currency Id of the customer's currency. | |
| CurrentSubStatus | String | Current sub status of a credit note. | ||
| CustomerId | String |
Contacts.ContactId | Id of the customer or vendor. | |
| CustomerName | String | Name of the customer or vendor. | ||
| Date | Date | Date of a credit note. | ||
| HasAttachment | Boolean | Check if the credit note has attachment. | ||
| ReferenceNumber | String | Reference number of credit note. | ||
| Status | String | Status of the credit note.
The allowed values are open, closed, void. | ||
| Total | Decimal | Total of credit notes. |
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 credit notes by status.
The allowed values are Status.All, Status.Open, Status.Draft, Status.Closed, Status.Void. | |
| LineItemId | String | Id of a line item. | |
| TaxId | String | Id of a tax. | |
| ItemId | String | Id of an item. | |
| ItemName | String | Name of an item. | |
| ItemDescription | String | Description of an item. |