Class: KillBillClient::Model::Invoice

Inherits:
InvoiceAttributes show all
Includes:
CustomFieldHelper, TagHelper
Defined in:
lib/killbill_client/models/invoice.rb

Constant Summary collapse

KILLBILL_API_INVOICES_PREFIX = 
"#{KILLBILL_API_PREFIX}/invoices"
KILLBILL_API_DRY_RUN_INVOICES_PREFIX = 
"#{KILLBILL_API_INVOICES_PREFIX}/dryRun"

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

Class Method Summary collapse

Instance Method Summary collapse

Methods included from TagHelper

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

Methods included from CustomFieldHelper

included

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

Class Method Details

.as_html(invoice_id, options = {}) ⇒ Object 



55
56
57
58
59
60
61
 
# File 'lib/killbill_client/models/invoice.rb', line 55

def as_html(invoice_id, options = {})
  get "#{KILLBILL_API_INVOICES_PREFIX}/#{invoice_id}/html",
      {},
      {
          :accept => 'text/html'
      }.merge(options)
end

.cancel_subscription_dry_run(account_id, bundle_id, subscription_id, target_date, effective_date, billing_policy, options = {}) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/killbill_client/models/invoice.rb', line 170

def cancel_subscription_dry_run(, bundle_id, subscription_id, target_date,
                                effective_date, billing_policy,  options = {})
  query_map              = {:accountId => }
  query_map[:targetDate] = target_date if !target_date.nil?

  dry_run = InvoiceDryRunAttributes.new
  dry_run.dry_run_type = 'SUBSCRIPTION_ACTION'
  dry_run.dry_run_action = 'STOP_BILLING'
  dry_run.effective_date = effective_date
  dry_run.billing_policy = billing_policy
  dry_run.bundle_id = bundle_id
  dry_run.subscription_id = subscription_id


  res = post "#{KILLBILL_API_DRY_RUN_INVOICES_PREFIX}",
             dry_run.to_json,
             query_map,
             {
                 :user    => 'cancel_subscription_dry_run',
                 :reason  => '',
                 :comment => '',
             }.merge(options),
             Invoice

  nothing_to_generate?(res) ? nil : res.refresh(options)

end

.change_plan_dry_run(account_id, bundle_id, subscription_id, target_date, product_name, product_category, billing_period, price_list_name, effective_date, billing_policy, options = {}) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/killbill_client/models/invoice.rb', line 137

def change_plan_dry_run(, bundle_id, subscription_id, target_date, product_name, product_category, billing_period, price_list_name,
                        effective_date, billing_policy, options = {})
  query_map              = {:accountId => }
  query_map[:targetDate] = target_date if !target_date.nil?

  dry_run = InvoiceDryRunAttributes.new
  dry_run.dry_run_type = 'SUBSCRIPTION_ACTION'
  dry_run.dry_run_action = 'CHANGE'
  dry_run.product_name = product_name
  dry_run.product_category = product_category
  dry_run.billing_period = billing_period
  dry_run.price_list_name = price_list_name
  dry_run.effective_date = effective_date
  dry_run.billing_policy = billing_policy
  dry_run.bundle_id = bundle_id
  dry_run.subscription_id = subscription_id


  res = post "#{KILLBILL_API_DRY_RUN_INVOICES_PREFIX}",
             dry_run.to_json,
             query_map,
             {
                 :user    => 'change_plan_dry_run',
                 :reason  => '',
                 :comment => '',
             }.merge(options),
             Invoice

  nothing_to_generate?(res) ? nil : res.refresh(options)

end

