Class: ChargeBee::Invoice

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

Defined Under Namespace

Classes: AdjustmentCreditNote, AppliedCredit, BillingAddress, Discount, IssuedCreditNote, LineItem, LineItemTax, LinkedOrder, LinkedPayment, Note, ShippingAddress, Tax

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Model

construct, #init_dependant, #init_dependant_list, #initialize, #inspect, #load, #method_missing, #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_notes ⇒ Object

Returns the value of attribute adjustment_credit_notes.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def adjustment_credit_notes
  @adjustment_credit_notes
end

#amount_adjusted ⇒ Object

Returns the value of attribute amount_adjusted.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def amount_adjusted
  @amount_adjusted
end

#amount_due ⇒ Object

Returns the value of attribute amount_due.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def amount_due
  @amount_due
end

#amount_paid ⇒ Object

Returns the value of attribute amount_paid.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def amount_paid
  @amount_paid
end

#applied_credits ⇒ Object

Returns the value of attribute applied_credits.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def applied_credits
  @applied_credits
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def billing_address
  @billing_address
end

#credits_applied ⇒ Object

Returns the value of attribute credits_applied.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def credits_applied
  @credits_applied
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def currency_code
  @currency_code
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def customer_id
  @customer_id
end

#date ⇒ Object

Returns the value of attribute date.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def date
  @date
end

#discounts ⇒ Object

Returns the value of attribute discounts.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def discounts
  @discounts
end

#dunning_status ⇒ Object

Returns the value of attribute dunning_status.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def dunning_status
  @dunning_status
end

#first_invoice ⇒ Object

Returns the value of attribute first_invoice.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def first_invoice
  @first_invoice
end

#id ⇒ Object

Returns the value of attribute id.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def id
  @id
end

#issued_credit_notes ⇒ Object

Returns the value of attribute issued_credit_notes.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def issued_credit_notes
  @issued_credit_notes
end

#line_item_taxes ⇒ Object

Returns the value of attribute line_item_taxes.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def line_item_taxes
  @line_item_taxes
end

#line_items ⇒ Object

Returns the value of attribute line_items.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def line_items
  @line_items
end

#linked_orders ⇒ Object

Returns the value of attribute linked_orders.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def linked_orders
  @linked_orders
end

#linked_payments ⇒ Object

Returns the value of attribute linked_payments.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def linked_payments
  @linked_payments
end

#next_retry_at ⇒ Object

Returns the value of attribute next_retry_at.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def next_retry_at
  @next_retry_at
end

#notes ⇒ Object

Returns the value of attribute notes.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def notes
  @notes
end

Returns the value of attribute paid_at.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def paid_at
  @paid_at
end

#po_number ⇒ Object

Returns the value of attribute po_number.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def po_number
  @po_number
end

#price_type ⇒ Object

Returns the value of attribute price_type.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def price_type
  @price_type
end

#recurring ⇒ Object

Returns the value of attribute recurring.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def recurring
  @recurring
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def shipping_address
  @shipping_address
end

#status ⇒ Object

Returns the value of attribute status.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def status
  @status
end

#sub_total ⇒ Object

Returns the value of attribute sub_total.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def sub_total
  @sub_total
end

#subscription_id ⇒ Object

Returns the value of attribute subscription_id.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def subscription_id
  @subscription_id
end

#tax ⇒ Object

Returns the value of attribute tax.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def tax
  @tax
end

#taxes ⇒ Object

Returns the value of attribute taxes.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def taxes
  @taxes
end

#total ⇒ Object

Returns the value of attribute total.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def total
  @total
end

#vat_number ⇒ Object

Returns the value of attribute vat_number.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def vat_number
  @vat_number
end

#write_off_amount ⇒ Object

Returns the value of attribute write_off_amount.



52
53
54
 
# File 'lib/chargebee/models/invoice.rb', line 52

def write_off_amount
  @write_off_amount
end

Class Method Details

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



101
102
103
 
# File 'lib/chargebee/models/invoice.rb', line 101

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 



97
98
99
 
# File 'lib/chargebee/models/invoice.rb', line 97

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

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



65
66
67
 
# File 'lib/chargebee/models/invoice.rb', line 65

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 



69
70
71
 
# File 'lib/chargebee/models/invoice.rb', line 69

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

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



105
106
107
 
# File 'lib/chargebee/models/invoice.rb', line 105

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

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



109
110
111
 
# File 'lib/chargebee/models/invoice.rb', line 109

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



61
62
63
 
# File 'lib/chargebee/models/invoice.rb', line 61

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

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



129
130
131
 
# File 'lib/chargebee/models/invoice.rb', line 129

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

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



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

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 



85
86
87
 
# File 'lib/chargebee/models/invoice.rb', line 85

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 



77
78
79
 
# File 'lib/chargebee/models/invoice.rb', line 77

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

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



93
94
95
 
# File 'lib/chargebee/models/invoice.rb', line 93

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

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



113
114
115
 
# File 'lib/chargebee/models/invoice.rb', line 113

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 



121
122
123
 
# File 'lib/chargebee/models/invoice.rb', line 121

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

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



117
118
119
 
# File 'lib/chargebee/models/invoice.rb', line 117

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

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



89
90
91
 
# File 'lib/chargebee/models/invoice.rb', line 89

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

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



73
74
75
 
# File 'lib/chargebee/models/invoice.rb', line 73

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

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



125
126
127
 
# File 'lib/chargebee/models/invoice.rb', line 125

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