Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

Credit Notes

The available fields in the 'Credit Notes' data source and their corresponding descriptions are listed below.

FieldDescription
Voided OnTimestamp indicating the date and time the credit note got voided.
Credit Note IDDisplays the unique identifier of the credit note.
Amount RefundedDisplays the refunds issued from the Credit Note.
Round Off AmountDisplays the rounded-off amount.
Amount AllocatedDisplays the total credits allocated to invoices.
VAT NumberDisplays the VAT number of the customer for whom this Credit Note is raised.
Price TypeDisplays the price type of the Credit Note.
Reason CodeDisplays the reason for issuing this Credit Note. The following reason codes are supported now. Possible values are write_off, subscription_change, subscription_cancellation, subscription_pause, chargeback, product_unsatisfactory, service_unsatisfactory, order_change, order_cancellation, waiver, other, fraudulent.
Available CreditsDisplays the credits that are yet to be used from the credit note.
Credit Note StatusDisplays the status of the credit note. Possible values are adjusted, refunded, refund_due, voided.
Sub TotalDisplays the sub total of the credit note.
Created OnDisplays the date when the Credit Note was issued.
TypeDisplays the type of the credit note. Possible options are Adjustment and Refundable.
Refunded OnDisplays the time when credits were completely used or refunded.
TotalCredit Note amount in dollars.
Total(Transaction Currency)Credit Note amount in the transaction currency.
CurrencyThe currency code (ISO 4217 format) for the credit note.

Was this article helpful?