Class: KillBillClient::Model::InvoiceItem

Inherits:
InvoiceItemAttributes show all
Includes:
AuditLogWithHistoryHelper, CustomFieldHelper, TagHelper
Defined in:
lib/killbill_client/models/invoice_item.rb

Constant Summary collapse

KILLBILL_API_INVOICE_ITEMS_PREFIX = 
"#{KILLBILL_API_PREFIX}/invoiceItems"

Constants included from TagHelper

TagHelper::AUTO_INVOICING_OFF_ID, TagHelper::AUTO_PAY_OFF_ID, TagHelper::MANUAL_PAY_ID, TagHelper::OVERDUE_ENFORCEMENT_OFF_ID, TagHelper::TEST_ID, TagHelper::WRITTEN_OFF_ID

Constants inherited from Resource

Resource::KILLBILL_API_PAGINATION_PREFIX, Resource::KILLBILL_API_PREFIX

Instance Attribute Summary

Attributes inherited from Resource

#clazz, #etag, #response, #session_id, #uri

Instance Method Summary collapse

Methods included from AuditLogWithHistoryHelper

included

Methods included from CustomFieldHelper

included

Methods included from TagHelper

#add_tag, #add_tag_from_definition_id, #control_tag?, included, #remove_tag, #remove_tag_from_definition_id, #set_tags

Methods inherited from Resource

#==, #_to_hash, attribute, create_alias, delete, extract_session_id, from_json, from_response, get, has_many, has_one, #hash, head, #initialize, instantiate_record_from_json, post, put, #refresh, require_multi_tenant_options!, #to_hash, #to_json

Constructor Details

This class inherits a constructor from KillBillClient::Model::Resource

Instance Method Details

#add_tags_from_definition_ids(tag_definition_ids, user, reason, comment, options) ⇒ Object

DO NOT DELETE THIS METHOD



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/killbill_client/models/invoice_item.rb', line 32

def add_tags_from_definition_ids(tag_definition_ids, user, reason, comment, options)
  created_tag = self.class.post "#{KILLBILL_API_INVOICE_ITEMS_PREFIX}/#{invoice_item_id}/tags",
                                tag_definition_ids,
                                {},
                                {
                                    :user    => user,
                                    :reason  => reason,
                                    :comment => comment,
                                }.merge(options),
                                Tag
  tags(false, 'NONE', options) unless created_tag.nil?
end

#create(auto_commit = false, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/killbill_client/models/invoice_item.rb', line 45

def create(auto_commit = false, user = nil, reason = nil, comment = nil, options = {})
  created_invoice_item = self.class.post "#{Invoice::KILLBILL_API_INVOICES_PREFIX}/charges/#{}",
                                         [to_hash].to_json,
                                         {:autoCommit => auto_commit},
                                         {
                                             :user    => user,
                                             :reason  => reason,
                                             :comment => comment,
                                         }.merge(options)
  created_invoice_item.first.refresh(options, Invoice)
end

#create_tax_item(auto_commit = false, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/killbill_client/models/invoice_item.rb', line 89

def create_tax_item(auto_commit = false, user = nil, reason = nil, comment = nil, options = {})
  created_tax_item = self.class.post "#{Invoice::KILLBILL_API_INVOICES_PREFIX}/taxes/#{}",
                                         [to_hash].to_json,
                                         {:autoCommit => auto_commit},
                                         {
                                             :user    => user,
                                             :reason  => reason,
                                             :comment => comment,
                                         }.merge(options)
  created_tax_item.first.refresh(options, Invoice)
end

#delete(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object

Delete CBA

Required: invoice_id, invoice_item_id



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/killbill_client/models/invoice_item.rb', line 76

def delete(user = nil, reason = nil, comment = nil, options = {})
  self.class.delete "#{Invoice::KILLBILL_API_INVOICES_PREFIX}/#{invoice_id}/#{invoice_item_id}/cba",
                    to_json,
                    {
                        :accountId => 
                    },
                    {
                        :user    => user,
                        :reason  => reason,
                        :comment => comment,
                    }.merge(options)
end

#tags(included_deleted = false, audit = 'NONE', options = {}) ⇒ Object

DO NOT DELETE THIS METHOD



19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/killbill_client/models/invoice_item.rb', line 19

def tags(included_deleted = false, audit = 'NONE', options = {})
  params = {}
  # Non-standard, required, parameter
  params[:accountId] = 
  params[:includedDeleted] = included_deleted if included_deleted
  params[:audit] = audit
  self.class.get "#{KILLBILL_API_INVOICE_ITEMS_PREFIX}/#{invoice_item_id}/tags",
                 params,
                 options,
                 Tag
end

#update(user = nil, reason = nil, comment = nil, options = {}) ⇒ Object

Adjust an invoice item

Required: account_id, invoice_id, invoice_item_id Optional: amount, currency



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/killbill_client/models/invoice_item.rb', line 61

def update(user = nil, reason = nil, comment = nil, options = {})
  adjusted_invoice_item = self.class.post "#{Invoice::KILLBILL_API_INVOICES_PREFIX}/#{invoice_id}",
                                          to_json,
                                          {},
                                          {
                                              :user    => user,
                                              :reason  => reason,
                                              :comment => comment,
                                          }.merge(options)
  adjusted_invoice_item.refresh(options, Invoice)
end