.create_migration_invoice(account_id, invoices, target_date, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/killbill_client/models/invoice.rb', line 297

def create_migration_invoice(, invoices, target_date, user = nil, reason = nil, comment = nil, options = {})

  params = {}
  params[:targetDate] = target_date
  post "#{KILLBILL_API_INVOICES_PREFIX}/migration/#{}",
       invoices.to_json,
       params,
       {
           :user    => user,
           :reason  => reason,
           :comment => comment,
       }.merge(options)
end

.create_subscription_dry_run(account_id, bundle_id, target_date, product_name, product_category, billing_period, price_list_name, options = {}) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/killbill_client/models/invoice.rb', line 109

def create_subscription_dry_run(, bundle_id, target_date, product_name, product_category,
                                billing_period, price_list_name,  options = {})
  query_map              = {:accountId => }
  query_map[:targetDate] = target_date if !target_date.nil?

  dry_run = InvoiceDryRunAttributes.new
  dry_run.dry_run_type = 'SUBSCRIPTION_ACTION'
  dry_run.dry_run_action = 'START_BILLING'
  dry_run.product_name = product_name
  dry_run.product_category = product_category
  dry_run.billing_period = billing_period
  dry_run.price_list_name = price_list_name
  dry_run.bundle_id = bundle_id

  res = post "#{KILLBILL_API_DRY_RUN_INVOICES_PREFIX}",
             dry_run.to_json,
             query_map,
             {
                 :user    => 'create_subscription_dry_run',
                 :reason  => '',
                 :comment => '',
             }.merge(options),
             Invoice

  nothing_to_generate?(res) ? nil : res.refresh(options)

end

.find_by_id(invoice_id, with_items = true, audit = "NONE", options = {}) ⇒ Object 



19
20
21
22
23
24
25
26
 
# File 'lib/killbill_client/models/invoice.rb', line 19

def find_by_id(invoice_id, with_items = true, audit = "NONE", options = {})
  get "#{KILLBILL_API_INVOICES_PREFIX}/#{invoice_id}",
      {
          :withItems => with_items,
          :audit     => audit
      },
      options
end

.find_by_number(number, with_items = true, audit = "NONE", options = {}) ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/killbill_client/models/invoice.rb', line 28

def find_by_number(number, with_items = true, audit = "NONE", options = {})
  get "#{KILLBILL_API_INVOICES_PREFIX}/byNumber/#{number}",
      {
          :withItems => with_items,
          :audit     => audit
      },
      options
end

.find_in_batches(offset = 0, limit = 100, options = {}) ⇒ Object 



37
38
39
40
41
42
43
44
 
# File 'lib/killbill_client/models/invoice.rb', line 37

def find_in_batches(offset = 0, limit = 100, options = {})
  get "#{KILLBILL_API_INVOICES_PREFIX}/#{Resource::KILLBILL_API_PAGINATION_PREFIX}",
      {
          :offset => offset,
          :limit  => limit
      },
      options
end

.find_in_batches_by_search_key(search_key, offset = 0, limit = 100, options = {}) ⇒ Object 



46
47
48
49
50
51
52
53
 
# File 'lib/killbill_client/models/invoice.rb', line 46

def find_in_batches_by_search_key(search_key, offset = 0, limit = 100, options = {})
  get "#{KILLBILL_API_INVOICES_PREFIX}/search/#{search_key}",
      {
          :offset => offset,
          :limit  => limit
      },
      options
end

.get_catalog_translation(locale, options = {}) ⇒ Object 



266
267
268
269
270
271
272
273
274
275
 
# File 'lib/killbill_client/models/invoice.rb', line 266

def get_catalog_translation(locale, options = {})

  require_multi_tenant_options!(options, "Retrieving a catalog translation is only supported in multi-tenant mode")

  get "#{KILLBILL_API_INVOICES_PREFIX}/catalogTranslation/#{locale}",
      {},
      {
          :head => {'Accept' => 'text/plain'},
      }.merge(options)
end

.get_invoice_template(is_manual_pay, locale = nil, options = {}) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/killbill_client/models/invoice.rb', line 199

def get_invoice_template(is_manual_pay, locale = nil, options = {})

  require_multi_tenant_options!(options, "Retrieving an invoice template supported in multi-tenant mode")


  get "#{KILLBILL_API_INVOICES_PREFIX}/#{is_manual_pay ? "manualPayTemplate/#{locale}" : "template"}",
      {},
      {
          :head => {'Accept' => 'text/html'},
      }.merge(options)
end

.get_invoice_translation(locale, options = {}) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/killbill_client/models/invoice.rb', line 232

def get_invoice_translation(locale, options = {})

  require_multi_tenant_options!(options, "Retrieving an invoice translation supported in multi-tenant mode")


  get "#{KILLBILL_API_INVOICES_PREFIX}/translation/#{locale}",
      {},
      {
          :head => {'Accept' => 'text/plain'},
      }.merge(options)
end

.trigger_invoice(account_id, target_date, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/killbill_client/models/invoice.rb', line 63

def trigger_invoice(, target_date, user = nil, reason = nil, comment = nil, options = {})
  query_map              = {:accountId => }
  query_map[:targetDate] = target_date if !target_date.nil?

  begin
    res = post "#{KILLBILL_API_INVOICES_PREFIX}/",
               {},
               query_map,
               {
                   :user    => user,
                   :reason  => reason,
                   :comment => comment,
               }.merge(options),
               Invoice

    res.refresh(options)

  rescue KillBillClient::API::BadRequest
    # No invoice to generate : TODO parse json to verify this is indeed the case
  end
end

.trigger_invoice_dry_run(account_id, target_date, upcoming_invoice_target_date, options = {}) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/killbill_client/models/invoice.rb', line 85

def trigger_invoice_dry_run(, target_date, upcoming_invoice_target_date, options = {})

  dry_run = InvoiceDryRunAttributes.new
  dry_run.dry_run_type = upcoming_invoice_target_date ? 'UPCOMING_INVOICE' : 'TARGET_DATE'

  query_map = {:accountId => }
  query_map[:targetDate] = target_date if target_date != nil

  res = post "#{KILLBILL_API_DRY_RUN_INVOICES_PREFIX}",
             dry_run.to_json,
             query_map,
             {
                 :user => 'trigger_invoice_dry_run',
                 :reason => '',
                 :comment => '',
             }.merge(options),
             Invoice


  nothing_to_generate?(res) ? nil : res.refresh(options)

end

.upload_catalog_translation(catalog_translation, locale, delete_if_exists, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/killbill_client/models/invoice.rb', line 277

def upload_catalog_translation(catalog_translation, locale, delete_if_exists, user = nil, reason = nil, comment = nil, options = {})

  require_multi_tenant_options!(options, "Uploading a catalog translation is only supported in multi-tenant mode")

  params                  = {}
  params[:deleteIfExists] = delete_if_exists if delete_if_exists

  post "#{KILLBILL_API_INVOICES_PREFIX}/catalogTranslation/#{locale}",
       catalog_translation,
       params,
       {
           :head => {'Accept' => 'text/plain'},
           :content_type => 'text/plain',
           :user => user,
           :reason => reason,
           :comment => comment,
       }.merge(options)
  get_catalog_translation(locale, options)
end

.upload_invoice_template(invoice_template, is_manual_pay, delete_if_exists, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/killbill_client/models/invoice.rb', line 211

def upload_invoice_template(invoice_template, is_manual_pay, delete_if_exists, user = nil, reason = nil, comment = nil, options = {})

  require_multi_tenant_options!(options, "Uploading a invoice template is only supported in multi-tenant mode")


  params                  = {}
  params[:deleteIfExists] = delete_if_exists if delete_if_exists

  post "#{KILLBILL_API_INVOICES_PREFIX}/#{is_manual_pay ? "manualPayTemplate" : "template"}",
       invoice_template,
       params,
       {
           :head => {'Accept' => 'text/html'},
           :content_type => 'text/html',
           :user => user,
           :reason => reason,
           :comment => comment,
       }.merge(options)
  get_invoice_template(is_manual_pay, nil, options)
end

.upload_invoice_translation(invoice_translation, locale, delete_if_exists, user = nil, reason = nil, comment = nil, options = {}) ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/killbill_client/models/invoice.rb', line 244

def upload_invoice_translation(invoice_translation, locale, delete_if_exists, user = nil, reason = nil, comment = nil, options = {})

  require_multi_tenant_options!(options, "Uploading a invoice translation is only supported in multi-tenant mode")


  params                  = {}
  params[:deleteIfExists] = delete_if_exists if delete_if_exists

  post "#{KILLBILL_API_INVOICES_PREFIX}/translation/#{locale}",
       invoice_translation,
       params,
       {
           :head => {'Accept' => 'text/plain'},
           :content_type => 'text/plain',
           :user => user,
           :reason => reason,
           :comment => comment,
       }.merge(options)
  get_invoice_translation(locale, options)
end

Instance Method Details

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



313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/killbill_client/models/invoice.rb', line 313

def commit(user = nil, reason = nil, comment = nil, options = {})

  self.class.put "#{Invoice::KILLBILL_API_INVOICES_PREFIX}/#{invoice_id}/commitInvoice",
                 nil,
                 {},
                 {
                     :user => user,
                     :reason => reason,
                     :comment => comment,
                 }.merge(options)

end

#payments(with_plugin_info = false, with_attempts = false, audit = 'NONE', options = {}) ⇒ Object 



339
340
341
342
343
344
345
346
347
348
 
# File 'lib/killbill_client/models/invoice.rb', line 339

def payments(with_plugin_info = false, with_attempts = false, audit = 'NONE', options = {})
  self.class.get "#{KILLBILL_API_INVOICES_PREFIX}/#{invoice_id}/payments",
                 {
                     :withAttempts => with_attempts,
                     :withPluginInfo => with_plugin_info,
                     :audit          => audit
                 },
                 options,
                 InvoicePayment
end

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



350
351
352
353
354
355
356
357
358
359
 
# File 'lib/killbill_client/models/invoice.rb', line 350

def trigger_email_notifications(user = nil, reason = nil, comment = nil, options = {})
  self.class.post "#{KILLBILL_API_INVOICES_PREFIX}/#{invoice_id}/emailNotifications",
                  {},
                  {},
                  {
                      :user    => user,
                      :reason  => reason,
                      :comment => comment,
                  }.merge(options)
end

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



326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/killbill_client/models/invoice.rb', line 326

def void(user = nil, reason = nil, comment = nil, options = {})

  self.class.put "#{Invoice::KILLBILL_API_INVOICES_PREFIX}/#{invoice_id}/voidInvoice",
                 nil,
                 {},
                 {
                     :user => user,
                     :reason => reason,
                     :comment => comment,
                 }.merge(options)

end