Class: ChargeBee::Invoice

Inherits:
Model
  • Object
show all
Defined in:
lib/chargebee/models/invoice.rb

Defined Under Namespace

Classes: AdjustmentCreditNote, AppliedCredit, BillingAddress, Discount, DunningAttempt, Einvoice, IssuedCreditNote, LineItem, LineItemDiscount, LineItemTax, LineItemTier, LinkedOrder, LinkedPayment, Note, ShippingAddress, SiteDetailsAtCreation, StatementDescriptor, Tax, TaxOrigin

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Model

construct, #init_dependant, #init_dependant_list, #initialize, #inspect, #load, #method_missing, #replace_white_space_with_underscore, #to_s, uri_path

Constructor Details

This class inherits a constructor from ChargeBee::Model

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ChargeBee::Model

Instance Attribute Details

#adjustment_credit_notesObject

Returns the value of attribute adjustment_credit_notes.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def adjustment_credit_notes
  @adjustment_credit_notes
end

#amount_adjustedObject

Returns the value of attribute amount_adjusted.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def amount_adjusted
  @amount_adjusted
end

#amount_dueObject

Returns the value of attribute amount_due.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def amount_due
  @amount_due
end

#amount_paidObject

Returns the value of attribute amount_paid.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def amount_paid
  @amount_paid
end

#amount_to_collectObject

Returns the value of attribute amount_to_collect.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def amount_to_collect
  @amount_to_collect
end

#applied_creditsObject

Returns the value of attribute applied_credits.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def applied_credits
  @applied_credits
end

#billing_addressObject

Returns the value of attribute billing_address.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def billing_address
  @billing_address
end

#business_entity_idObject

Returns the value of attribute business_entity_id.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def business_entity_id
  @business_entity_id
end

#channelObject

Returns the value of attribute channel.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def channel
  @channel
end

#credits_appliedObject

Returns the value of attribute credits_applied.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def credits_applied
  @credits_applied
end

#currency_codeObject

Returns the value of attribute currency_code.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def currency_code
  @currency_code
end

#customer_idObject

Returns the value of attribute customer_id.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def customer_id
  @customer_id
end

#dateObject

Returns the value of attribute date.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def date
  @date
end

#deletedObject

Returns the value of attribute deleted.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def deleted
  @deleted
end

#discountsObject

Returns the value of attribute discounts.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def discounts
  @discounts
end

#due_dateObject

Returns the value of attribute due_date.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def due_date
  @due_date
end

#dunning_attemptsObject

Returns the value of attribute dunning_attempts.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def dunning_attempts
  @dunning_attempts
end

#dunning_statusObject

Returns the value of attribute dunning_status.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def dunning_status
  @dunning_status
end

#einvoiceObject

Returns the value of attribute einvoice.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def einvoice
  @einvoice
end

#exchange_rateObject

Returns the value of attribute exchange_rate.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def exchange_rate
  @exchange_rate
end

#expected_payment_dateObject

Returns the value of attribute expected_payment_date.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def expected_payment_date
  @expected_payment_date
end

#first_invoiceObject

Returns the value of attribute first_invoice.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def first_invoice
  @first_invoice
end

#generated_atObject

Returns the value of attribute generated_at.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def generated_at
  @generated_at
end

#has_advance_chargesObject

Returns the value of attribute has_advance_charges.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def has_advance_charges
  @has_advance_charges
end

#idObject

Returns the value of attribute id.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def id
  @id
end

#is_giftedObject

Returns the value of attribute is_gifted.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def is_gifted
  @is_gifted
end

#issued_credit_notesObject

Returns the value of attribute issued_credit_notes.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def issued_credit_notes
  @issued_credit_notes
end

#line_item_discountsObject

Returns the value of attribute line_item_discounts.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def line_item_discounts
  @line_item_discounts
end

#line_item_taxesObject

Returns the value of attribute line_item_taxes.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def line_item_taxes
  @line_item_taxes
end

#line_item_tiersObject

Returns the value of attribute line_item_tiers.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def line_item_tiers
  @line_item_tiers
end

#line_itemsObject

Returns the value of attribute line_items.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def line_items
  @line_items
end

#linked_ordersObject

Returns the value of attribute linked_orders.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def linked_orders
  @linked_orders
end

#linked_paymentsObject

Returns the value of attribute linked_payments.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def linked_payments
  @linked_payments
end

#local_currency_codeObject

Returns the value of attribute local_currency_code.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def local_currency_code
  @local_currency_code
