Please enable JavaScript to view this site.

Chargebee API Data Model

Navigation: Schema: Invoices > Tables

Invoices: Chargebee Invoices

Contents Previous Home Next More

Catalog: Chargebee

Schema: Invoices

Primary Keys: id

Label: Invoices

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

Select Chargebee API URL: /invoices

Insert Chargebee API URL: /invoices

Update Chargebee API URL: /invoices

Delete Chargebee API URL: /invoices

Field Selection Method: NotRequired

Base Path: list[*].invoice

Table Columns

The columns of the table Invoices 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 or update.

Name

Data Type

Label

Required

Documentation

amount_adjusted

decimal

Amount Adjusted

☐

 

amount_due

decimal

Amount Due

☐

 

amount_paid

decimal

Amount Paid

☐

 

amount_to_collect

decimal

Amount to Collect

☐

 

base_currency_code

string

Base Currency Code

☐

 

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

 

☐

 

credits_applied

decimal

Credits Applied

☐

 

currency_code

string

Currency Code

☐

 

customer_id

string

Customer ID

☐

 

date

datetime

Date

☐

 

deleted

boolean

Deleted

☐

 

due_date

datetime

Due Date

☐

 

dunning_status

string

Dunning Status

☐

 

exchange_rate

decimal

Exchange Rate

☐

 

expected_payment_date

datetime

Expected Payment Date

☐

 

first_invoice

boolean

First Invoice

☐

 

has_advance_charges

boolean

Has Advance Charges

☐

 

id

string

ID

☑

 

is_gifted

boolean

Is Gifted

☐

 

local_currency_code

string

Local Currency Code

☐

 

net_term_days

int32

Net Term Days

☐

 

new_sales_amount

decimal

New Sales Amount

☐

 

next_retry_at

datetime

Next Retry at

☐

 

paid_at

datetime

Paid at

☐

 

payment_owner

string

Payment Owner

☐

 

po_number

string

PO Number

☐

 

price_type

string

Price Type

☐

 

recurring

boolean

Recurring

☐

 

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

☐

 

status

string

Status

☐

 

sub_total

decimal

Sub-total

☐

 

sub_total_in_local_currency

decimal

Sub Total in Local Currency

☐

 

subscription_id

string

Subscription ID

☐

 

tax

decimal

Tax

☐

 

term_finalized

boolean

Term Finalized

☐

 

total

decimal

Total

☐

 

total_in_local_currency

decimal

Total in Local Currency

☐

 

updated_at

datetime

Updated at

☐

 

vat_number

string

VAT Number

☐

 

void_reason_code

string

Void Reason Code

☐

 

voided_at

datetime

Voided at

☐

 

write_off_amount

decimal

Write Off Amount

☐

 

 

12-12-2020 18:45 Version 20.1.301-BETA+3023