Class: ChargeBee::CreditNote
- Defined in:
- lib/chargebee/models/credit_note.rb
Defined Under Namespace
Classes: Allocation, Discount, Einvoice, LineItem, LineItemDiscount, LineItemTax, LineItemTier, LinkedRefund, Tax
Instance Attribute Summary collapse
-
#allocations ⇒ Object
Returns the value of attribute allocations.
-
#amount_allocated ⇒ Object
Returns the value of attribute amount_allocated.
-
#amount_available ⇒ Object
Returns the value of attribute amount_available.
-
#amount_refunded ⇒ Object
Returns the value of attribute amount_refunded.
-
#channel ⇒ Object
Returns the value of attribute channel.
-
#create_reason_code ⇒ Object
Returns the value of attribute create_reason_code.
-
#currency_code ⇒ Object
Returns the value of attribute currency_code.
-
#customer_id ⇒ Object
Returns the value of attribute customer_id.
-
#date ⇒ Object
Returns the value of attribute date.
-
#deleted ⇒ Object
Returns the value of attribute deleted.
-
#discounts ⇒ Object
Returns the value of attribute discounts.
-
#einvoice ⇒ Object
Returns the value of attribute einvoice.
-
#fractional_correction ⇒ Object
Returns the value of attribute fractional_correction.
-
#generated_at ⇒ Object
Returns the value of attribute generated_at.
-
#id ⇒ Object
Returns the value of attribute id.
-
#line_item_discounts ⇒ Object
Returns the value of attribute line_item_discounts.
-
#line_item_taxes ⇒ Object
Returns the value of attribute line_item_taxes.
-
#line_item_tiers ⇒ Object
Returns the value of attribute line_item_tiers.
-
#line_items ⇒ Object
Returns the value of attribute line_items.
-
#linked_refunds ⇒ Object
Returns the value of attribute linked_refunds.
-
#local_currency_code ⇒ Object
Returns the value of attribute local_currency_code.
-
#price_type ⇒ Object
Returns the value of attribute price_type.
-
#reason_code ⇒ Object
Returns the value of attribute reason_code.
-
#reference_invoice_id ⇒ Object
Returns the value of attribute reference_invoice_id.
-
#refunded_at ⇒ Object
Returns the value of attribute refunded_at.
-
#resource_version ⇒ Object
Returns the value of attribute resource_version.
-
#round_off_amount ⇒ Object
Returns the value of attribute round_off_amount.
-
#status ⇒ Object
Returns the value of attribute status.
-
#sub_total ⇒ Object
Returns the value of attribute sub_total.
-
#sub_total_in_local_currency ⇒ Object
Returns the value of attribute sub_total_in_local_currency.
-
#subscription_id ⇒ Object
Returns the value of attribute subscription_id.
-
#taxes ⇒ Object
Returns the value of attribute taxes.
-
#total ⇒ Object
Returns the value of attribute total.
-
#total_in_local_currency ⇒ Object
Returns the value of attribute total_in_local_currency.
-
#type ⇒ Object
Returns the value of attribute type.
-
#updated_at ⇒ Object
Returns the value of attribute updated_at.
-
#vat_number ⇒ Object
Returns the value of attribute vat_number.
-
#vat_number_prefix ⇒ Object
Returns the value of attribute vat_number_prefix.
-
#voided_at ⇒ Object
Returns the value of attribute voided_at.
Class Method Summary collapse
-
.create(params, env = nil, headers = {}) ⇒ Object
OPERATIONS ———–.
- .credit_notes_for_customer(id, params = {}, env = nil, headers = {}) ⇒ Object
- .delete(id, params = {}, env = nil, headers = {}) ⇒ Object
- .download_einvoice(id, env = nil, headers = {}) ⇒ Object
- .list(params = {}, env = nil, headers = {}) ⇒ Object
- .pdf(id, params = {}, env = nil, headers = {}) ⇒ Object
- .record_refund(id, params, env = nil, headers = {}) ⇒ Object
- .refund(id, params = {}, env = nil, headers = {}) ⇒ Object
- .resend_einvoice(id, env = nil, headers = {}) ⇒ Object
- .retrieve(id, env = nil, headers = {}) ⇒ Object
- .void_credit_note(id, params = {}, env = nil, headers = {}) ⇒ Object
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.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def allocations @allocations end |
#amount_allocated ⇒ Object
Returns the value of attribute amount_allocated.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def amount_allocated @amount_allocated end |
#amount_available ⇒ Object
Returns the value of attribute amount_available.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def amount_available @amount_available end |
#amount_refunded ⇒ Object
Returns the value of attribute amount_refunded.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def amount_refunded @amount_refunded end |
#channel ⇒ Object
Returns the value of attribute channel.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def channel @channel end |
#create_reason_code ⇒ Object
Returns the value of attribute create_reason_code.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def create_reason_code @create_reason_code end |
#currency_code ⇒ Object
Returns the value of attribute currency_code.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def currency_code @currency_code end |
#customer_id ⇒ Object
Returns the value of attribute customer_id.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def customer_id @customer_id end |
#date ⇒ Object
Returns the value of attribute date.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def date @date end |
#deleted ⇒ Object
Returns the value of attribute deleted.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def deleted @deleted end |
#discounts ⇒ Object
Returns the value of attribute discounts.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def discounts @discounts end |
#einvoice ⇒ Object
Returns the value of attribute einvoice.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def einvoice @einvoice end |
#fractional_correction ⇒ Object
Returns the value of attribute fractional_correction.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def fractional_correction @fractional_correction end |
#generated_at ⇒ Object
Returns the value of attribute generated_at.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def generated_at @generated_at end |
#id ⇒ Object
Returns the value of attribute id.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def id @id end |
#line_item_discounts ⇒ Object
Returns the value of attribute line_item_discounts.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def line_item_discounts @line_item_discounts end |
#line_item_taxes ⇒ Object
Returns the value of attribute line_item_taxes.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def line_item_taxes @line_item_taxes end |
#line_item_tiers ⇒ Object
Returns the value of attribute line_item_tiers.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def line_item_tiers @line_item_tiers end |
#line_items ⇒ Object
Returns the value of attribute line_items.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def line_items @line_items end |
#linked_refunds ⇒ Object
Returns the value of attribute linked_refunds.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def linked_refunds @linked_refunds end |
#local_currency_code ⇒ Object
Returns the value of attribute local_currency_code.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def local_currency_code @local_currency_code end |
#price_type ⇒ Object
Returns the value of attribute price_type.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def price_type @price_type end |
#reason_code ⇒ Object
Returns the value of attribute reason_code.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def reason_code @reason_code end |
#reference_invoice_id ⇒ Object
Returns the value of attribute reference_invoice_id.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def reference_invoice_id @reference_invoice_id end |
#refunded_at ⇒ Object
Returns the value of attribute refunded_at.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def refunded_at @refunded_at end |
#resource_version ⇒ Object
Returns the value of attribute resource_version.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def resource_version @resource_version end |
#round_off_amount ⇒ Object
Returns the value of attribute round_off_amount.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def round_off_amount @round_off_amount end |
#status ⇒ Object
Returns the value of attribute status.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def status @status end |
#sub_total ⇒ Object
Returns the value of attribute sub_total.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def sub_total @sub_total end |
#sub_total_in_local_currency ⇒ Object
Returns the value of attribute sub_total_in_local_currency.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def sub_total_in_local_currency @sub_total_in_local_currency end |
#subscription_id ⇒ Object
Returns the value of attribute subscription_id.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def subscription_id @subscription_id end |
#taxes ⇒ Object
Returns the value of attribute taxes.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def taxes @taxes end |
#total ⇒ Object
Returns the value of attribute total.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def total @total end |
#total_in_local_currency ⇒ Object
Returns the value of attribute total_in_local_currency.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def total_in_local_currency @total_in_local_currency end |
#type ⇒ Object
Returns the value of attribute type.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def type @type end |
#updated_at ⇒ Object
Returns the value of attribute updated_at.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def updated_at @updated_at end |
#vat_number ⇒ Object
Returns the value of attribute vat_number.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def vat_number @vat_number end |
#vat_number_prefix ⇒ Object
Returns the value of attribute vat_number_prefix.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def vat_number_prefix @vat_number_prefix end |
#voided_at ⇒ Object
Returns the value of attribute voided_at.
40 41 42 |
# File 'lib/chargebee/models/credit_note.rb', line 40 def voided_at @voided_at end |
Class Method Details
.create(params, env = nil, headers = {}) ⇒ Object
OPERATIONS
50 51 52 |
# File 'lib/chargebee/models/credit_note.rb', line 50 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
82 83 84 |
# File 'lib/chargebee/models/credit_note.rb', line 82 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
86 87 88 |
# File 'lib/chargebee/models/credit_note.rb', line 86 def self.delete(id, params={}, env=nil, headers={}) Request.send('post', uri_path("credit_notes",id.to_s,"delete"), params, env, headers) end |
.download_einvoice(id, env = nil, headers = {}) ⇒ Object
62 63 64 |
# File 'lib/chargebee/models/credit_note.rb', line 62 def self.download_einvoice(id, env=nil, headers={}) Request.send('get', uri_path("credit_notes",id.to_s,"download_einvoice"), {}, env, headers) end |
.list(params = {}, env = nil, headers = {}) ⇒ Object
78 79 80 |
# File 'lib/chargebee/models/credit_note.rb', line 78 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
58 59 60 |
# File 'lib/chargebee/models/credit_note.rb', line 58 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
70 71 72 |
# File 'lib/chargebee/models/credit_note.rb', line 70 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
66 67 68 |
# File 'lib/chargebee/models/credit_note.rb', line 66 def self.refund(id, params={}, env=nil, headers={}) Request.send('post', uri_path("credit_notes",id.to_s,"refund"), params, env, headers) end |
.resend_einvoice(id, env = nil, headers = {}) ⇒ Object
90 91 92 |
# File 'lib/chargebee/models/credit_note.rb', line 90 def self.resend_einvoice(id, env=nil, headers={}) Request.send('post', uri_path("credit_notes",id.to_s,"resend_einvoice"), {}, env, headers) end |