end

#local_currency_exchange_rateObject

Returns the value of attribute local_currency_exchange_rate.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def local_currency_exchange_rate
  @local_currency_exchange_rate
end

#net_term_daysObject

Returns the value of attribute net_term_days.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def net_term_days
  @net_term_days
end

#new_sales_amountObject

Returns the value of attribute new_sales_amount.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def new_sales_amount
  @new_sales_amount
end

#next_retry_atObject

Returns the value of attribute next_retry_at.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def next_retry_at
  @next_retry_at
end

#notesObject

Returns the value of attribute notes.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def notes
  @notes
end

Returns the value of attribute paid_at.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def paid_at
  @paid_at
end

#payment_ownerObject

Returns the value of attribute payment_owner.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def payment_owner
  @payment_owner
end

#po_numberObject

Returns the value of attribute po_number.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def po_number
  @po_number
end

#price_typeObject

Returns the value of attribute price_type.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def price_type
  @price_type
end

#recurringObject

Returns the value of attribute recurring.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def recurring
  @recurring
end

#resource_versionObject

Returns the value of attribute resource_version.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def resource_version
  @resource_version
end

#round_off_amountObject

Returns the value of attribute round_off_amount.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def round_off_amount
  @round_off_amount
end

#shipping_addressObject

Returns the value of attribute shipping_address.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def shipping_address
  @shipping_address
end

#site_details_at_creationObject

Returns the value of attribute site_details_at_creation.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def site_details_at_creation
  @site_details_at_creation
end

#statement_descriptorObject

Returns the value of attribute statement_descriptor.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def statement_descriptor
  @statement_descriptor
end

#statusObject

Returns the value of attribute status.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def status
  @status
end

#sub_totalObject

Returns the value of attribute sub_total.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def sub_total
  @sub_total
end

#sub_total_in_local_currencyObject

Returns the value of attribute sub_total_in_local_currency.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def sub_total_in_local_currency
  @sub_total_in_local_currency
end

#subscription_idObject

Returns the value of attribute subscription_id.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def subscription_id
  @subscription_id
end

#taxObject

Returns the value of attribute tax.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def tax
  @tax
end

#tax_categoryObject

Returns the value of attribute tax_category.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def tax_category
  @tax_category
end

#tax_originObject

Returns the value of attribute tax_origin.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def tax_origin
  @tax_origin
end

#taxesObject

Returns the value of attribute taxes.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def taxes
  @taxes
end

#term_finalizedObject

Returns the value of attribute term_finalized.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def term_finalized
  @term_finalized
end

#totalObject

Returns the value of attribute total.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def total
  @total
end

#total_in_local_currencyObject

Returns the value of attribute total_in_local_currency.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def total_in_local_currency
  @total_in_local_currency
end

#updated_atObject

Returns the value of attribute updated_at.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def updated_at
  @updated_at
end

#vat_numberObject

Returns the value of attribute vat_number.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def vat_number
  @vat_number
end

#vat_number_prefixObject

Returns the value of attribute vat_number_prefix.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def vat_number_prefix
  @vat_number_prefix
end

#void_reason_codeObject

Returns the value of attribute void_reason_code.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def void_reason_code
  @void_reason_code
end

#voided_atObject

Returns the value of attribute voided_at.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def voided_at
  @voided_at
end

#write_off_amountObject

Returns the value of attribute write_off_amount.



80
81
82
# File 'lib/chargebee/models/invoice.rb', line 80

def write_off_amount
  @write_off_amount
end

Class Method Details

.add_addon_charge(id, params, env = nil, headers = {}) ⇒ Object



171
172
173
# File 'lib/chargebee/models/invoice.rb', line 171

def self.add_addon_charge(id, params, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"add_addon_charge"), params, env, headers)
end

.add_charge(id, params, env = nil, headers = {}) ⇒ Object



167
168
169
# File 'lib/chargebee/models/invoice.rb', line 167

def self.add_charge(id, params, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"add_charge"), params, env, headers)
end

.add_charge_item(id, params, env = nil, headers = {}) ⇒ Object



175
176
177
# File 'lib/chargebee/models/invoice.rb', line 175

def self.add_charge_item(id, params, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"add_charge_item"), params, env, headers)
end

.apply_credits(id, params = {}, env = nil, headers = {}) ⇒ Object



135
136
137
# File 'lib/chargebee/models/invoice.rb', line 135

def self.apply_credits(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"apply_credits"), params, env, headers)
end

.apply_payment_schedule_scheme(id, params, env = nil, headers = {}) ⇒ Object



231
232
233
# File 'lib/chargebee/models/invoice.rb', line 231

def self.apply_payment_schedule_scheme(id, params, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"apply_payment_schedule_scheme"), params, env, headers)
end

.apply_payments(id, params = {}, env = nil, headers = {}) ⇒ Object



123
124
125
# File 'lib/chargebee/models/invoice.rb', line 123

def self.apply_payments(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"apply_payments"), params, env, headers)
end

.charge(params, env = nil, headers = {}) ⇒ Object



103
104
105
# File 'lib/chargebee/models/invoice.rb', line 103

def self.charge(params, env=nil, headers={})
  Request.send('post', uri_path("invoices","charge"), params, env, headers)
end

.charge_addon(params, env = nil, headers = {}) ⇒ Object



107
108
109
# File 'lib/chargebee/models/invoice.rb', line 107

def self.charge_addon(params, env=nil, headers={})
  Request.send('post', uri_path("invoices","charge_addon"), params, env, headers)
end

.close(id, params = {}, env = nil, headers = {}) ⇒ Object



179
180
181
# File 'lib/chargebee/models/invoice.rb', line 179

def self.close(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"close"), params, env, headers)
end

.collect_payment(id, params = {}, env = nil, headers = {}) ⇒ Object



183
184
185
# File 'lib/chargebee/models/invoice.rb', line 183

def self.collect_payment(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"collect_payment"), params, env, headers)
end

.create(params = {}, env = nil, headers = {}) ⇒ Object

OPERATIONS




95
96
97
# File 'lib/chargebee/models/invoice.rb', line 95

def self.create(params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices"), params, env, headers)
end

.create_for_charge_item(params, env = nil, headers = {}) ⇒ Object



111
112
113
# File 'lib/chargebee/models/invoice.rb', line 111

def self.create_for_charge_item(params, env=nil, headers={})
  Request.send('post', uri_path("invoices","create_for_charge_item"), params, env, headers)
end

.create_for_charge_items_and_charges(params, env = nil, headers = {}) ⇒ Object



99
100
101
# File 'lib/chargebee/models/invoice.rb', line 99

def self.create_for_charge_items_and_charges(params, env=nil, headers={})
  Request.send('post', uri_path("invoices","create_for_charge_items_and_charges"), params, env, headers)
end

.delete(id, params = {}, env = nil, headers = {}) ⇒ Object



223
224
225
# File 'lib/chargebee/models/invoice.rb', line 223

def self.delete(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"delete"), params, env, headers)
end

.delete_line_items(id, params = {}, env = nil, headers = {}) ⇒ Object



131
132
133
# File 'lib/chargebee/models/invoice.rb', line 131

def self.delete_line_items(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"delete_line_items"), params, env, headers)
end

.download_einvoice(id, env = nil, headers = {}) ⇒ Object



159
160
161
# File 'lib/chargebee/models/invoice.rb', line 159

def self.download_einvoice(id, env=nil, headers={})
  Request.send('get', uri_path("invoices",id.to_s,"download_einvoice"), {}, env, headers)
end

.import_invoice(params, env = nil, headers = {}) ⇒ Object



119
120
121
# File 'lib/chargebee/models/invoice.rb', line 119

def self.import_invoice(params, env=nil, headers={})
  Request.send('post', uri_path("invoices","import_invoice"), params, env, headers)
end

.invoices_for_customer(id, params = {}, env = nil, headers = {}) ⇒ Object



143
144
145
# File 'lib/chargebee/models/invoice.rb', line 143

def self.invoices_for_customer(id, params={}, env=nil, headers={})
  Request.send('get', uri_path("customers",id.to_s,"invoices"), params, env, headers)
end

.invoices_for_subscription(id, params = {}, env = nil, headers = {}) ⇒ Object



147
148
149
# File 'lib/chargebee/models/invoice.rb', line 147

def self.invoices_for_subscription(id, params={}, env=nil, headers={})
  Request.send('get', uri_path("subscriptions",id.to_s,"invoices"), params, env, headers)
end

.list(params = {}, env = nil, headers = {}) ⇒ Object



139
140
141
# File 'lib/chargebee/models/invoice.rb', line 139

def self.list(params={}, env=nil, headers={})
  Request.send_list_request('get', uri_path("invoices"), params, env, headers)
end

.list_payment_reference_numbers(params = {}, env = nil, headers = {}) ⇒ Object



