CreditNoteDetails
To list, add, update and delete a Credit Note.
Table Specific Information
Select
The 本製品 uses the Zoho Books API to process WHERE clause conditions built with the following column and operator:
- CreditnoteId supports the '=' and IN operators.
NOTE: CreditnoteId is required to query CreditNoteDetails.
The rest of the filter is executed client-side in the 本製品.
For example:
SELECT * FROM CreditNoteDetails WHERE CreditnoteId = '1895452000000083136' SELECT * FROM CreditNoteDetails WHERE CreditNoteId IN (SELECT CreditNoteId FROM CreditNotes) SELECT * FROM CreditNoteDetails WHERE CreditnoteId IN ('1895452000000083136','1895452000000083137')
Insert
INSERT can be executed by specifying the CustomerId, Date, LineItems, and CreditnoteNumber columns. The columns that are not read-only can be inserted optionally. The following is an example of how to insert into this table.
INSERT INTO CreditNoteLineItems#TEMP (Name, accountid, itemid) VALUES ('Cloth-Jeans', '3285934000000034001', '3285934000000104097')
INSERT INTO CreditNoteDetails (customerid, date, lineitems, creditnotenumber) VALUES ('3285934000000085043', '2023-01-18', CreditNoteLineItems#Temp, 'CN-100')
INSERT can also be executed by specifying the LineItems column as a JSON array. The following is an example of how to insert using JSON array into this table.
INSERT INTO CreditNoteDetails (CustomerId, Date, LineItems, CreditNoteNumber) VALUES ('3255827000000081003', '2023-01-18', '[{"Name":"Cloth-Jeans3", "AccountId":"3285934000000034001", "ItemId":"3285934000000104097"}]', 'CN-100')
Update
UPDATE can be executed by specifying the CreditNoteId in the WHERE Clause. The columns that are not read-only can be updated.
For example:
INSERT INTO CreditNoteLineItems#TEMP (Name,accountid,itemid) VALUES ('Cloth-Jeans1','3285934000000034001','3285934000000104097')
UPDATE CreditNoteDetails SET customerid = '3285934000000085043', date = '2023-01-17', lineitems = 'CreditNoteLineItems#Temp' WHERE creditnoteid = '3285934000000265005'
UPDATE can also be executed by specifying the LineItems column as a JSON array. The following is an example of how to update using JSON array into this table.
UPDATE CreditNoteDetails SET CustomerId = '3285934000000085043', Date = '2023-01-17', LineItems = '[{"Name":"Cloth-Jeans", "AccountId":"3285934000000034001", "ItemId":"3285934000000104097"}]' WHERE CreditNoteId = '3285934000000265005'
Delete
DELETE can be executed by specifying the CreditNoteId in the WHERE Clause
For example:
DELETE FROM CreditNoteDetails WHERE CreditnoteId = '3285934000000265005'
Columns
Name | Type | ReadOnly | References | SupportedOperators | Description |
CreditnoteId [KEY] | String | True |
CreditNotes.CreditnoteId |
Id of a credit note. | |
CreditnoteNumber | String | False |
Number of a credit note. | ||
Adjustment | Decimal | True |
Adjustments made to the credit note. | ||
AdjustmentDescription | String | True |
Description of adjustments made to the credit note. | ||
ApproverId | String | True |
Users.UserId |
Id of an approver. | |
ApproversList | String | True |
List of approvers. | ||
AvataxUseCode | String | False |
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. | ||
AvataxTaxCode | String | False |
A tax code is a unique label used to group items together. | ||
AvataxExemptNo | String | False |
Exemption certificate number of the customer. | ||
Balance | Decimal | True |
The unpaid amount. | ||
BillingAddress | String | True |
Billing address of a credit note. | ||
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. | ||
ColorCode | String | True |
Color code of a credit note. | ||
ContactCategory | String | True |
Category of a contact. | ||
ContactPersons | String | False |
Contact persons of a contact. | ||
CreatedById | String | True |
Users.UserId |
Id of a user who has created credit note. | |
CreatedTime | Datetime | True |
Time at which the credit note was created. | ||
CreditNoteRefunds | String | True |
CreditNoteRefunds | ||
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 |
Currency symbol of the customer's currency. | ||
CurrentSubStatus | String | True |
Current sub status of a credit note. | ||
CurrentSubStatusId | String | True |
Current sub status Id of a credit note. | ||
CustomerId | String | False |
Contacts.ContactId |
Id of the customer or vendor. | |
CustomerName | String | True |
Name of the customer or vendor. | ||
CustomFields | String | False |
Custom fields of the contact. | ||
Date | Date | False |
Date of a credit note. | ||
Discount | String | True |
Discount given to specific item in credit note. | ||
DiscountAppliedOnAmount | Decimal | True |
Discount applied on amount. | ||
DiscountType | String | True |
Type of discount. | ||
ExchangeRate | Decimal | False |
Exchange rate of the currency. | ||
FiledInVatReturnId | String | True |
VAT return Id of credit note which was filed. | ||
FiledInVatReturnName | String | True |
VAT return name of credit note which was filed. | ||
FiledInVatReturnType | String | True |
VAT return type of credit note which was filed. | ||
GstNo | String | False |
GST number used for credit note. | ||
GstReason | String | True |
Reason for GST given for credit note. | ||
GstReturnDetailsReturnPeriod | String | True |
Period for GST return. | ||
GstReturnDetailsStatus | String | True |
Status of GST return details. | ||
GstTreatment | String | False |
Choose whether the credit note is GST registered/unregistered/consumer/overseas. . | ||
HasNextCreditnote | Boolean | True |
Check if it has credit note. | ||
InvoiceId | String | True |
Invoices.InvoiceId |
Invoice Id for credit note. | |
InvoicesCredited | String | True |
InvoicesCredited | ||
InvoiceNumber | String | True |
Invoice number for credit note. | ||
IsDiscountBeforeTax | Boolean | True |
Check if the discount is applied before tax in credit note. | ||
IsDraft | Boolean | False |
Set to true if credit note has to be created in draft status. | ||
IsEmailed | Boolean | False |
Check if the credit note is emailed. | ||
IsEwayBillRequired | Boolean | True |
Check if eway bill is required for credit note. | ||
IsInclusiveTax | Boolean | False |
Check if the credit note is inclusive tax. | ||
IsPreGst | Boolean | True |
Check if pre GST is applied. | ||
IsTaxable | Boolean | True |
Check if this credit note is taxable. | ||
LastModifiedById | String | True |
Users.UserId |
Id of the user last modified. | |
LastModifiedTime | Datetime | True |
The time of last modification of the credit note. | ||
LineItems | String | False |
Line items of an estimate. | ||
Notes | String | False |
Notes for this credit note. | ||
Orientation | String | True |
Orientation of a page. | ||
PageHeight | String | True |
Height of a page. | ||
PageWidth | String | True |
Width of a page. | ||
PlaceOfSupply | String | False |
The place of supply is where a transaction is considered to have occurred for VAT purposes. | ||
PricePrecision | Integer | True |
The precision for the price. | ||
ReasonForCreditnote | String | True |
Any specific reason for taking credit note. | ||
ReferenceNumber | String | False |
Reference number of credit note. | ||
ReverseChargeTaxTotal | Decimal | True |
Total amount to pay the liability of tax. | ||
RoundoffValue | Decimal | True |
Rounding off the values to precise number. | ||
SalespersonId | String | False |
Id of a sales person. | ||
SalespersonName | String | True |
Name of a sales person. | ||
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. | ||
ShippingCharge | Decimal | True |
Shipping charge of credit note. | ||
Status | String | True |
Status of the credit note. | ||
SubTotal | Decimal | True |
Sub total of credit notes. | ||
SubTotalInclusiveOfTax | Decimal | True |
Subtotal amount which are inclusive of tax. | ||
SubmittedBy | String | True |
Detail of the user who has submitted the credit note. | ||
SubmittedDate | Date | True |
Date when credit note was submitted. | ||
SubmitterId | String | True |
Users.UserId |
Id of a submitter of credit note. | |
TaxSpecification | String | True |
Working of tax when specifying special tax options and tax methods for earnings codes. | ||
TaxTotal | Decimal | True |
Total amount of Tax. | ||
Taxes | String | True |
Taxes associated with the subscription. | ||
TDSCalculationType | String | True |
TDSCalculationType | ||
TDSSummary | String | True |
TDSSummary | ||
TaxTreatment | String | False |
VAT treatment for the Credit Note. | ||
TemplateId | String | False |
Id of a template. | ||
TemplateName | String | True |
Name of a tempalte. | ||
TemplateType | String | True |
Type of a template. | ||
Terms | String | False |
Terms and Conditions apply of a credit note. | ||
Total | Decimal | True |
Total of credit notes. | ||
TotalCreditsUsed | Decimal | True |
Total credits used for credit note. | ||
TotalRefundedAmount | Decimal | True |
Total amount refunded for a credit note. | ||
TransactionRoundingType | String | True |
Type of round off used for transaction. | ||
VatTreatment | String | False |
VAT treatment for the credit note. | ||
IgnoreAutoNumberGeneration | Boolean | False |
Set to true if you need to provide your own credit note number. |