Class: Bfwd::InvoicesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/api/invoices_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvoicesApi

Returns a new instance of InvoicesApi.



19
20
21
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_charge_to_invoice(invoice_id, charge, opts = {}) ⇒ SubscriptionChargePagedMetadata

Creates a charge on the specified invoice. to invoice","response":"addChargeToInvoice.html","request":"addChargeToInvoiceRequest.html"

Parameters:

  • invoice_id —

    ID of the invoice.

  • charge —

    The charge request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 29

def add_charge_to_invoice(invoice_id, charge, opts = {})
  data, _status_code, _headers = add_charge_to_invoice_with_http_info(invoice_id, charge, opts)
  return data
end

#add_charge_to_invoice_with_http_info(invoice_id, charge, opts = {}) ⇒ Array<(SubscriptionChargePagedMetadata, Fixnum, Hash)>

Creates a charge on the specified invoice. to invoice&quot;,&quot;response&quot;:&quot;addChargeToInvoice.html&quot;,&quot;request&quot;:&quot;addChargeToInvoiceRequest.html&quot;

Parameters:

  • invoice_id —

    ID of the invoice.

  • charge —

    The charge request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 40

def add_charge_to_invoice_with_http_info(invoice_id, charge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.add_charge_to_invoice ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.add_charge_to_invoice"
  end
  # verify the required parameter 'charge' is set
  if @api_client.config.client_side_validation && charge.nil?
    fail ArgumentError, "Missing the required parameter 'charge' when calling InvoicesApi.add_charge_to_invoice"
  end
  # resource path
  local_var_path = "/invoices/{invoice-ID}/charges".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(charge)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionChargePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#add_charge_to_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#aggregate_invoices(request, opts = {}) ⇒ InvoicePagedMetadata

Aggregate Invoices into to one parent Invoice invoices","response":"AggregateResponse.html","request":"AggregateRequest.html"

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 89

def aggregate_invoices(request, opts = {})
  data, _status_code, _headers = aggregate_invoices_with_http_info(request, opts)
  return data
end

#aggregate_invoices_with_http_info(request, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Aggregate Invoices into to one parent Invoice invoices&quot;,&quot;response&quot;:&quot;AggregateResponse.html&quot;,&quot;request&quot;:&quot;AggregateRequest.html&quot;

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



99
100
101
102
103
104
105
106
107
108
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
136
137
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 99

def aggregate_invoices_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.aggregate_invoices ..."
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling InvoicesApi.aggregate_invoices"
  end
  # resource path
  local_var_path = "/invoices/aggregate"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#aggregate_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#execute_invoice(invoice_id, request, opts = {}) ⇒ InvoicePagedMetadata

Attempt payment for the outstanding value of an invoice invoice","response":"executeInvoiceResponse.html","request":"ExecuteInvoiceRequest.html"

Parameters:

  • invoice_id
  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 145

def execute_invoice(invoice_id, request, opts = {})
  data, _status_code, _headers = execute_invoice_with_http_info(invoice_id, request, opts)
  return data
end

#execute_invoice_with_http_info(invoice_id, request, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Attempt payment for the outstanding value of an invoice invoice&quot;,&quot;response&quot;:&quot;executeInvoiceResponse.html&quot;,&quot;request&quot;:&quot;ExecuteInvoiceRequest.html&quot;

Parameters:

  • invoice_id
  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



156
157
158
159
160
161
162
163
164
165
166
167
168
169
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
197
198
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 156

def execute_invoice_with_http_info(invoice_id, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.execute_invoice ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.execute_invoice"
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling InvoicesApi.execute_invoice"
  end
  # resource path
  local_var_path = "/invoices/{invoice-ID}/execute".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#execute_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_line_payments_for_all_invoices(opts = {}) ⇒ InvoiceLinePaymentPagedMetadata

Generates InvoiceLinePayments for all existing InvoicePayments. { "nickname" : "Generate InvoiceLinePayments","response" : "Generate InvoiceLinePayments.html"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



205
206
207
208
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 205

def generate_line_payments_for_all_invoices(opts = {})
  data, _status_code, _headers = generate_line_payments_for_all_invoices_with_http_info(opts)
  return data
end

#generate_line_payments_for_all_invoices_with_http_info(opts = {}) ⇒ Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>

Generates InvoiceLinePayments for all existing InvoicePayments. { &quot;nickname&quot; : &quot;Generate InvoiceLinePayments&quot;,&quot;response&quot; : &quot;Generate InvoiceLinePayments.html&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 215

def generate_line_payments_for_all_invoices_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.generate_line_payments_for_all_invoices ..."
  end
  # resource path
  local_var_path = "/invoices/generate-line-payments"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoiceLinePaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#generate_line_payments_for_all_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_invoices(opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve all invoices","response" : "getInvoiceAll.html"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return. (default to 0)

  • :records (Integer) —

    The maximum number of invoices to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

  • :exclude_children (BOOLEAN) —

    Should child invoices be excluded. (default to true)

  • :metadata (String)

Returns:



264
265
266
267
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 264

def get_all_invoices(opts = {})
  data, _status_code, _headers = get_all_invoices_with_http_info(opts)
  return data
end

#get_all_invoices_as_csv(opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve all invoices","response" : "getInvoiceAll.csv"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return. (default to 0)

  • :records (Integer) —

    The maximum number of invoices to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

Returns:



338
339
340
341
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 338

def get_all_invoices_as_csv(opts = {})
  data, _status_code, _headers = get_all_invoices_as_csv_with_http_info(opts)
  return data
end

#get_all_invoices_as_csv_with_http_info(opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve all invoices&quot;,&quot;response&quot; : &quot;getInvoiceAll.csv&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return.

  • :records (Integer) —

    The maximum number of invoices to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 353

def get_all_invoices_as_csv_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_all_invoices_as_csv ..."
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/all.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_all_invoices_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_invoices_with_http_info(opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve all invoices&quot;,&quot;response&quot; : &quot;getInvoiceAll.html&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return.

  • :records (Integer) —

    The maximum number of invoices to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

  • :exclude_children (BOOLEAN) —

    Should child invoices be excluded.

  • :metadata (String)

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 281

def get_all_invoices_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_all_invoices ..."
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
  query_params[:'exclude_children'] = opts[:'exclude_children'] if !opts[:'exclude_children'].nil?
  query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_all_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bucketed_revenue_attributions_as_csv(opts = {}) ⇒ String

Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed. { "nickname" : "(CSV) Retrieve bucketed revenue attributions","response" : "getBucketedRevenueAttributions.csv"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).

Returns:

  • (String) 


405
406
407
408
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 405

def get_bucketed_revenue_attributions_as_csv(opts = {})
  data, _status_code, _headers = get_bucketed_revenue_attributions_as_csv_with_http_info(opts)
  return data
end

#get_bucketed_revenue_attributions_as_csv_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed. { &quot;nickname&quot; : &quot;(CSV) Retrieve bucketed revenue attributions&quot;,&quot;response&quot; : &quot;getBucketedRevenueAttributions.csv&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 417

def get_bucketed_revenue_attributions_as_csv_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_bucketed_revenue_attributions_as_csv ..."
  end
  # resource path
  local_var_path = "/invoices/bucketed-revenue-attributions.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
  query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_bucketed_revenue_attributions_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_charges_on_invoice(invoice_id, opts = {}) ⇒ SubscriptionChargePagedMetadata

Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order. on invoice","response":"getChargesInvoice.html"

Parameters:

  • invoice_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first subscription to return. (default to 0)

  • :records (Integer) —

    The maximum number of subscriptions to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to id)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :state (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :type (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired subscriptions should be returned. (default to false)

Returns:



465
466
467
468
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 465

def get_charges_on_invoice(invoice_id, opts = {})
  data, _status_code, _headers = get_charges_on_invoice_with_http_info(invoice_id, opts)
  return data
end

#get_charges_on_invoice_with_http_info(invoice_id, opts = {}) ⇒ Array<(SubscriptionChargePagedMetadata, Fixnum, Hash)>

Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order. on invoice&quot;,&quot;response&quot;:&quot;getChargesInvoice.html&quot;

Parameters:

  • invoice_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first subscription to return.

  • :records (Integer) —

    The maximum number of subscriptions to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :state (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :type (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired subscriptions should be returned.

Returns:



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 483

def get_charges_on_invoice_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_charges_on_invoice ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.get_charges_on_invoice"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  if @api_client.config.client_side_validation && opts[:'state'] && !['Voided', 'Pending', 'AwaitingPayment', 'Paid', 'Failed'].include?(opts[:'state'])
    fail ArgumentError, 'invalid value for "state", must be one of Voided, Pending, AwaitingPayment, Paid, Failed'
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['Setup', 'Upgrade', 'Manual', 'ProductRatePlanMigration', 'Arrears', 'Advance', 'Coupon', 'Usage', 'PricingComponent'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of Setup, Upgrade, Manual, ProductRatePlanMigration, Arrears, Advance, Coupon, Usage, PricingComponent'
  end
  # resource path
  local_var_path = "/invoices/{invoice-ID}/charges".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionChargePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_charges_on_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_invoice_line_payments_from_invoices_as_csv(opts = {}) ⇒ InvoiceLinePaymentPagedMetadata

Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. { "nickname" : "Credit InvoiceLinePayments CSV","response" : "Credit InvoiceLinePayments.csv"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24).

Returns:



547
548
549
550
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 547

def get_credit_invoice_line_payments_from_invoices_as_csv(opts = {})
  data, _status_code, _headers = get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(opts)
  return data
end

#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(opts = {}) ⇒ InvoiceLinePaymentPagedMetadata

Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. { "nickname" : "Credit InvoiceLinePayments CSV","response" : "Credit InvoiceLinePayments.csv"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24).

Returns:



605
606
607
608
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 605

def get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(opts = {})
  data, _status_code, _headers = get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(opts)
  return data
end

#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(opts = {}) ⇒ Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>

Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. { &quot;nickname&quot; : &quot;Credit InvoiceLinePayments CSV&quot;,&quot;response&quot; : &quot;Credit InvoiceLinePayments.csv&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24).

Returns:



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 617

def get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received ..."
  end
  # resource path
  local_var_path = "/invoices/payment-received/credit.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
  query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoiceLinePaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(opts = {}) ⇒ Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>

Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. { &quot;nickname&quot; : &quot;Credit InvoiceLinePayments CSV&quot;,&quot;response&quot; : &quot;Credit InvoiceLinePayments.csv&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24).

Returns:



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 559

def get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_credit_invoice_line_payments_from_invoices_as_csv ..."
  end
  # resource path
  local_var_path = "/invoices/credit.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
  query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoiceLinePaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_credit_invoice_line_payments_from_invoices_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_debit_invoice_line_payments_from_invoices_as_csv(opts = {}) ⇒ InvoiceLinePaymentPagedMetadata

Retrieves received revenue from InvoicePayments upon line items, in CSV format. { "nickname" : "Debit InvoiceLinePayments CSV","response" : "Debit InvoiceLinePayments.csv"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24).

Returns:



663
664
665
666
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 663

def get_debit_invoice_line_payments_from_invoices_as_csv(opts = {})
  data, _status_code, _headers = get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(opts)
  return data
end

#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(opts = {}) ⇒ InvoiceLinePaymentPagedMetadata

Retrieves received revenue from InvoicePayments upon line items, in CSV format. { "nickname" : "Debit InvoiceLinePayments CSV","response" : "Debit InvoiceLinePayments.csv"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24).

Returns:



721
722
723
724
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 721

def get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(opts = {})
  data, _status_code, _headers = get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(opts)
  return data
end

#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(opts = {}) ⇒ Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>

Retrieves received revenue from InvoicePayments upon line items, in CSV format. { &quot;nickname&quot; : &quot;Debit InvoiceLinePayments CSV&quot;,&quot;response&quot; : &quot;Debit InvoiceLinePayments.csv&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24).

Returns:



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 733

def get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received ..."
  end
  # resource path
  local_var_path = "/invoices/payment-received/revenue.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
  query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoiceLinePaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(opts = {}) ⇒ Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>

Retrieves received revenue from InvoicePayments upon line items, in CSV format. { &quot;nickname&quot; : &quot;Debit InvoiceLinePayments CSV&quot;,&quot;response&quot; : &quot;Debit InvoiceLinePayments.csv&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24).

Returns:



675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 675

def get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_debit_invoice_line_payments_from_invoices_as_csv ..."
  end
  # resource path
  local_var_path = "/invoices/revenue.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
  query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoiceLinePaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_debit_invoice_line_payments_from_invoices_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_as_html(id, opts = {}) ⇒ String

Retrieves a single invoice specified by the ID parameter. { "nickname" : "HTML invoice","response" : "getInvoiceByID.HTML.html"}

Parameters:

  • id —

    The ID of the invoice.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return. (default to 0)

  • :records (Integer) —

    The maximum number of invoices to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

  • :tier_breakdown (BOOLEAN) —

    Whether to provide a breakdown of charge tiering. (default to false)

  • :inclusive_end (BOOLEAN) —

    Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the &quot;period end&quot; date shown to the customer. (default to false)

  • :show_zero_cost (BOOLEAN) —

    Whether to show zero-cost lines. (default to true)

  • :show_plan_only_when_ambiguous (BOOLEAN) —

    Whether to state which plan the Invoice lines came from, regardless of whether there&#39;s only one plan involved in this Invoice. (default to true)

Returns:

  • (String) 


787
788
789
790
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 787

def get_invoice_as_html(id, opts = {})
  data, _status_code, _headers = get_invoice_as_html_with_http_info(id, opts)
  return data
end

#get_invoice_as_html_with_http_info(id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Retrieves a single invoice specified by the ID parameter. { &quot;nickname&quot; : &quot;HTML invoice&quot;,&quot;response&quot; : &quot;getInvoiceByID.HTML.html&quot;}

Parameters:

  • id —

    The ID of the invoice.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return.

  • :records (Integer) —

    The maximum number of invoices to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

  • :tier_breakdown (BOOLEAN) —

    Whether to provide a breakdown of charge tiering.

  • :inclusive_end (BOOLEAN) —

    Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the &quot;period end&quot; date shown to the customer.

  • :show_zero_cost (BOOLEAN) —

    Whether to show zero-cost lines.

  • :show_plan_only_when_ambiguous (BOOLEAN) —

    Whether to state which plan the Invoice lines came from, regardless of whether there&#39;s only one plan involved in this Invoice.

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 807

def get_invoice_as_html_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_as_html ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.get_invoice_as_html"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/{ID}.html".sub('{' + 'ID' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
  query_params[:'tier_breakdown'] = opts[:'tier_breakdown'] if !opts[:'tier_breakdown'].nil?
  query_params[:'inclusive_end'] = opts[:'inclusive_end'] if !opts[:'inclusive_end'].nil?
  query_params[:'show_zero_cost'] = opts[:'show_zero_cost'] if !opts[:'show_zero_cost'].nil?
  query_params[:'show_plan_only_when_ambiguous'] = opts[:'show_plan_only_when_ambiguous'] if !opts[:'show_plan_only_when_ambiguous'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/html'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_as_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_as_pdf(id, opts = {}) ⇒ File

Retrieves a single invoice specified by the ID parameter. { "nickname" : "PDF Invoice","response" : "getInvoiceByID.pdf"}

Parameters:

  • id —

    The ID of the invoice.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return. (default to 0)

  • :records (Integer) —

    The maximum number of invoices to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

  • :tier_breakdown (BOOLEAN) —

    Whether to provide a breakdown of charge tiering. (default to false)

  • :inclusive_end (BOOLEAN) —

    Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the &quot;period end&quot; date shown to the customer. (default to false)

  • :show_zero_cost (BOOLEAN) —

    Whether to show zero-cost lines. (default to true)

  • :show_plan_only_when_ambiguous (BOOLEAN) —

    Whether to state which plan the Invoice lines came from, regardless of whether there&#39;s only one plan involved in this Invoice. (default to true)

  • :include_footer (BOOLEAN)
  • :group_line_items_by (String)

Returns:

  • (File) 


877
878
879
880
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 877

def get_invoice_as_pdf(id, opts = {})
  data, _status_code, _headers = get_invoice_as_pdf_with_http_info(id, opts)
  return data
end

#get_invoice_as_pdf_with_http_info(id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Retrieves a single invoice specified by the ID parameter. { &quot;nickname&quot; : &quot;PDF Invoice&quot;,&quot;response&quot; : &quot;getInvoiceByID.pdf&quot;}

Parameters:

  • id —

    The ID of the invoice.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return.

  • :records (Integer) —

    The maximum number of invoices to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

  • :tier_breakdown (BOOLEAN) —

    Whether to provide a breakdown of charge tiering.

  • :inclusive_end (BOOLEAN) —

    Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the &quot;period end&quot; date shown to the customer.

  • :show_zero_cost (BOOLEAN) —

    Whether to show zero-cost lines.

  • :show_plan_only_when_ambiguous (BOOLEAN) —

    Whether to state which plan the Invoice lines came from, regardless of whether there&#39;s only one plan involved in this Invoice.

  • :include_footer (BOOLEAN)
  • :group_line_items_by (String)

Returns:

  • (Array<(File, Fixnum, Hash)>) —

    File data, response status code and response headers



899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 899

def get_invoice_as_pdf_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_as_pdf ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.get_invoice_as_pdf"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  if @api_client.config.client_side_validation && opts[:'group_line_items_by'] && !['Product', 'RatePlan', 'ProductAndRatePlan'].include?(opts[:'group_line_items_by'])
    fail ArgumentError, 'invalid value for "group_line_items_by", must be one of Product, RatePlan, ProductAndRatePlan'
  end
  # resource path
  local_var_path = "/invoices/{ID}.pdf".sub('{' + 'ID' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
  query_params[:'tier_breakdown'] = opts[:'tier_breakdown'] if !opts[:'tier_breakdown'].nil?
  query_params[:'inclusive_end'] = opts[:'inclusive_end'] if !opts[:'inclusive_end'].nil?
  query_params[:'show_zero_cost'] = opts[:'show_zero_cost'] if !opts[:'show_zero_cost'].nil?
  query_params[:'show_plan_only_when_ambiguous'] = opts[:'show_plan_only_when_ambiguous'] if !opts[:'show_plan_only_when_ambiguous'].nil?
  query_params[:'include_footer'] = opts[:'include_footer'] if !opts[:'include_footer'].nil?
  query_params[:'group_line_items_by'] = opts[:'group_line_items_by'] if !opts[:'group_line_items_by'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_as_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_by_id(invoice_id, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a single invoice specified by the invoice-ID parameter. { "nickname" : "Retrieve an existing invoice","response" : "getInvoiceByID.html"}

Parameters:

  • invoice_id —

    The ID of the invoice.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return. (default to 0)

  • :records (Integer) —

    The maximum number of invoices to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

  • :exclude_children (BOOLEAN) —

    Should child invoices be excluded. (default to true)

Returns:



969
970
971
972
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 969

def get_invoice_by_id(invoice_id, opts = {})
  data, _status_code, _headers = get_invoice_by_id_with_http_info(invoice_id, opts)
  return data
end

#get_invoice_by_id_as_csv(id, opts = {}) ⇒ String

Retrieves a single invoice specified by the ID parameter. { "nickname" : "CSV invoice","response" : "getInvoiceByID.csv"}

Parameters:

  • id —

    The ID of the invoice.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (String) 


1042
1043
1044
1045
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1042

def get_invoice_by_id_as_csv(id, opts = {})
  data, _status_code, _headers = get_invoice_by_id_as_csv_with_http_info(id, opts)
  return data
end

#get_invoice_by_id_as_csv_with_http_info(id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Retrieves a single invoice specified by the ID parameter. { &quot;nickname&quot; : &quot;CSV invoice&quot;,&quot;response&quot; : &quot;getInvoiceByID.csv&quot;}

Parameters:

  • id —

    The ID of the invoice.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1053

def get_invoice_by_id_as_csv_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_by_id_as_csv ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.get_invoice_by_id_as_csv"
  end
  # resource path
  local_var_path = "/invoices/{ID}.csv".sub('{' + 'ID' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_by_id_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_by_id_with_http_info(invoice_id, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a single invoice specified by the invoice-ID parameter. { &quot;nickname&quot; : &quot;Retrieve an existing invoice&quot;,&quot;response&quot; : &quot;getInvoiceByID.html&quot;}

Parameters:

  • invoice_id —

    The ID of the invoice.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return.

  • :records (Integer) —

    The maximum number of invoices to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

  • :exclude_children (BOOLEAN) —

    Should child invoices be excluded.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 986

def get_invoice_by_id_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_by_id ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.get_invoice_by_id"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/{invoice-ID}".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
  query_params[:'exclude_children'] = opts[:'exclude_children'] if !opts[:'exclude_children'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_by_subscription_id(subscription_id, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve by subscription","response" : "getInvoiceBySubscriptionID.html"}

Parameters:

  • subscription_id —

    ID of the subscription.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return. (default to 0)

  • :records (Integer) —

    The maximum number of invoices to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

  • :exclude_children (BOOLEAN) —

    Should child invoices be excluded. (default to true)

Returns:



1106
1107
1108
1109
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1106

def get_invoice_by_subscription_id(subscription_id, opts = {})
  data, _status_code, _headers = get_invoice_by_subscription_id_with_http_info(subscription_id, opts)
  return data
end

#get_invoice_by_subscription_id_with_http_info(subscription_id, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve by subscription&quot;,&quot;response&quot; : &quot;getInvoiceBySubscriptionID.html&quot;}

Parameters:

  • subscription_id —

    ID of the subscription.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return.

  • :records (Integer) —

    The maximum number of invoices to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

  • :exclude_children (BOOLEAN) —

    Should child invoices be excluded.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1123

def get_invoice_by_subscription_id_with_http_info(subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_by_subscription_id ..."
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling InvoicesApi.get_invoice_by_subscription_id"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/subscription/{subscription-ID}".sub('{' + 'subscription-ID' + '}', subscription_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
  query_params[:'exclude_children'] = opts[:'exclude_children'] if !opts[:'exclude_children'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_by_subscription_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_by_subscription_version_id(subscription_version_id, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve by subscription version","response" : "getInvoiceBySubscriptionVersionID.html"}

Parameters:

  • subscription_version_id —

    Version ID of the subscription.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return. (default to 0)

  • :records (Integer) —

    The maximum number of invoices to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

  • :exclude_children (BOOLEAN) —

    Should child invoices be excluded. (default to true)

Returns:



1185
1186
1187
1188
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1185

def get_invoice_by_subscription_version_id(subscription_version_id, opts = {})
  data, _status_code, _headers = get_invoice_by_subscription_version_id_with_http_info(subscription_version_id, opts)
  return data
end

#get_invoice_by_subscription_version_id_with_http_info(subscription_version_id, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve by subscription version&quot;,&quot;response&quot; : &quot;getInvoiceBySubscriptionVersionID.html&quot;}

Parameters:

  • subscription_version_id —

    Version ID of the subscription.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return.

  • :records (Integer) —

    The maximum number of invoices to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

  • :exclude_children (BOOLEAN) —

    Should child invoices be excluded.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1202

def get_invoice_by_subscription_version_id_with_http_info(subscription_version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_by_subscription_version_id ..."
  end
  # verify the required parameter 'subscription_version_id' is set
  if @api_client.config.client_side_validation && subscription_version_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_version_id' when calling InvoicesApi.get_invoice_by_subscription_version_id"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/subscription/version/{subscription-version-ID}".sub('{' + 'subscription-version-ID' + '}', subscription_version_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
  query_params[:'exclude_children'] = opts[:'exclude_children'] if !opts[:'exclude_children'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_by_subscription_version_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_by_version_id(version_id, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a single invoice, specified by the version-ID parameter. { "nickname" : "Retrieve by version","response" : "getInvoiceByVersionID.html"}

Parameters:

  • version_id —

    The version-ID of the invoice.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



1258
1259
1260
1261
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1258

def get_invoice_by_version_id(version_id, opts = {})
  data, _status_code, _headers = get_invoice_by_version_id_with_http_info(version_id, opts)
  return data
end

#get_invoice_by_version_id_with_http_info(version_id, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a single invoice, specified by the version-ID parameter. { &quot;nickname&quot; : &quot;Retrieve by version&quot;,&quot;response&quot; : &quot;getInvoiceByVersionID.html&quot;}

Parameters:

  • version_id —

    The version-ID of the invoice.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1269

def get_invoice_by_version_id_with_http_info(version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_by_version_id ..."
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling InvoicesApi.get_invoice_by_version_id"
  end
  # resource path
  local_var_path = "/invoices/version/{version-ID}".sub('{' + 'version-ID' + '}', version_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_by_version_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoices_by_account_id(account_id, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve by account","response" : "getInvoiceByAccountID.html"}

Parameters:

  • account_id —

    ID of the account.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return. (default to 0)

  • :records (Integer) —

    The maximum number of invoices to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

  • :exclude_children (BOOLEAN) —

    Should child invoices be excluded. (default to true)

Returns:



1322
1323
1324
1325
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1322

def (, opts = {})
  data, _status_code, _headers = (, opts)
  return data
end

#get_invoices_by_account_id_with_http_info(account_id, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve by account&quot;,&quot;response&quot; : &quot;getInvoiceByAccountID.html&quot;}

Parameters:

  • account_id —

    ID of the account.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first invoice to return.

  • :records (Integer) —

    The maximum number of invoices to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

  • :exclude_children (BOOLEAN) —

    Should child invoices be excluded.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1339

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_account_id ..."
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling InvoicesApi.get_invoices_by_account_id"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/account/{account-ID}".sub('{' + 'account-ID' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
  query_params[:'exclude_children'] = opts[:'exclude_children'] if !opts[:'exclude_children'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_account_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoices_by_period_end(lower_threshold, upper_threshold, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve by period-end","response" : "getInvoiceByPeriodEnd.html"}

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first taxation-link to return. (default to 0)

  • :records (Integer) —

    The maximum number of taxation-links to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

Returns:



1401
1402
1403
1404
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1401

def get_invoices_by_period_end(lower_threshold, upper_threshold, opts = {})
  data, _status_code, _headers = get_invoices_by_period_end_with_http_info(lower_threshold, upper_threshold, opts)
  return data
end

#get_invoices_by_period_end_with_http_info(lower_threshold, upper_threshold, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve by period-end&quot;,&quot;response&quot; : &quot;getInvoiceByPeriodEnd.html&quot;}

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first taxation-link to return.

  • :records (Integer) —

    The maximum number of taxation-links to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1418

def get_invoices_by_period_end_with_http_info(lower_threshold, upper_threshold, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_period_end ..."
  end
  # verify the required parameter 'lower_threshold' is set
  if @api_client.config.client_side_validation && lower_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling InvoicesApi.get_invoices_by_period_end"
  end
  # verify the required parameter 'upper_threshold' is set
  if @api_client.config.client_side_validation && upper_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling InvoicesApi.get_invoices_by_period_end"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/period-end/{lower-threshold}/{upper-threshold}".sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_period_end\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoices_by_period_start(lower_threshold, upper_threshold, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve by period-start","response" : "getInvoiceByPeriodStart.html"}

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first taxation-link to return. (default to 0)

  • :records (Integer) —

    The maximum number of taxation-links to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

Returns:



1483
1484
1485
1486
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1483

def get_invoices_by_period_start(lower_threshold, upper_threshold, opts = {})
  data, _status_code, _headers = get_invoices_by_period_start_with_http_info(lower_threshold, upper_threshold, opts)
  return data
end

#get_invoices_by_period_start_as_csv(lower_threshold, upper_threshold, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve by period-start","response" : "getInvoiceByPeriodStart.csv"}

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first taxation-link to return. (default to 0)

  • :records (Integer) —

    The maximum number of taxation-links to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

Returns:



1565
1566
1567
1568
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1565

def get_invoices_by_period_start_as_csv(lower_threshold, upper_threshold, opts = {})
  data, _status_code, _headers = get_invoices_by_period_start_as_csv_with_http_info(lower_threshold, upper_threshold, opts)
  return data
end

#get_invoices_by_period_start_as_csv_with_http_info(lower_threshold, upper_threshold, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve by period-start&quot;,&quot;response&quot; : &quot;getInvoiceByPeriodStart.csv&quot;}

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first taxation-link to return.

  • :records (Integer) —

    The maximum number of taxation-links to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1582

def get_invoices_by_period_start_as_csv_with_http_info(lower_threshold, upper_threshold, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_period_start_as_csv ..."
  end
  # verify the required parameter 'lower_threshold' is set
  if @api_client.config.client_side_validation && lower_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling InvoicesApi.get_invoices_by_period_start_as_csv"
  end
  # verify the required parameter 'upper_threshold' is set
  if @api_client.config.client_side_validation && upper_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling InvoicesApi.get_invoices_by_period_start_as_csv"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/period-start/{lower-threshold}/{upper-threshold}.csv".sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_period_start_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoices_by_period_start_with_http_info(lower_threshold, upper_threshold, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve by period-start&quot;,&quot;response&quot; : &quot;getInvoiceByPeriodStart.html&quot;}

Parameters:

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first taxation-link to return.

  • :records (Integer) —

    The maximum number of taxation-links to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1500

def get_invoices_by_period_start_with_http_info(lower_threshold, upper_threshold, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_period_start ..."
  end
  # verify the required parameter 'lower_threshold' is set
  if @api_client.config.client_side_validation && lower_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling InvoicesApi.get_invoices_by_period_start"
  end
  # verify the required parameter 'upper_threshold' is set
  if @api_client.config.client_side_validation && upper_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling InvoicesApi.get_invoices_by_period_start"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/period-start/{lower-threshold}/{upper-threshold}".sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_period_start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoices_by_state(state, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve by state","response" : "getInvoiceByState.html"}

Parameters:

  • state —

    The current state of the invoice, either Paid, Pending, Unpaid or Voided.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first subscription to return. (default to 0)

  • :records (Integer) —

    The maximum number of subscriptions to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to ID)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

Returns:



1646
1647
1648
1649
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1646

def get_invoices_by_state(state, opts = {})
  data, _status_code, _headers = get_invoices_by_state_with_http_info(state, opts)
  return data
end

#get_invoices_by_state_and_period_start(state, lower_threshold, upper_threshold, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve by state and period-start","response" : "getInvoiceByStateAndPeriodStart.html"}

Parameters:

  • state —

    The current state of the invoice, either Paid, Pending, Unpaid or Voided.

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first taxation-link to return. (default to 0)

  • :records (Integer) —

    The maximum number of taxation-links to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

Returns:



1736
1737
1738
1739
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1736

def get_invoices_by_state_and_period_start(state, lower_threshold, upper_threshold, opts = {})
  data, _status_code, _headers = get_invoices_by_state_and_period_start_with_http_info(state, lower_threshold, upper_threshold, opts)
  return data
end

#get_invoices_by_state_and_period_start_as_csv(state, lower_threshold, upper_threshold, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve by state and period-start","response" : "getInvoiceByStateAndPeriodStart.csv"}

Parameters:

  • state —

    The current state of the invoice, either Paid, Pending, Unpaid or Voided.

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first taxation-link to return. (default to 0)

  • :records (Integer) —

    The maximum number of taxation-links to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

Returns:



1828
1829
1830
1831
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1828

def get_invoices_by_state_and_period_start_as_csv(state, lower_threshold, upper_threshold, opts = {})
  data, _status_code, _headers = get_invoices_by_state_and_period_start_as_csv_with_http_info(state, lower_threshold, upper_threshold, opts)
  return data
end

#get_invoices_by_state_and_period_start_as_csv_with_http_info(state, lower_threshold, upper_threshold, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve by state and period-start&quot;,&quot;response&quot; : &quot;getInvoiceByStateAndPeriodStart.csv&quot;}

Parameters:

  • state —

    The current state of the invoice, either Paid, Pending, Unpaid or Voided.

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first taxation-link to return.

  • :records (Integer) —

    The maximum number of taxation-links to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1846

def get_invoices_by_state_and_period_start_as_csv_with_http_info(state, lower_threshold, upper_threshold, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_state_and_period_start_as_csv ..."
  end
  # verify the required parameter 'state' is set
  if @api_client.config.client_side_validation && state.nil?
    fail ArgumentError, "Missing the required parameter 'state' when calling InvoicesApi.get_invoices_by_state_and_period_start_as_csv"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Paid', 'Unpaid', 'Pending', 'Voided'].include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of Paid, Unpaid, Pending, Voided"
  end
  # verify the required parameter 'lower_threshold' is set
  if @api_client.config.client_side_validation && lower_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling InvoicesApi.get_invoices_by_state_and_period_start_as_csv"
  end
  # verify the required parameter 'upper_threshold' is set
  if @api_client.config.client_side_validation && upper_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling InvoicesApi.get_invoices_by_state_and_period_start_as_csv"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv".sub('{' + 'state' + '}', state.to_s).sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_state_and_period_start_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoices_by_state_and_period_start_with_http_info(state, lower_threshold, upper_threshold, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve by state and period-start&quot;,&quot;response&quot; : &quot;getInvoiceByStateAndPeriodStart.html&quot;}

Parameters:

  • state —

    The current state of the invoice, either Paid, Pending, Unpaid or Voided.

  • lower_threshold —

    The UTC DateTime specifying the start of the result period.

  • upper_threshold —

    The UTC DateTime specifying the end of the result period.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first taxation-link to return.

  • :records (Integer) —

    The maximum number of taxation-links to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1754

def get_invoices_by_state_and_period_start_with_http_info(state, lower_threshold, upper_threshold, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_state_and_period_start ..."
  end
  # verify the required parameter 'state' is set
  if @api_client.config.client_side_validation && state.nil?
    fail ArgumentError, "Missing the required parameter 'state' when calling InvoicesApi.get_invoices_by_state_and_period_start"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Paid', 'Unpaid', 'Pending', 'Voided'].include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of Paid, Unpaid, Pending, Voided"
  end
  # verify the required parameter 'lower_threshold' is set
  if @api_client.config.client_side_validation && lower_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling InvoicesApi.get_invoices_by_state_and_period_start"
  end
  # verify the required parameter 'upper_threshold' is set
  if @api_client.config.client_side_validation && upper_threshold.nil?
    fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling InvoicesApi.get_invoices_by_state_and_period_start"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}".sub('{' + 'state' + '}', state.to_s).sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_state_and_period_start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoices_by_state_as_csv(state, opts = {}) ⇒ InvoicePagedMetadata

Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Retrieve by state","response" : "getInvoiceByState.csv"}

Parameters:

  • state —

    The current state of the invoice, either Paid, Pending, Unpaid or Voided.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first subscription to return. (default to 0)

  • :records (Integer) —

    The maximum number of subscriptions to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to ID)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to false)

Returns:



1918
1919
1920
1921
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1918

def get_invoices_by_state_as_csv(state, opts = {})
  data, _status_code, _headers = get_invoices_by_state_as_csv_with_http_info(state, opts)
  return data
end

#get_invoices_by_state_as_csv_with_http_info(state, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve by state&quot;,&quot;response&quot; : &quot;getInvoiceByState.csv&quot;}

Parameters:

  • state —

    The current state of the invoice, either Paid, Pending, Unpaid or Voided.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first subscription to return.

  • :records (Integer) —

    The maximum number of subscriptions to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1934

def get_invoices_by_state_as_csv_with_http_info(state, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_state_as_csv ..."
  end
  # verify the required parameter 'state' is set
  if @api_client.config.client_side_validation && state.nil?
    fail ArgumentError, "Missing the required parameter 'state' when calling InvoicesApi.get_invoices_by_state_as_csv"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Paid', 'Unpaid', 'Pending', 'Voided'].include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of Paid, Unpaid, Pending, Voided"
  end
  if @api_client.config.client_side_validation && state.length > 2147483647
    fail ArgumentError, 'invalid value for "state" when calling InvoicesApi.get_invoices_by_state_as_csv, number of items must be less than or equal to 2147483647.'
  end

  if @api_client.config.client_side_validation && state.length < 5
    fail ArgumentError, 'invalid value for "state" when calling InvoicesApi.get_invoices_by_state_as_csv, number of items must be greater than or equal to 5.'
  end

  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/state/{state}.csv".sub('{' + 'state' + '}', state.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_state_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoices_by_state_with_http_info(state, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Retrieve by state&quot;,&quot;response&quot; : &quot;getInvoiceByState.html&quot;}

Parameters:

  • state —

    The current state of the invoice, either Paid, Pending, Unpaid or Voided.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first subscription to return.

  • :records (Integer) —

    The maximum number of subscriptions to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 1662

def get_invoices_by_state_with_http_info(state, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_state ..."
  end
  # verify the required parameter 'state' is set
  if @api_client.config.client_side_validation && state.nil?
    fail ArgumentError, "Missing the required parameter 'state' when calling InvoicesApi.get_invoices_by_state"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Paid', 'Unpaid', 'Pending', 'Voided'].include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of Paid, Unpaid, Pending, Voided"
  end
  if @api_client.config.client_side_validation && state.length > 2147483647
    fail ArgumentError, 'invalid value for "state" when calling InvoicesApi.get_invoices_by_state, number of items must be less than or equal to 2147483647.'
  end

  if @api_client.config.client_side_validation && state.length < 5
    fail ArgumentError, 'invalid value for "state" when calling InvoicesApi.get_invoices_by_state, number of items must be greater than or equal to 5.'
  end

  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/invoices/state/{state}".sub('{' + 'state' + '}', state.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_line_payments(opts = {}) ⇒ InvoiceLinePaymentPagedMetadata

Retrieves all InvoiceLine payment attributions. { "nickname" : "Retrieve InvoiceLine payment attributions","response" : "getInvoiceLinePayments.html"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24).

  • :include_gateway (Array<String>) —

    Include attributions only from payments made via these payment gateways. Takes precedence over &#x60;exclude_gateway&#x60; param (if both are provided).

  • :exclude_gateway (Array<String>) —

    Include attributions from payments made via all payment gateways, except these.

Returns:



2004
2005
2006
2007
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2004

def get_line_payments(opts = {})
  data, _status_code, _headers = get_line_payments_with_http_info(opts)
  return data
end

#get_line_payments_as_csv(opts = {}) ⇒ InvoiceLinePaymentPagedMetadata

Retrieves (as CSV) all InvoiceLine payment attributions. { "nickname" : "(CSV) Retrieve InvoiceLine payment attributions","response" : "getInvoiceLinePayments.csv"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24).

  • :include_gateway (Array<String>) —

    Include attributions only from payments made via these payment gateways. Takes precedence over &#x60;exclude_gateway&#x60; param (if both are provided).

  • :exclude_gateway (Array<String>) —

    Include attributions from payments made via all payment gateways, except these.

Returns:



2070
2071
2072
2073
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2070

def get_line_payments_as_csv(opts = {})
  data, _status_code, _headers = get_line_payments_as_csv_with_http_info(opts)
  return data
end

#get_line_payments_as_csv_with_http_info(opts = {}) ⇒ Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>

Retrieves (as CSV) all InvoiceLine payment attributions. { &quot;nickname&quot; : &quot;(CSV) Retrieve InvoiceLine payment attributions&quot;,&quot;response&quot; : &quot;getInvoiceLinePayments.csv&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24).

  • :include_gateway (Array<String>) —

    Include attributions only from payments made via these payment gateways. Takes precedence over &#x60;exclude_gateway&#x60; param (if both are provided).

  • :exclude_gateway (Array<String>) —

    Include attributions from payments made via all payment gateways, except these.

Returns:



2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2084

def get_line_payments_as_csv_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_line_payments_as_csv ..."
  end
  if @api_client.config.client_side_validation && opts[:'include_gateway'] && !opts[:'include_gateway'].all?{|item| ['cybersource_token', 'card_vault', 'paypal_simple', 'locustworld', 'free', 'coupon', 'credit_note', 'stripe', 'braintree', 'balanced', 'paypal', 'billforward_test', 'offline', 'trial', 'stripeACH', 'authorizeNet', 'spreedly', 'sagePay', 'trustCommerce', 'payvision', 'kash'].include?(item)}
    fail ArgumentError, 'invalid value for "include_gateway", must include one of cybersource_token, card_vault, paypal_simple, locustworld, free, coupon, credit_note, stripe, braintree, balanced, paypal, billforward_test, offline, trial, stripeACH, authorizeNet, spreedly, sagePay, trustCommerce, payvision, kash'
  end
  if @api_client.config.client_side_validation && opts[:'exclude_gateway'] && !opts[:'exclude_gateway'].all?{|item| ['cybersource_token', 'card_vault', 'paypal_simple', 'locustworld', 'free', 'coupon', 'credit_note', 'stripe', 'braintree', 'balanced', 'paypal', 'billforward_test', 'offline', 'trial', 'stripeACH', 'authorizeNet', 'spreedly', 'sagePay', 'trustCommerce', 'payvision', 'kash'].include?(item)}
    fail ArgumentError, 'invalid value for "exclude_gateway", must include one of cybersource_token, card_vault, paypal_simple, locustworld, free, coupon, credit_note, stripe, braintree, balanced, paypal, billforward_test, offline, trial, stripeACH, authorizeNet, spreedly, sagePay, trustCommerce, payvision, kash'
  end
  # resource path
  local_var_path = "/invoices/line-payments.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
  query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
  query_params[:'include_gateway'] = @api_client.build_collection_param(opts[:'include_gateway'], :multi) if !opts[:'include_gateway'].nil?
  query_params[:'exclude_gateway'] = @api_client.build_collection_param(opts[:'exclude_gateway'], :multi) if !opts[:'exclude_gateway'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoiceLinePaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_line_payments_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_line_payments_with_http_info(opts = {}) ⇒ Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>

Retrieves all InvoiceLine payment attributions. { &quot;nickname&quot; : &quot;Retrieve InvoiceLine payment attributions&quot;,&quot;response&quot; : &quot;getInvoiceLinePayments.html&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24).

  • :include_gateway (Array<String>) —

    Include attributions only from payments made via these payment gateways. Takes precedence over &#x60;exclude_gateway&#x60; param (if both are provided).

  • :exclude_gateway (Array<String>) —

    Include attributions from payments made via all payment gateways, except these.

Returns:



2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2018

def get_line_payments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_line_payments ..."
  end
  if @api_client.config.client_side_validation && opts[:'include_gateway'] && !opts[:'include_gateway'].all?{|item| ['cybersource_token', 'card_vault', 'paypal_simple', 'locustworld', 'free', 'coupon', 'credit_note', 'stripe', 'braintree', 'balanced', 'paypal', 'billforward_test', 'offline', 'trial', 'stripeACH', 'authorizeNet', 'spreedly', 'sagePay', 'trustCommerce', 'payvision', 'kash'].include?(item)}
    fail ArgumentError, 'invalid value for "include_gateway", must include one of cybersource_token, card_vault, paypal_simple, locustworld, free, coupon, credit_note, stripe, braintree, balanced, paypal, billforward_test, offline, trial, stripeACH, authorizeNet, spreedly, sagePay, trustCommerce, payvision, kash'
  end
  if @api_client.config.client_side_validation && opts[:'exclude_gateway'] && !opts[:'exclude_gateway'].all?{|item| ['cybersource_token', 'card_vault', 'paypal_simple', 'locustworld', 'free', 'coupon', 'credit_note', 'stripe', 'braintree', 'balanced', 'paypal', 'billforward_test', 'offline', 'trial', 'stripeACH', 'authorizeNet', 'spreedly', 'sagePay', 'trustCommerce', 'payvision', 'kash'].include?(item)}
    fail ArgumentError, 'invalid value for "exclude_gateway", must include one of cybersource_token, card_vault, paypal_simple, locustworld, free, coupon, credit_note, stripe, braintree, balanced, paypal, billforward_test, offline, trial, stripeACH, authorizeNet, spreedly, sagePay, trustCommerce, payvision, kash'
  end
  # resource path
  local_var_path = "/invoices/line-payments"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
  query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
  query_params[:'include_gateway'] = @api_client.build_collection_param(opts[:'include_gateway'], :multi) if !opts[:'include_gateway'].nil?
  query_params[:'exclude_gateway'] = @api_client.build_collection_param(opts[:'exclude_gateway'], :multi) if !opts[:'exclude_gateway'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoiceLinePaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_line_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_metadata_for_invoice(invoice_id, opts = {}) ⇒ DynamicMetadata

Retrieve any associated metadata. metadata on invoice","request":"getInvoiceMetadataRequest.html","response":"getInvoiceMetadataResponse.html"

Parameters:

  • invoice_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



2133
2134
2135
2136
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2133

def get_metadata_for_invoice(invoice_id, opts = {})
  data, _status_code, _headers = get_metadata_for_invoice_with_http_info(invoice_id, opts)
  return data
end

#get_metadata_for_invoice_with_http_info(invoice_id, opts = {}) ⇒ Array<(DynamicMetadata, Fixnum, Hash)>

Retrieve any associated metadata. metadata on invoice&quot;,&quot;request&quot;:&quot;getInvoiceMetadataRequest.html&quot;,&quot;response&quot;:&quot;getInvoiceMetadataResponse.html&quot;

Parameters:

  • invoice_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (Array<(DynamicMetadata, Fixnum, Hash)>) —

    DynamicMetadata data, response status code and response headers



2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2144

def get_metadata_for_invoice_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_metadata_for_invoice ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.get_metadata_for_invoice"
  end
  # resource path
  local_var_path = "/invoices/{invoice-ID}/metadata".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DynamicMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_metadata_for_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_refund_invoice_line_payments_from_invoices_as_csv(opts = {}) ⇒ InvoiceLinePaymentPagedMetadata

Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. { "nickname" : "Refund InvoiceLinePayments CSV","response" : "Refund InvoiceLinePayments.csv"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24).

Returns:



2192
2193
2194
2195
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2192

def get_refund_invoice_line_payments_from_invoices_as_csv(opts = {})
  data, _status_code, _headers = get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(opts)
  return data
end

#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(opts = {}) ⇒ InvoiceLinePaymentPagedMetadata

Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. { "nickname" : "Refund InvoiceLinePayments CSV","response" : "Refund InvoiceLinePayments.csv"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24).

Returns:



2250
2251
2252
2253
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2250

def get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(opts = {})
  data, _status_code, _headers = get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(opts)
  return data
end

#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(opts = {}) ⇒ Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>

Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. { &quot;nickname&quot; : &quot;Refund InvoiceLinePayments CSV&quot;,&quot;response&quot; : &quot;Refund InvoiceLinePayments.csv&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24).

Returns:



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2262

def get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received ..."
  end
  # resource path
  local_var_path = "/invoices/payment-received/refund.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
  query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoiceLinePaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(opts = {}) ⇒ Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>

Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. { &quot;nickname&quot; : &quot;Refund InvoiceLinePayments CSV&quot;,&quot;response&quot; : &quot;Refund InvoiceLinePayments.csv&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24).

Returns:



2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2204

def get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_refund_invoice_line_payments_from_invoices_as_csv ..."
  end
  # resource path
  local_var_path = "/invoices/refund.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
  query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoiceLinePaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_refund_invoice_line_payments_from_invoices_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_revenue_attributions(opts = {}) ⇒ RevenueAttributionPagedMetadata

Retrieves all attributions of Invoice costs to Invoice lines. { "nickname" : "Retrieve revenue attributions","response" : "getRevenueAttributions.html"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).

Returns:



2308
2309
2310
2311
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2308

def get_revenue_attributions(opts = {})
  data, _status_code, _headers = get_revenue_attributions_with_http_info(opts)
  return data
end

#get_revenue_attributions_as_csv(opts = {}) ⇒ String

Retrieves (as CSV) all attributions of Invoice costs to Invoice lines. { "nickname" : "(CSV) Retrieve revenue attributions","response" : "getRevenueAttributions.csv"}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).

Returns:

  • (String) 


2362
2363
2364
2365
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2362

def get_revenue_attributions_as_csv(opts = {})
  data, _status_code, _headers = get_revenue_attributions_as_csv_with_http_info(opts)
  return data
end

#get_revenue_attributions_as_csv_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Retrieves (as CSV) all attributions of Invoice costs to Invoice lines. { &quot;nickname&quot; : &quot;(CSV) Retrieve revenue attributions&quot;,&quot;response&quot; : &quot;getRevenueAttributions.csv&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2374

def get_revenue_attributions_as_csv_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_revenue_attributions_as_csv ..."
  end
  # resource path
  local_var_path = "/invoices/revenue-attributions.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
  query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_revenue_attributions_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_revenue_attributions_with_http_info(opts = {}) ⇒ Array<(RevenueAttributionPagedMetadata, Fixnum, Hash)>

Retrieves all attributions of Invoice costs to Invoice lines. { &quot;nickname&quot; : &quot;Retrieve revenue attributions&quot;,&quot;response&quot; : &quot;getRevenueAttributions.html&quot;}

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :recognition_start (String) —

    The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).

  • :recognition_end (String) —

    The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).

Returns:



2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2320

def get_revenue_attributions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_revenue_attributions ..."
  end
  # resource path
  local_var_path = "/invoices/revenue-attributions"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
  query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RevenueAttributionPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_revenue_attributions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_swagger_for_invoice(query_string, opts = {}) ⇒ SwaggerTypeListInv

{ "nickname" : "","response" : ""}

Parameters:

  • query_string —

    The query string used to search.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The starting index of the search results. (default to 0)

  • :records (Integer) —

    The number of search results to return. (default to 10)

  • :format (String) —

    The response format, either JSON or XML. (default to JSON)

  • :wildcard (BOOLEAN) —

    Toggle if we search for full words or whether a wildcard is used. (default to false)

  • :entity (BOOLEAN) —

    Is an entity returned with the search results. (default to false)

Returns:



2420
2421
2422
2423
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2420

def get_swagger_for_invoice(query_string, opts = {})
  data, _status_code, _headers = get_swagger_for_invoice_with_http_info(query_string, opts)
  return data
end

#get_swagger_for_invoice_with_http_info(query_string, opts = {}) ⇒ Array<(SwaggerTypeListInv, Fixnum, Hash)>

{ &quot;nickname&quot; : &quot;&quot;,&quot;response&quot; : &quot;&quot;}

Parameters:

  • query_string —

    The query string used to search.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The starting index of the search results.

  • :records (Integer) —

    The number of search results to return.

  • :format (String) —

    The response format, either JSON or XML.

  • :wildcard (BOOLEAN) —

    Toggle if we search for full words or whether a wildcard is used.

  • :entity (BOOLEAN) —

    Is an entity returned with the search results.

Returns:

  • (Array<(SwaggerTypeListInv, Fixnum, Hash)>) —

    SwaggerTypeListInv data, response status code and response headers



2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2436

def get_swagger_for_invoice_with_http_info(query_string, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.get_swagger_for_invoice ..."
  end
  # verify the required parameter 'query_string' is set
  if @api_client.config.client_side_validation && query_string.nil?
    fail ArgumentError, "Missing the required parameter 'query_string' when calling InvoicesApi.get_swagger_for_invoice"
  end
  # resource path
  local_var_path = "/invoices/swagger-end-point/{query-string}".sub('{' + 'query-string' + '}', query_string.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'wildcard'] = opts[:'wildcard'] if !opts[:'wildcard'].nil?
  query_params[:'entity'] = opts[:'entity'] if !opts[:'entity'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SwaggerTypeListInv')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#get_swagger_for_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_invoice(request, opts = {}) ⇒ InvoicePagedMetadata

Import an invoice. invoice","response":"ImportInvoiceResponse.html","request":"ImportInvoiceRequest.html"

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2487
2488
2489
2490
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2487

def import_invoice(request, opts = {})
  data, _status_code, _headers = import_invoice_with_http_info(request, opts)
  return data
end

#import_invoice_with_http_info(request, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Import an invoice. invoice&quot;,&quot;response&quot;:&quot;ImportInvoiceResponse.html&quot;,&quot;request&quot;:&quot;ImportInvoiceRequest.html&quot;

Parameters:

  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2497

def import_invoice_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.import_invoice ..."
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling InvoicesApi.import_invoice"
  end
  # resource path
  local_var_path = "/invoices/import"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#import_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recalculate_invoice(invoice_id, request, opts = {}) ⇒ InvoicePagedMetadata

Re-calculate an Invoice. an invoice","response":"recalculateInvoiceResponse.html","request":"RecalculateInvoiceRequest.html"

Parameters:

  • invoice_id
  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2543
2544
2545
2546
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2543

def recalculate_invoice(invoice_id, request, opts = {})
  data, _status_code, _headers = recalculate_invoice_with_http_info(invoice_id, request, opts)
  return data
end

#recalculate_invoice_with_http_info(invoice_id, request, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Re-calculate an Invoice. an invoice&quot;,&quot;response&quot;:&quot;recalculateInvoiceResponse.html&quot;,&quot;request&quot;:&quot;RecalculateInvoiceRequest.html&quot;

Parameters:

  • invoice_id
  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2554

def recalculate_invoice_with_http_info(invoice_id, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.recalculate_invoice ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.recalculate_invoice"
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling InvoicesApi.recalculate_invoice"
  end
  # resource path
  local_var_path = "/invoices/{invoice-ID}/recalculate".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#recalculate_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_charge_from_invoice(invoice_id, charge_id, opts = {}) ⇒ SubscriptionChargePagedMetadata

Removes the specified charge from the specified Invoice. from invoice","response":"deleteChargesInvoice.html"

Parameters:

  • invoice_id
  • charge_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



2605
2606
2607
2608
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2605

def remove_charge_from_invoice(invoice_id, charge_id, opts = {})
  data, _status_code, _headers = remove_charge_from_invoice_with_http_info(invoice_id, charge_id, opts)
  return data
end

#remove_charge_from_invoice_with_http_info(invoice_id, charge_id, opts = {}) ⇒ Array<(SubscriptionChargePagedMetadata, Fixnum, Hash)>

Removes the specified charge from the specified Invoice. from invoice&quot;,&quot;response&quot;:&quot;deleteChargesInvoice.html&quot;

Parameters:

  • invoice_id
  • charge_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2617

def remove_charge_from_invoice_with_http_info(invoice_id, charge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.remove_charge_from_invoice ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.remove_charge_from_invoice"
  end
  # verify the required parameter 'charge_id' is set
  if @api_client.config.client_side_validation && charge_id.nil?
    fail ArgumentError, "Missing the required parameter 'charge_id' when calling InvoicesApi.remove_charge_from_invoice"
  end
  # resource path
  local_var_path = "/invoices/{invoice-ID}/charges/{charge-ID}".sub('{' + 'invoice-ID' + '}', invoice_id.to_s).sub('{' + 'charge-ID' + '}', charge_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionChargePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#remove_charge_from_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_metadata_from_invoice(invoice_id, opts = {}) ⇒ DynamicMetadata

Remove any associated metadata. metadata from invoice","request" :"deleteInvoiceMetadataRequest.html","response":"deleteInvoiceMetadataResponse.html"

Parameters:

  • invoice_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



2668
2669
2670
2671
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2668

def remove_metadata_from_invoice(invoice_id, opts = {})
  data, _status_code, _headers = remove_metadata_from_invoice_with_http_info(invoice_id, opts)
  return data
end

#remove_metadata_from_invoice_with_http_info(invoice_id, opts = {}) ⇒ Array<(DynamicMetadata, Fixnum, Hash)>

Remove any associated metadata. metadata from invoice&quot;,&quot;request&quot; :&quot;deleteInvoiceMetadataRequest.html&quot;,&quot;response&quot;:&quot;deleteInvoiceMetadataResponse.html&quot;

Parameters:

  • invoice_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (Array<(DynamicMetadata, Fixnum, Hash)>) —

    DynamicMetadata data, response status code and response headers



2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2679

def remove_metadata_from_invoice_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.remove_metadata_from_invoice ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.remove_metadata_from_invoice"
  end
  # resource path
  local_var_path = "/invoices/{invoice-ID}/metadata".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DynamicMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#remove_metadata_from_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_metadata_for_invoice(metadata, invoice_id, opts = {}) ⇒ DynamicMetadata

Remove any existing metadata keys and create the provided data. metadata on invoice","request":"setInvoiceMetadataRequest.html","response":"setInvoiceMetadataResponse.html"

Parameters:

  • metadata
  • invoice_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



2727
2728
2729
2730
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2727

def set_metadata_for_invoice(metadata, invoice_id, opts = {})
  data, _status_code, _headers = set_metadata_for_invoice_with_http_info(metadata, invoice_id, opts)
  return data
end

#set_metadata_for_invoice_with_http_info(metadata, invoice_id, opts = {}) ⇒ Array<(DynamicMetadata, Fixnum, Hash)>

Remove any existing metadata keys and create the provided data. metadata on invoice&quot;,&quot;request&quot;:&quot;setInvoiceMetadataRequest.html&quot;,&quot;response&quot;:&quot;setInvoiceMetadataResponse.html&quot;

Parameters:

  • metadata
  • invoice_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (Array<(DynamicMetadata, Fixnum, Hash)>) —

    DynamicMetadata data, response status code and response headers



2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2739

def set_metadata_for_invoice_with_http_info(metadata, invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.set_metadata_for_invoice ..."
  end
  # verify the required parameter 'metadata' is set
  if @api_client.config.client_side_validation && metadata.nil?
    fail ArgumentError, "Missing the required parameter 'metadata' when calling InvoicesApi.set_metadata_for_invoice"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.set_metadata_for_invoice"
  end
  # resource path
  local_var_path = "/invoices/{invoice-ID}/metadata".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(metadata)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DynamicMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#set_metadata_for_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_invoice(invoice, opts = {}) ⇒ InvoicePagedMetadata

Update an Invoice. an invoice","response":"updateInvoiceResponse.html","request":"updateInvoiceRequest.html"

Parameters:

  • invoice —

    The invoice object to be updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2789
2790
2791
2792
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2789

def update_invoice(invoice, opts = {})
  data, _status_code, _headers = update_invoice_with_http_info(invoice, opts)
  return data
end

#update_invoice_with_http_info(invoice, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Update an Invoice. an invoice&quot;,&quot;response&quot;:&quot;updateInvoiceResponse.html&quot;,&quot;request&quot;:&quot;updateInvoiceRequest.html&quot;

Parameters:

  • invoice —

    The invoice object to be updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2799

def update_invoice_with_http_info(invoice, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.update_invoice ..."
  end
  # verify the required parameter 'invoice' is set
  if @api_client.config.client_side_validation && invoice.nil?
    fail ArgumentError, "Missing the required parameter 'invoice' when calling InvoicesApi.update_invoice"
  end
  # resource path
  local_var_path = "/invoices"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(invoice)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#update_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upsert_metadata_for_invoice(metadata, invoice_id, opts = {}) ⇒ DynamicMetadata

Update any existing metadata key-values and insert any new key-values, no keys will be removed. metadata on invoice","request":"upsertInvoiceMetadataRequest.html","response":"upsertInvoiceMetadataResponse.html"

Parameters:

  • metadata
  • invoice_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



2846
2847
2848
2849
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2846

def upsert_metadata_for_invoice(metadata, invoice_id, opts = {})
  data, _status_code, _headers = upsert_metadata_for_invoice_with_http_info(metadata, invoice_id, opts)
  return data
end

#upsert_metadata_for_invoice_with_http_info(metadata, invoice_id, opts = {}) ⇒ Array<(DynamicMetadata, Fixnum, Hash)>

Update any existing metadata key-values and insert any new key-values, no keys will be removed. metadata on invoice&quot;,&quot;request&quot;:&quot;upsertInvoiceMetadataRequest.html&quot;,&quot;response&quot;:&quot;upsertInvoiceMetadataResponse.html&quot;

Parameters:

  • metadata
  • invoice_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (Array<(DynamicMetadata, Fixnum, Hash)>) —

    DynamicMetadata data, response status code and response headers



2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2858

def upsert_metadata_for_invoice_with_http_info(metadata, invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.upsert_metadata_for_invoice ..."
  end
  # verify the required parameter 'metadata' is set
  if @api_client.config.client_side_validation && metadata.nil?
    fail ArgumentError, "Missing the required parameter 'metadata' when calling InvoicesApi.upsert_metadata_for_invoice"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.upsert_metadata_for_invoice"
  end
  # resource path
  local_var_path = "/invoices/{invoice-ID}/metadata".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(metadata)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DynamicMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#upsert_metadata_for_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#void_invoice(invoice_id, organizations, opts = {}) ⇒ InvoicePagedMetadata

Voids the invoice specified by the invoice identifier parameter. { "nickname" : "Void an invoice","response" : "voidInvoice.html"}

Parameters:

  • invoice_id —

    ID of the invoice.

  • organizations —

    A list of organization-IDs used to restrict the scope of API calls.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2909
2910
2911
2912
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2909

def void_invoice(invoice_id, organizations, opts = {})
  data, _status_code, _headers = void_invoice_with_http_info(invoice_id, organizations, opts)
  return data
end

#void_invoice_with_http_info(invoice_id, organizations, opts = {}) ⇒ Array<(InvoicePagedMetadata, Fixnum, Hash)>

Voids the invoice specified by the invoice identifier parameter. { &quot;nickname&quot; : &quot;Void an invoice&quot;,&quot;response&quot; : &quot;voidInvoice.html&quot;}

Parameters:

  • invoice_id —

    ID of the invoice.

  • organizations —

    A list of organization-IDs used to restrict the scope of API calls.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InvoicePagedMetadata, Fixnum, Hash)>) —

    InvoicePagedMetadata data, response status code and response headers



2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
 
# File 'lib/bf_ruby2/api/invoices_api.rb', line 2920

def void_invoice_with_http_info(invoice_id, organizations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvoicesApi.void_invoice ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.void_invoice"
  end
  # verify the required parameter 'organizations' is set
  if @api_client.config.client_side_validation && organizations.nil?
    fail ArgumentError, "Missing the required parameter 'organizations' when calling InvoicesApi.void_invoice"
  end
  # resource path
  local_var_path = "/invoices/{invoice-ID}".sub('{' + 'invoice-ID' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(organizations, :multi)

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain', 'application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#void_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end