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, 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.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def allocations
  @allocations
end

#amount_allocated ⇒ Object

Returns the value of attribute amount_allocated.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def amount_allocated
  @amount_allocated
end

#amount_available ⇒ Object

Returns the value of attribute amount_available.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def amount_available
  @amount_available
end

#amount_refunded ⇒ Object

Returns the value of attribute amount_refunded.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def amount_refunded
  @amount_refunded
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def currency_code
  @currency_code
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def customer_id
  @customer_id
end

#date ⇒ Object

Returns the value of attribute date.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def date
  @date
end

#deleted ⇒ Object

Returns the value of attribute deleted.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def deleted
  @deleted
end

#discounts ⇒ Object

Returns the value of attribute discounts.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def discounts
  @discounts
end

#id ⇒ Object

Returns the value of attribute id.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def id
  @id
end

#line_item_discounts ⇒ Object

Returns the value of attribute line_item_discounts.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def line_item_discounts
  @line_item_discounts
end

#line_item_taxes ⇒ Object

Returns the value of attribute line_item_taxes.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def line_item_taxes
  @line_item_taxes
end

#line_items ⇒ Object

Returns the value of attribute line_items.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def line_items
  @line_items
end

#linked_refunds ⇒ Object

Returns the value of attribute linked_refunds.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def linked_refunds
  @linked_refunds
end

#price_type ⇒ Object

Returns the value of attribute price_type.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def price_type
  @price_type
end

#reason_code ⇒ Object

Returns the value of attribute reason_code.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def reason_code
  @reason_code
end

#reference_invoice_id ⇒ Object

Returns the value of attribute reference_invoice_id.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def reference_invoice_id
  @reference_invoice_id
end

#refunded_at ⇒ Object

Returns the value of attribute refunded_at.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def refunded_at
  @refunded_at
end

#resource_version ⇒ Object

Returns the value of attribute resource_version.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def resource_version
  @resource_version
end

#status ⇒ Object

Returns the value of attribute status.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def status
  @status
end

#sub_total ⇒ Object

Returns the value of attribute sub_total.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def sub_total
  @sub_total
end

#subscription_id ⇒ Object

Returns the value of attribute subscription_id.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def subscription_id
  @subscription_id
end

#taxes ⇒ Object

Returns the value of attribute taxes.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def taxes
  @taxes
end

#total ⇒ Object

Returns the value of attribute total.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def total
  @total
end

#type ⇒ Object

Returns the value of attribute type.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def updated_at
  @updated_at
end

#vat_number ⇒ Object

Returns the value of attribute vat_number.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def vat_number
  @vat_number
end

#voided_at ⇒ Object

Returns the value of attribute voided_at.



32
33
34
 
# File 'lib/chargebee/models/credit_note.rb', line 32

def voided_at
  @voided_at
end

Class Method Details

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

OPERATIONS



40
41
42
 
# File 'lib/chargebee/models/credit_note.rb', line 40

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 



56
57
58
 
# File 'lib/chargebee/models/credit_note.rb', line 56

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

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



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

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

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



48
49
50
 
# File 'lib/chargebee/models/credit_note.rb', line 48

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

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



44
45
46
 
# File 'lib/chargebee/models/credit_note.rb', line 44

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