163
164
165
# File 'lib/chargebee/models/invoice.rb', line 163

def self.list_payment_reference_numbers(params={}, env=nil, headers={})
  Request.send('get', uri_path("invoices","payment_reference_numbers"), params, env, headers)
end

.payment_schedules(id, env = nil, headers = {}) ⇒ Object



235
236
237
# File 'lib/chargebee/models/invoice.rb', line 235

def self.payment_schedules(id, env=nil, headers={})
  Request.send('get', uri_path("invoices",id.to_s,"payment_schedules"), {}, env, headers)
end

.pdf(id, params = {}, env = nil, headers = {}) ⇒ Object



155
156
157
# File 'lib/chargebee/models/invoice.rb', line 155

def self.pdf(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"pdf"), params, env, headers)
end

.record_payment(id, params, env = nil, headers = {}) ⇒ Object



187
188
189
# File 'lib/chargebee/models/invoice.rb', line 187

def self.record_payment(id, params, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"record_payment"), params, env, headers)
end

.record_refund(id, params, env = nil, headers = {}) ⇒ Object



203
204
205
# File 'lib/chargebee/models/invoice.rb', line 203

def self.record_refund(id, params, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"record_refund"), params, env, headers)
end

.record_tax_withheld(id, params, env = nil, headers = {}) ⇒ Object



191
192
193
# File 'lib/chargebee/models/invoice.rb', line 191

def self.record_tax_withheld(id, params, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"record_tax_withheld"), params, env, headers)
end

.refund(id, params = {}, env = nil, headers = {}) ⇒ Object



199
200
201
# File 'lib/chargebee/models/invoice.rb', line 199

def self.refund(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"refund"), params, env, headers)
end

.remove_credit_note(id, params, env = nil, headers = {}) ⇒ Object



211
212
213
# File 'lib/chargebee/models/invoice.rb', line 211

def self.remove_credit_note(id, params, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"remove_credit_note"), params, env, headers)
end

.remove_payment(id, params, env = nil, headers = {}) ⇒ Object



207
208
209
# File 'lib/chargebee/models/invoice.rb', line 207

def self.remove_payment(id, params, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"remove_payment"), params, env, headers)
end

.remove_tax_withheld(id, params, env = nil, headers = {}) ⇒ Object



195
196
197
# File 'lib/chargebee/models/invoice.rb', line 195

def self.remove_tax_withheld(id, params, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"remove_tax_withheld"), params, env, headers)
end

.resend_einvoice(id, env = nil, headers = {}) ⇒ Object



239
240
241
# File 'lib/chargebee/models/invoice.rb', line 239

def self.resend_einvoice(id, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"resend_einvoice"), {}, env, headers)
end

.retrieve(id, env = nil, headers = {}) ⇒ Object



151
152
153
# File 'lib/chargebee/models/invoice.rb', line 151

def self.retrieve(id, env=nil, headers={})
  Request.send('get', uri_path("invoices",id.to_s), {}, env, headers)
end

.send_einvoice(id, env = nil, headers = {}) ⇒ Object



243
244
245
# File 'lib/chargebee/models/invoice.rb', line 243

def self.send_einvoice(id, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"send_einvoice"), {}, env, headers)
end

.stop_dunning(id, params = {}, env = nil, headers = {}) ⇒ Object



115
116
117
# File 'lib/chargebee/models/invoice.rb', line 115

def self.stop_dunning(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"stop_dunning"), params, env, headers)
end

.sync_usages(id, env = nil, headers = {}) ⇒ Object



127
128
129
# File 'lib/chargebee/models/invoice.rb', line 127

def self.sync_usages(id, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"sync_usages"), {}, env, headers)
end

.update_details(id, params = {}, env = nil, headers = {}) ⇒ Object



227
228
229
# File 'lib/chargebee/models/invoice.rb', line 227

def self.update_details(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"update_details"), params, env, headers)
end

.void_invoice(id, params = {}, env = nil, headers = {}) ⇒ Object



215
216
217
# File 'lib/chargebee/models/invoice.rb', line 215

def self.void_invoice(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"void"), params, env, headers)
end

.write_off(id, params = {}, env = nil, headers = {}) ⇒ Object



219
220
221
# File 'lib/chargebee/models/invoice.rb', line 219

def self.write_off(id, params={}, env=nil, headers={})
  Request.send('post', uri_path("invoices",id.to_s,"write_off"), params, env, headers)
end