CreditNotePreviewLineItems
Returns a preview of the line items that would appear on a credit note before it is created, including amounts, discounts, and tax details.
View-Specific Information
SELECT
The component uses the Stripe API to filter the results by the following columns and operators:
| Column | Supported Operators |
| InvoiceId | = |
| AccountId | = |
You can select from CreditNotePreviewLineItems with the following queries:
SELECT * FROM CreditNotePreviewLineItems WHERE InvoiceId = 'in_1PDhVw2eZvKYlo2C6J4CKKUd'
SELECT * FROM CreditNotePreviewLineItems WHERE AccountId = 'acct_1Gqj58Ly0qyl5A'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the credit note preview line item. | |
| InvoiceId | String |
Invoices.Id | The Id of the invoice. |
| Amount | Integer | The integer amount in cents representing the total amount of the credit note. | |
| CreditAmount | Integer | The integer amount in cents representing the amount to credit the customer's balance, which is automatically applied to their next invoice. | |
| AmountShipping | Integer | The sum of all the shipping amounts. | |
| Created | Datetime | The time at which the object was created. Measured in seconds since the Unix epoch. | |
| Currency | String | The three-letter ISO currency code, in lowercase. | |
| Customer | String |
Customers.Id | The Id of the customer. |
| CustomerBalanceTransaction | String | The customer balance transaction related to this credit note. | |
| DiscountAmounts | String | The aggregate amounts calculated per discount for all line items. | |
| EffectiveAt | Datetime | The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated Date of issue printed on the credit note PDF. | |
| Lines | String | The line items that make up the credit note. | |
| Livemode | Boolean | Indicates whether the object exists in live mode. Returns true if the object exists in live mode and false if the object exists in test mode. | |
| Memo | String | The credit note's memo appears on the credit note PDF. | |
| Metadata | String | The set of key-value pairs that you can attach to the credit note object. | |
| Number | String | The unique number that identifies this credit note. | |
| OutOfBandAmount | Integer | The integer amount in cents representing the amount that is credited outside of Stripe. | |
| String | The URL to download the PDF of the credit note. | ||
| Reason | String | The reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory. | |
| Refund | String | The Id of an existing refund to link this credit note to. | |
| RefundAmount | Integer | The integer amount in cents representing the amount to refund. If set, a refund is created for the charge associated with the invoice. | |
| ShippingCost | String | The cost of shipping included in the credit note when shipping_cost contains the shipping_rate from the invoice. | |
| Status | String | The status of this credit note, one of issued or void. | |
| Subtotal | Integer | The integer amount in cents representing the amount of the credit note, excluding exclusive tax and invoice level discounts. | |
| SubtotalExcludingTax | Integer | The integer amount in cents representing the amount of the credit note, excluding all tax and invoice level discounts. | |
| TaxAmounts | String | The aggregate amounts calculated per tax rate for all line items. | |
| Total | Integer | The integer amount in cents representing the total amount of the credit note, including tax and all discounts. | |
| TotalExcludingTax | Integer | The integer amount in cents representing the total amount of the credit note, excluding tax but including discounts. | |
| Type | String | The type of this credit note, either pre_payment or post_payment. | |
| VoidedAt | Datetime | The time at which the credit note was voided. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AccountId | String | The Id of the connected account to get credit note preview line items for. |