Please enable JavaScript to view this site.

Chargebee Forums

Chargebee API Data Model

Navigation: Schema: CreditNotes > Tables

CreditNotes: Chargebee Credit Notes

Catalog: Chargebee

Schema: CreditNotes

Primary Keys: id

Label: Credit Notes

Can retrieve data and change data using insert, update and delete.

Table Columns

The columns of the table CreditNotes are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name

Data Type

Label

Required

Documentation

amount_allocated

decimal

Amount Allocated

☐

 

amount_available

decimal

Amount Available

☐

 

amount_refunded

decimal

Amount Refunded

☐

 

billing_address_city

string

Billing Address City

☐

 

billing_address_company

string

Billing Address Company

☐

 

billing_address_country

string

Billing Address Country

☐

 

billing_address_email

string

Billing Address Email

☐

 

billing_address_first_name

string

Billing Address First Name

☐

 

billing_address_last_name

string

Billing Address Last Name

☐

 

billing_address_line1

string

Billing Address Line 1

☐

 

billing_address_line2

string

Billing Address Line 2

☐

 

billing_address_line3

string

Billing Address Line 3

☐

 

billing_address_phone

string

Billing Address Phone

☐

 

billing_address_state

string

Billing Address State

☐

 

billing_address_validation_status

string

Billing Address Validation Status

☐

 

billing_address_zip

string

 

☐

 

business_entity_id

string

 

☐

 

channel

string

 

☐

 

create_reason_code

string

Create Reason Code

☐

 

currency_code

string

Currency Code

☐

 

customer_id

string

Customer ID

☐

 

date

datetime

Date

☐

 

deleted

boolean

Deleted

☐

 

einvoice_id

string

 

☐

 

einvoice_message

string

 

☐

 

einvoice_reference_number

string

 

☐

 

einvoice_status

string

 

☐

 

fractional_correction

decimal

Fractional Correction

☐

 

generated_at

datetime

 

☐

 

id

string

ID

☑

 

local_currency_code

string

Local Currency Code

☐

 

local_currency_exchange_rate

decimal

 

☐

 

price_type

string

Price Type

☐

 

reason_code

string

 

☐

 

reference_invoice_id

string

Reference Invoice ID

☐

 

refunded_at

datetime

Refunded at

☐

 

resource_version

int64

Resource Version

☐

 

round_off_amount

decimal

Round-off Amount

☐

 

shipping_address_city

string

Shipping Address City

☐

 

shipping_address_company

string

Shipping Address Company

☐

 

shipping_address_country

string

Shipping Address Country

☐

 

shipping_address_email

string

Shipping Address Email

☐

 

shipping_address_first_name

string

Shipping Address First Name

☐

 

shipping_address_last_name

string

Shipping Address Last Name

☐

 

shipping_address_line1

string

Shipping Address Line 1

☐

 

shipping_address_line2

string

Shipping Address Line 2

☐

 

shipping_address_phone

string

Shipping Address Phone

☐

 

shipping_address_state

string

Shipping Address State

☐

 

shipping_address_validation_status

string

Shipping Address Validation Status

☐

 

shipping_address_zip

string

Shipping Address ZIP Code

☐

 

site_details_at_creation_organization_address

string

 

☐

 

site_details_at_creation_timezone

string

 

☐

 

status

string

Status

☐

 

sub_total_in_local_currency

decimal

Sub Total in Local Currency

☐

 

sub_total

decimal

Sub-total

☐

 

subscription_id

string

Subscription ID

☐

 

tax_category

string

 

☐

 

total_in_local_currency

decimal

Total in Local Currency

☐

 

total

decimal

Total

☐

 

type

string

Type

☐

 

updated_at

datetime

Updated at

☐

 

vat_number_prefix

string

 

☐

 

vat_number

string

VAT Number

☐

 

voided_at

datetime

Voided at

☐

 

 

10-06-2024 18:44 Version 24.1.3-BETA+4689

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer