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 set it off against other 'due' invoices.

Chargebee supports two types of Credit Notes - Adjustment Credit Note and Refundable Credit Note.

  • 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 you have enabled consolidated invoicing, to know the subscriptions attached with a credit note you have to refer line_item's subscription_id. The credit note's subscription_id should not be used (which 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
Credit-note id.
subscription_id string, null
Foreign Key subscriptions.id
The identifier of the subscription this Credit Note belongs to.
Note: If consolidated invoicing is enabled, to know the subscriptions attached with this Credit Note you have to refer line_item's subscription_id. This attribute should not be used (which will be null if this credit note has lines from multiple subscriptions).
customer_id string, not null
Foreign Key customers.id
The identifier of the customer this Credit Note belongs to.
business_entity_id string, null
Foreign Key business_entities.id
The unique ID of the business entity of this credit_note. This is always the same as the business entity of the invoice referred to by reference_invoice_id.
amount_allocated long, null, default=0
The amount allocated to the invoices.
amount_available long, null, default=0
The yet to be used credits of this Credit Note.
amount_refunded long, null, default=0
The refunds issued from this Credit Note.
billing_address_city string, null
The name of the city.
billing_address_company string, null
The company name.
billing_address_country string, null
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

Note: If you enter an invalid country code, the system will return an error.

billing_address_email string, null
The email 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
Address line 1
billing_address_line2 string, null
Address line 2
billing_address_line3 string, null
Address line 3
billing_address_phone string, null
The phone number.
billing_address_state string, null
State or Province
billing_address_state_code string, null
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, 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.
billing_address_zip string, null
Zip or postal code. The number of characters is validated according to the rules specified here.
channel string, null
The subscription channel this object originated from and is maintained in.
create_reason_code string, null
Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Credit Notes > Create Credit Note. Must be passed if set as mandatory in the app. The codes are case-sensitive
currency_code string, not null
The currency code (ISO 4217 format) for the credit note
date timestamp, null
The date the Credit Note is issued.
einvoice_id string, null
The unique id for the e-invoice. This is auto-generated by Chargebee.
einvoice_message string, null
Detailed information about the status of the e-invoice. When status is skipped or failed, this contains the reason or error details. The following are some valid examples:
  • Invoice successfully sent to customer via the e-invoicing network 9090:123456
  • Invoice successfully sent to customer via email id abc@acme.com
einvoice_reference_number string, null
This attribute is used to populate the unique reference number assigned to an invoice on the Invoice Registration Portal (IRP) network. It is essential for identifying and tracking invoices that are processed through the IRP network. In the future, this field may be used to store similar reference numbers for other networks.
einvoice_status string, null
The status of processing the e-invoice. To obtain detailed information about the current status, see message.
fractional_correction long, null
Indicates the fractional correction amount.
generated_at timestamp, null
The date/time when the credit note was raised. This date/time can be backdated, which means that the date/time can be earlier than the date/time the credit note was created.
local_currency_code string, null
The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed.
local_currency_exchange_rate decimal, null
This parameter represents the exchange rate as a relative price of the base currency that appears as local currency in invoices and credit notes. The local currency exchange rate specifically refers to the exchange rate of a country's currency when converting it to another currency. For example, if you want to convert US dollars to euros, the local currency exchange rate would be the rate at which you can convert US dollars 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. The following reason codes are supported now[Deprecated; use the create_reason_code parameter instead]
reference_invoice_id string, null
The identifier of the invoice against which this Credit Note is issued
refunded_at timestamp, null
The time this Credit Note gets fully used. Please note that this field is not present when partial refunds are issued.
resource_version long, null
Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
round_off_amount long, null
Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the round_off_amount. If there is no round-off amount, it will display 0.
shipping_address_city string, null
The name of the city.
shipping_address_company string, null
The company name.
shipping_address_country string, null
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

Note: If you enter an invalid country code, the system will return an error.

shipping_address_email string, null
The email address.
shipping_address_first_name string, null
The first name of the contact.
shipping_address_index null
The index number of the subscription/one-time group to which the item price is added. Provide a unique number between 0 and 9 (inclusive) for each group that is to be created. To increase this limit, contact Chargebee Support
shipping_address_last_name string, null
The last name of the contact.
shipping_address_line1 string, null
Address line 1
shipping_address_line2 string, null
Address line 2
shipping_address_line3 string, null
Address line 3
shipping_address_phone string, null
The phone number.
shipping_address_state string, null
The state/province name.
shipping_address_state_code string, null
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, 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
Zip or postal code. The number of characters is 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 credit note status.
sub_total long, not null
The Credit Note sub-total
sub_total_in_local_currency long, null
Invoice subtotal in the currency of the place of supply.
tax_category string, null
Specifies the customer's category for the Goods and Services Tax (GST). This field is returned only if you've configured GST for the India region.
tax_origin_country string, null
tax_origin_registration_number string, null
total long, null, default=0
Credit Note amount in cents.
total_in_local_currency long, null
Total invoice amount in the currency of the place of supply.
type string, not null
The credit note type.
updated_at timestamp, null
Timestamp indicating when this Credit Note was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.
vat_number string, null
VAT number of the customer for whom this Credit Note is raised.
vat_number_prefix string, null
An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with billing_address country as XI (which is United Kingdom - Northern Ireland).

When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting billing_address country as XI. That’s the code for United Kingdom - Northern Ireland. The first two characters of the VAT number in such a case is XI by default. However, if the VAT number was registered in UK, the value should be GB. Set vat_number_prefix to GB for such cases.
voided_at timestamp, null
Timestamp indicating the date and time this Credit Note gets voided.