Class: ChargeBee::CreditNote

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

Defined Under Namespace

Classes: Allocation, Discount, LineItem, LineItemDiscount, LineItemTax, LineItemTier, LinkedRefund, 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

#allocations ⇒ Object

Returns the value of attribute allocations.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def allocations
  @allocations
end

#amount_allocated ⇒ Object

Returns the value of attribute amount_allocated.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def amount_allocated
  @amount_allocated
end

#amount_available ⇒ Object

Returns the value of attribute amount_available.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def amount_available
  @amount_available
end

#amount_refunded ⇒ Object

Returns the value of attribute amount_refunded.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def amount_refunded
  @amount_refunded
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def currency_code
  @currency_code
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def customer_id
  @customer_id
end

#date ⇒ Object

Returns the value of attribute date.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def date
  @date
end

#deleted ⇒ Object

Returns the value of attribute deleted.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def deleted
  @deleted
end

#discounts ⇒ Object

Returns the value of attribute discounts.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def discounts
  @discounts
end

#fractional_correction ⇒ Object

Returns the value of attribute fractional_correction.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def fractional_correction
  @fractional_correction
end

#id ⇒ Object

Returns the value of attribute id.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def id
  @id
end

#line_item_discounts ⇒ Object

Returns the value of attribute line_item_discounts.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def line_item_discounts
  @line_item_discounts
end

#line_item_taxes ⇒ Object

Returns the value of attribute line_item_taxes.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def line_item_taxes
  @line_item_taxes
end

#line_item_tiers ⇒ Object

Returns the value of attribute line_item_tiers.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def line_item_tiers
  @line_item_tiers
end

#line_items ⇒ Object

Returns the value of attribute line_items.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def line_items
  @line_items
end

#linked_refunds ⇒ Object

Returns the value of attribute linked_refunds.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def linked_refunds
  @linked_refunds
end

#local_currency_code ⇒ Object

Returns the value of attribute local_currency_code.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def local_currency_code
  @local_currency_code
end

#price_type ⇒ Object

Returns the value of attribute price_type.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def price_type
  @price_type
end

#reason_code ⇒ Object

Returns the value of attribute reason_code.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def reason_code
  @reason_code
end

#reference_invoice_id ⇒ Object

Returns the value of attribute reference_invoice_id.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def reference_invoice_id
  @reference_invoice_id
end

#refunded_at ⇒ Object

Returns the value of attribute refunded_at.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def refunded_at
  @refunded_at
end

#resource_version ⇒ Object

Returns the value of attribute resource_version.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def resource_version
  @resource_version
end

#round_off_amount ⇒ Object

Returns the value of attribute round_off_amount.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def round_off_amount
  @round_off_amount
end

#status ⇒ Object

Returns the value of attribute status.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def status
  @status
end

#sub_total ⇒ Object

Returns the value of attribute sub_total.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def sub_total
  @sub_total
end

#sub_total_in_local_currency ⇒ Object

Returns the value of attribute sub_total_in_local_currency.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def sub_total_in_local_currency
  @sub_total_in_local_currency
end

#subscription_id ⇒ Object

Returns the value of attribute subscription_id.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def subscription_id
  @subscription_id
end

#taxes ⇒ Object

Returns the value of attribute taxes.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def taxes
  @taxes
end

#total ⇒ Object

Returns the value of attribute total.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def total
  @total
end

#total_in_local_currency ⇒ Object

Returns the value of attribute total_in_local_currency.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def total_in_local_currency
  @total_in_local_currency
end

#type ⇒ Object

Returns the value of attribute type.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def updated_at
  @updated_at
end

#vat_number ⇒ Object

Returns the value of attribute vat_number.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def vat_number
  @vat_number
end

#voided_at ⇒ Object

Returns the value of attribute voided_at.



36
37
38
 
# File 'lib/chargebee/models/credit_note.rb', line 36

def voided_at
  @voided_at
end

Class Method Details

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

OPERATIONS



46
47
48
 
# File 'lib/chargebee/models/credit_note.rb', line 46

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

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



74
75
76
 
# File 'lib/chargebee/models/credit_note.rb', line 74

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

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



78
79
80
 
# File 'lib/chargebee/models/credit_note.rb', line 78

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

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



70
71
72
 
# File 'lib/chargebee/models/credit_note.rb', line 70

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

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



54
55
56
 
# File 'lib/chargebee/models/credit_note.rb', line 54

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

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



62
63
64
 
# File 'lib/chargebee/models/credit_note.rb', line 62

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

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



58
59
60
 
# File 'lib/chargebee/models/credit_note.rb', line 58

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

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



50
51
52
 
# File 'lib/chargebee/models/credit_note.rb', line 50

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

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



66
67
68
 
# File 'lib/chargebee/models/credit_note.rb', line 66

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