CreditNoteDetails
Retrieves details of an existing Credit Note.
Table Specific Information
Select
The {i will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the {i.
Note: CreditnoteId is required in order to query CreditNoteDetails.
- CreditnoteId supports the '=' comparison.
SELECT * FROM CreditNoteDetails WHERE CreditnoteId = '1895452000000083136'
Columns
Name | Type | References | SupportedOperators | Description |
CreditnoteId [KEY] | String |
CreditNotes.CreditnoteId | ID of a credit note. | |
CreditnoteNumber | String | Number of a credit note. | ||
Adjustment | Decimal | Adjustments made to the credit note. | ||
AdjustmentDescription | String | Description of adjustments made to the credit note. | ||
ApproverId | String |
Users.UserId | ID of an approver. | |
Balance | Decimal | The unpaid amount. | ||
BillingAddress | String | Billing address of a credit note. | ||
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. | ||
ColorCode | String | Color code of a credit note. | ||
ContactCategory | String | Category of a contact. | ||
CreatedById | String |
Users.UserId | Id of a user who has created credit note. | |
CreatedTime | Datetime | Time at which the credit note was created. | ||
CurrencyCode | String | Currency code of the customer's currency. | ||
CurrencyId | String |
Currencies.CurrencyId | Currency ID of the customer's currency. | |
CurrencySymbol | String | Currency symbol of the customer's currency. | ||
CurrentSubStatus | String | Current sub status of a credit note. | ||
CurrentSubStatusId | String | Current sub status ID 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. | ||
Discount | String | Discount given to specific item in credit note. | ||
DiscountAmount | Decimal | Amount of discount. | ||
DiscountAppliedOnAmount | Decimal | Discount applied on amount. | ||
DiscountType | String | Type of discount. | ||
ExchangeRate | Decimal | Exchange rate of the currency. | ||
FiledInVatReturnId | String | VAT return ID of credit note which was filed. | ||
FiledInVatReturnName | String | VAT return name of credit note which was filed. | ||
FiledInVatReturnType | String | VAT return type of credit note which was filed. | ||
GstNo | String | GST number used for credit note. | ||
GstReason | String | Reason for GST given for credit note. | ||
GstReturnDetailsReturnPeriod | String | Period for GST return. | ||
GstReturnDetailsStatus | String | Status of GST return details. | ||
GstTreatment | String | Choose whether the credit note is GST registered/unregistered/consumer/overseas. . | ||
HasNextCreditnote | Boolean | Check if it has credit note. | ||
InvoiceId | String |
Invoices.InvoiceId | Invoice ID for credit note. | |
InvoiceNumber | String | Invoice number for credit note. | ||
IsDiscountBeforeTax | Boolean | Check if the discount is applied before tax in credit note. | ||
IsEmailed | Boolean | Check if the credit note is emailed. | ||
IsEwayBillRequired | Boolean | Check if eway bill is required for credit note. | ||
IsInclusiveTax | Boolean | Check if the credit note is inclusive tax. | ||
IsPreGst | Boolean | Check if pre GST is applied. | ||
IsTaxable | Boolean | Check if this credit note is taxable. | ||
LastModifiedById | String |
Users.UserId | Id of the user last modified. | |
LastModifiedTime | Datetime | The time of last modification of the credit note. | ||
Notes | String | Notes for this credit note. | ||
Orientation | String | Orientation of a page. | ||
PageHeight | String | Height of a page. | ||
PageWidth | String | Width of a page. | ||
PlaceOfSupply | String | The place of supply is where a transaction is considered to have occurred for VAT purposes. | ||
PricePrecision | Integer | The precision for the price. | ||
ReasonForCreditnote | String | Any specific reason for taking credit note. | ||
ReferenceNumber | String | Reference number of credit note. | ||
ReverseChargeTaxTotal | Decimal | Total amount to pay the liability of tax. | ||
RoundoffValue | Decimal | Rounding off the values to precise number. | ||
SalespersonId | String | ID of a sales person. | ||
SalespersonName | String | Name of a sales person. | ||
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 of credit note. | ||
Status | String | Status of the credit note. | ||
SubTotal | Decimal | Sub total of credit notes. | ||
SubTotalInclusiveOfTax | Decimal | Subtotal amount which are inclusive of tax. | ||
SubmittedBy | String | Detail of the user who has submitted the credit note. | ||
SubmittedDate | Date | Date when credit note was submitted. | ||
SubmitterId | String |
Users.UserId | Id of a submitter of credit note. | |
TaxSpecification | String | Working of tax when specifying special tax options and tax methods for earnings codes. | ||
TaxTotal | Decimal | Total amount of Tax. | ||
TaxTreatment | String | VAT treatment for the Credit Note. | ||
TemplateId | String | ID of a template. | ||
TemplateName | String | Name of a tempalte. | ||
TemplateType | String | Type of a template. | ||
Terms | String | Terms and Conditions apply of a credit note. | ||
Total | Decimal | Total of credit notes. | ||
TotalCreditsUsed | Decimal | Total credits used for credit note. | ||
TotalRefundedAmount | Decimal | Total amount refunded for a credit note. | ||
TransactionRoundingType | String | Type of round off used for transaction. | ||
VatTreatment | String | VAT treatment for the credit note. |