1. Invoicing
  2. Credit notes

Credit notes

credit_notes
copy
Click to Copy
A Credit Note is a document that specifies the money owed by a business to its customer. The seller usually issues a Credit Note for the same or lower amount than the invoice and then repays the money to the customer or offsets it against other 'due' invoices. Chargebee supports [three types of Credit Notes](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/credit-notes#types-of-credit-notes): - Adjustment Credit Notes: Created for the 'unpaid' component of the invoice. Statuses include Adjusted and Voided. - Refundable Credit Notes: Created for the 'paid' component of the invoice. Statuses include Refunded, Refund Due, and Voided. - Promotional Credit Notes: To provide a discount for marketing or promotional reasons.
  • Adjustment Credit Notes are created for the 'unpaid' component of the invoice and it can have statuses - Adjusted and Voided.
  • Refundable Credit Notes are created for 'paid' component of the invoice and it can have statuses - Refunded, Refund Due and Voided.

The credits available in the Refundable Credit Notes will be automatically applied when a new invoice gets generated for the customer.

**Note:** If consolidated invoicing is enabled, refer to the `line_item.subscription_id` to know the subscriptions attached to a credit note. The `credit_note.subscription_id` should not be used (it will be `null` if the credit note has lines from multiple subscriptions).

Related Tables

Tables referencing credit_notes.id
credit_note_line_item_taxes credit_note_line_item_discounts credit_note_allocations credit_note_discounts credit_note_linked_tax_withheld_refunds credit_note_line_items credit_note_line_item_tiers credit_note_linked_refunds

Columns

No match found
id string, not null
Primary Key
The unique identifier of the credit note.
subscription_id string, null
Foreign Key subscriptions.id
The identifier of the subscription associated with this credit note. If consolidated invoicing is enabled, refer to `line_item.subscription_id` instead of this field.
customer_id string, not null
Foreign Key customers.id
The identifier of the customer associated with this credit note.
business_entity_id string, null
Foreign Key business_entities.id
The unique ID of the business entity associated with this credit note. This is the same as the business entity of the associated invoice.
amount_allocated long, null, default=0
The amount allocated to invoices from this credit note.
amount_available long, null, default=0
The unused credits available in this credit note.
amount_refunded long, null, default=0
The total amount refunded from this credit note.
billing_address_city string, null
The city name in the billing address.
billing_address_company string, null
The company name in the billing address.
billing_address_country string, null
The country name in the billing address. Must be a valid ISO 3166 alpha-2 country code.
billing_address_email string, null
The email address in the billing address.
billing_address_first_name string, null
The first name of the billing contact.
billing_address_last_name string, null
The last name of the billing contact.
billing_address_line1 string, null
The first line of the billing address.
billing_address_line2 string, null
The second line of the billing address.
billing_address_line3 string, null
The third line of the billing address.
billing_address_phone string, null
The phone number in the billing address.
billing_address_state string, null
The state or province name in the billing address.
billing_address_state_code string, null
The ISO 3166-2 state/province code without the country prefix. Supported for USA, Canada, and India. For example, for Arizona (USA), set `state_code` as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC`).
billing_address_validation_status string, null, default=not_validated
The address verification status for the billing address.
billing_address_zip string, null
The zip or postal code of the billing address. Validated according to the rules specified here.
channel string, null
The subscription channel from which this credit note originated.
create_reason_code string, null
The reason code for creating the credit note. Must match one of the predefined reason codes in Chargebee's settings.
currency_code string, not null
The currency code (ISO 4217 format) for the credit note.
date timestamp, null
The date the credit note was issued.
einvoice_id string, null
The unique identifier of the e-invoice associated with this credit note.
einvoice_message string, null
Detailed information about the status of the e-invoice. For example: - Invoice successfully sent to the customer via the e-invoicing network. - Invoice successfully sent to the customer via email.
einvoice_reference_number string, null
The unique reference number assigned to the credit note on the Invoice Registration Portal (IRP) network.
einvoice_status string, null
The status of the e-invoice associated with this credit note.
fractional_correction long, null
The fractional correction amount applied to the credit note.
generated_at timestamp, null
The timestamp when the credit note was generated.
local_currency_code string, null
The currency code (ISO 4217 format) of the local currency used in the credit note.
local_currency_exchange_rate decimal, null
The exchange rate used to convert the base currency to the local currency in invoices and credit notes. For example, if converting US dollars to euros, this represents the rate at which US dollars are converted to euros.
price_type string, not null, default=tax_exclusive
The price type of the credit note.
reason_code string, null
The reason for issuing this credit note. [Deprecated; use the `create_reason_code` instead.]
reference_invoice_id string, null
The identifier of the invoice associated with this credit note.
refunded_at timestamp, null
The timestamp when this credit note was fully refunded.
resource_version long, null
The version number of this table. Updated with a new timestamp in milliseconds for every change made to the table.
round_off_amount long, null
The rounded-off amount. For example, if the credit note amount is $99.99 and it is rounded to $100.00, the `round_off_amount` is $0.01.
shipping_address_city string, null
The city name in the shipping address.
shipping_address_company string, null
The company name in the shipping address.
shipping_address_country string, null
The country name in the shipping address. Must be a valid ISO 3166 alpha-2 country code.
shipping_address_email string, null
The email address associated with the shipping address.
shipping_address_first_name string, null
The first name of the contact associated with the shipping address.
shipping_address_index null
The index number of the subscription or one-time group associated with the credit note. Provide a unique number between `0` and `9` for each group.
shipping_address_last_name string, null
The last name of the contact associated with the shipping address.
shipping_address_line1 string, null
The first line of the shipping address.
shipping_address_line2 string, null
The second line of the shipping address.
shipping_address_line3 string, null
The third line of the shipping address.
shipping_address_phone string, null
The phone number associated with the shipping address.
shipping_address_state string, null
The state or province name in the shipping address.
shipping_address_state_code string, null
The ISO 3166-2 state/province code without the country prefix. Supported for USA, Canada, and India. For example, for Arizona (USA), set `state_code` as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC`).
shipping_address_validation_status string, null, default=not_validated
The address verification status.
shipping_address_zip string, null
The zip or postal code of the shipping address. Validated according to the rules specified here.
site_details_at_creation_organization_address string, null
site_details_at_creation_timezone string, null
status string, not null
The status of the credit note.
sub_total long, not null
The subtotal of the credit note.
sub_total_in_local_currency long, null
The subtotal of the credit note in the local currency.
tax_category string, null
Specifies the customer's tax category for Goods and Services Tax (GST).
tax_origin_country string, null
The country code in (ISO 3166-1 alpha-2 format) where the tax originated from.
tax_origin_registration_number string, null
The tax registration number of the seller or business entity responsible for collecting and remitting taxes for this transaction. This differs from other tax-related attributes such as `tax_origin_country`, which specifies the country where the tax originated, and `tax_category`, which specifies the customer's tax category.
total long, null, default=0
The total amount of the credit note in cents.
total_in_local_currency long, null
The total credit note amount in the local currency.
type string, not null
The type of the credit note.
updated_at timestamp, null
The timestamp when the credit note was last updated.
vat_number string, null
The VAT number of the customer for whom this credit note is issued.
vat_number_prefix string, null
The overridden value for the first two characters of the VAT number. Applicable for customers with `billing_address.country` as `XI` (United Kingdom - Northern Ireland). By default, the prefix is `XI`. If the VAT number was registered in the UK, set `vat_number_prefix` to `GB`.
voided_at timestamp, null
The timestamp when the credit note was voided.
record_extracted_at timestamp
The column represents the timestamp when the updated data became available in Chargebee's data lakehouse.
record_exported_at timestamp
The column represents the timestamp when the data was exported to the configured destination.
change_type string
The column indicates the type of change [create, update, delete, read] and can be used to load data into the warehouse accordingly.