Class: IntegrationApi::AccountingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/integration_api/api/accounting_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountingApi

Returns a new instance of AccountingApi.



19
20
21
 
# File 'lib/integration_api/api/accounting_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/integration_api/api/accounting_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_or_update_customer(nucleus_client_id, opts = {}) ⇒ AccountingFinalResponseVO

Update/Create all customers in Nucleus for a given nucleus_client_id Update/Create all customers in Nucleus for a given nucleus_client_id

Parameters:

  • nucleus_client_id —

    nucleus_client_id

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/integration_api/api/accounting_api.rb', line 27

def create_or_update_customer(nucleus_client_id, opts = {})
  data, _status_code, _headers = create_or_update_customer_with_http_info(nucleus_client_id, opts)
  data
end

#create_or_update_customer_revenue(nucleus_customer_id, start_date, opts = {}) ⇒ AccountingFinalResponseVO

Update/Create all customers revenue in Nucleus for a given nucleus_customer_id Update/Create all customers revenue in Nucleus for a given nucleus_customer_id

Parameters:

  • nucleus_customer_id —

    nucleus_customer_id

  • start_date —

    start_date

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

    the optional parameters

Options Hash (opts):

  • :accounting_method (String) —

    accounting_method (default to accrual)

  • :end_date (DateTime) —

    end_date (default to null)

Returns:



83
84
85
86
 
# File 'lib/integration_api/api/accounting_api.rb', line 83

def create_or_update_customer_revenue(nucleus_customer_id, start_date, opts = {})
  data, _status_code, _headers = create_or_update_customer_revenue_with_http_info(nucleus_customer_id, start_date, opts)
  data
end

#create_or_update_customer_revenue_with_http_info(nucleus_customer_id, start_date, opts = {}) ⇒ Array<(AccountingFinalResponseVO, Fixnum, Hash)>

Update/Create all customers revenue in Nucleus for a given nucleus_customer_id Update/Create all customers revenue in Nucleus for a given nucleus_customer_id

Parameters:

  • nucleus_customer_id —

    nucleus_customer_id

  • start_date —

    start_date

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

    the optional parameters

Options Hash (opts):

  • :accounting_method (String) —

    accounting_method

  • :end_date (DateTime) —

    end_date

Returns:

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

    AccountingFinalResponseVO data, response status code and response headers



96
97
98
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
138
139
 
# File 'lib/integration_api/api/accounting_api.rb', line 96

def create_or_update_customer_revenue_with_http_info(nucleus_customer_id, start_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_or_update_customer_revenue ...'
  end
  # verify the required parameter 'nucleus_customer_id' is set
  if @api_client.config.client_side_validation && nucleus_customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_customer_id' when calling AccountingApi.create_or_update_customer_revenue"
  end
  # verify the required parameter 'start_date' is set
  if @api_client.config.client_side_validation && start_date.nil?
    fail ArgumentError, "Missing the required parameter 'start_date' when calling AccountingApi.create_or_update_customer_revenue"
  end
  # resource path
  local_var_path = '/accounting/customer_revenue/{nucleus_customer_id}'.sub('{' + 'nucleus_customer_id' + '}', nucleus_customer_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'start_date'] = start_date
  query_params[:'accounting_method'] = opts[:'accounting_method'] if !opts[:'accounting_method'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'AccountingFinalResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_or_update_customer_revenue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_or_update_customer_with_http_info(nucleus_client_id, opts = {}) ⇒ Array<(AccountingFinalResponseVO, Fixnum, Hash)>

Update/Create all customers in Nucleus for a given nucleus_client_id Update/Create all customers in Nucleus for a given nucleus_client_id

Parameters:

  • nucleus_client_id —

    nucleus_client_id

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

    the optional parameters

Returns:

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

    AccountingFinalResponseVO data, response status code and response headers



37
38
39
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
 
# File 'lib/integration_api/api/accounting_api.rb', line 37

def create_or_update_customer_with_http_info(nucleus_client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_or_update_customer ...'
  end
  # verify the required parameter 'nucleus_client_id' is set
  if @api_client.config.client_side_validation && nucleus_client_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_client_id' when calling AccountingApi.create_or_update_customer"
  end
  # resource path
  local_var_path = '/accounting/customer'

  # query parameters
  query_params = {}
  query_params[:'nucleus_client_id'] = nucleus_client_id

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'AccountingFinalResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_or_update_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_or_update_invoice_payment(nucleus_invoice_id, opts = {}) ⇒ AccountingFinalResponseVO

Create/Update invoice payment in Nucleus for a given nucleus_invoice_id Create/Update invoice payment in Nucleus for a given nucleus_invoice_id

Parameters:

  • nucleus_invoice_id —

    nucleus_invoice_id

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

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/integration_api/api/accounting_api.rb', line 145

def create_or_update_invoice_payment(nucleus_invoice_id, opts = {})
  data, _status_code, _headers = create_or_update_invoice_payment_with_http_info(nucleus_invoice_id, opts)
  data
end

#create_or_update_invoice_payment_with_http_info(nucleus_invoice_id, opts = {}) ⇒ Array<(AccountingFinalResponseVO, Fixnum, Hash)>

Create/Update invoice payment in Nucleus for a given nucleus_invoice_id Create/Update invoice payment in Nucleus for a given nucleus_invoice_id

Parameters:

  • nucleus_invoice_id —

    nucleus_invoice_id

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

    the optional parameters

Returns:

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

    AccountingFinalResponseVO data, response status code and response headers



155
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
 
# File 'lib/integration_api/api/accounting_api.rb', line 155

def create_or_update_invoice_payment_with_http_info(nucleus_invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_or_update_invoice_payment ...'
  end
  # verify the required parameter 'nucleus_invoice_id' is set
  if @api_client.config.client_side_validation && nucleus_invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_invoice_id' when calling AccountingApi.create_or_update_invoice_payment"
  end
  # resource path
  local_var_path = '/accounting/invoice_payment/{nucleus_invoice_id}'.sub('{' + 'nucleus_invoice_id' + '}', nucleus_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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'AccountingFinalResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_or_update_invoice_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_or_update_invoices(nucleus_customer_id, start_date, opts = {}) ⇒ AccountingFinalResponseVO

Update/Create all invoices in Nucleus for a given nucleus_client_id Update/Create all invoices in Nucleus for a given nucleus_client_id

Parameters:

  • nucleus_customer_id —

    nucleus_customer_id

  • start_date —

    start_date

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

    the optional parameters

Options Hash (opts):

  • :end_date (DateTime) —

    end_date (default to null)

Returns:



199
200
201
202
 
# File 'lib/integration_api/api/accounting_api.rb', line 199

def create_or_update_invoices(nucleus_customer_id, start_date, opts = {})
  data, _status_code, _headers = create_or_update_invoices_with_http_info(nucleus_customer_id, start_date, opts)
  data
end

#create_or_update_invoices_with_http_info(nucleus_customer_id, start_date, opts = {}) ⇒ Array<(AccountingFinalResponseVO, Fixnum, Hash)>

Update/Create all invoices in Nucleus for a given nucleus_client_id Update/Create all invoices in Nucleus for a given nucleus_client_id

Parameters:

  • nucleus_customer_id —

    nucleus_customer_id

  • start_date —

    start_date

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

    the optional parameters

Options Hash (opts):

  • :end_date (DateTime) —

    end_date

Returns:

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

    AccountingFinalResponseVO data, response status code and response headers



211
212
213
214
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
251
252
253
254
 
# File 'lib/integration_api/api/accounting_api.rb', line 211

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

  # query parameters
  query_params = {}
  query_params[:'nucleus_customer_id'] = nucleus_customer_id
  query_params[:'start_date'] = start_date
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'AccountingFinalResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_or_update_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_accounting_vendor_access_config_is_active_by_id(id, opts = {}) ⇒ nil

Permanently delete relation with particular accounting vendor. Permanently delete relation with particular accounting vendor.

Parameters:

  • id —

    id

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

    the optional parameters

Returns:

  • (nil) 


260
261
262
263
 
# File 'lib/integration_api/api/accounting_api.rb', line 260

def delete_accounting_vendor_access_config_is_active_by_id(id, opts = {})
  delete_accounting_vendor_access_config_is_active_by_id_with_http_info(id, opts)
  nil
end

#delete_accounting_vendor_access_config_is_active_by_id_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Permanently delete relation with particular accounting vendor. Permanently delete relation with particular accounting vendor.

Parameters:

  • id —

    id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



270
271
272
273
274
275
276
277
278
279
280
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
 
# File 'lib/integration_api/api/accounting_api.rb', line 270

def delete_accounting_vendor_access_config_is_active_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_accounting_vendor_access_config_is_active_by_id ...'
  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 AccountingApi.delete_accounting_vendor_access_config_is_active_by_id"
  end
  # resource path
  local_var_path = '/accounting/vendor/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#delete_accounting_vendor_access_config_is_active_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_accounting_stats(opts = {}) ⇒ AccountingFinalResponseVO

Get accounting stats from financial statements at the vendor for the business provided Get accounting stats from financial statements at the vendor for the business provided

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accounting_method (String) —

    accounting_method (default to accrual)

  • :nucleus_client_id (String) —

    nucleus_client_id

  • :period_length (String) —

    period_length

  • :period_month (Integer) —

    period_month

  • :period_quarter (Integer) —

    period_quarter

  • :period_type (String) —

    period_type

  • :period_year (Integer) —

    period_year

  • :report (String) —

    report

  • :statement_date (DateTime) —

    statement_date

Returns:



319
320
321
322
 
# File 'lib/integration_api/api/accounting_api.rb', line 319

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

#get_accounting_stats_with_http_info(opts = {}) ⇒ Array<(AccountingFinalResponseVO, Fixnum, Hash)>

Get accounting stats from financial statements at the vendor for the business provided Get accounting stats from financial statements at the vendor for the business provided

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accounting_method (String) —

    accounting_method

  • :nucleus_client_id (String) —

    nucleus_client_id

  • :period_length (String) —

    period_length

  • :period_month (Integer) —

    period_month

  • :period_quarter (Integer) —

    period_quarter

  • :period_type (String) —

    period_type

  • :period_year (Integer) —

    period_year

  • :report (String) —

    report

  • :statement_date (DateTime) —

    statement_date

Returns:

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

    AccountingFinalResponseVO data, response status code and response headers



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
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
 
# File 'lib/integration_api/api/accounting_api.rb', line 337

def get_accounting_stats_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_accounting_stats ...'
  end
  # resource path
  local_var_path = '/accounting/report'

  # query parameters
  query_params = {}
  query_params[:'accounting_method'] = opts[:'accounting_method'] if !opts[:'accounting_method'].nil?
  query_params[:'nucleus_client_id'] = opts[:'nucleus_client_id'] if !opts[:'nucleus_client_id'].nil?
  query_params[:'period_length'] = opts[:'period_length'] if !opts[:'period_length'].nil?
  query_params[:'period_month'] = opts[:'period_month'] if !opts[:'period_month'].nil?
  query_params[:'period_quarter'] = opts[:'period_quarter'] if !opts[:'period_quarter'].nil?
  query_params[:'period_type'] = opts[:'period_type'] if !opts[:'period_type'].nil?
  query_params[:'period_year'] = opts[:'period_year'] if !opts[:'period_year'].nil?
  query_params[:'report'] = opts[:'report'] if !opts[:'report'].nil?
  query_params[:'statement_date'] = opts[:'statement_date'] if !opts[:'statement_date'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'AccountingFinalResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_accounting_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_accounting_vendor_info_using_client_id(nucleus_client_id, opts = {}) ⇒ VendorAccessConfigVO

Get Accounting Vendor Config Get Accounting vendor config information with its status.

Parameters:

  • nucleus_client_id —

    nucleus_client_id

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

    the optional parameters

Returns:



384
385
386
387
 
# File 'lib/integration_api/api/accounting_api.rb', line 384

def get_accounting_vendor_info_using_client_id(nucleus_client_id, opts = {})
  data, _status_code, _headers = get_accounting_vendor_info_using_client_id_with_http_info(nucleus_client_id, opts)
  data
end

#get_accounting_vendor_info_using_client_id_with_http_info(nucleus_client_id, opts = {}) ⇒ Array<(VendorAccessConfigVO, Fixnum, Hash)>

Get Accounting Vendor Config Get Accounting vendor config information with its status.

Parameters:

  • nucleus_client_id —

    nucleus_client_id

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

    the optional parameters

Returns:

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

    VendorAccessConfigVO data, response status code and response headers



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/integration_api/api/accounting_api.rb', line 394

def get_accounting_vendor_info_using_client_id_with_http_info(nucleus_client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_accounting_vendor_info_using_client_id ...'
  end
  # verify the required parameter 'nucleus_client_id' is set
  if @api_client.config.client_side_validation && nucleus_client_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_client_id' when calling AccountingApi.get_accounting_vendor_info_using_client_id"
  end
  # resource path
  local_var_path = '/accounting/vendor/{nucleus_client_id}'.sub('{' + 'nucleus_client_id' + '}', nucleus_client_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'VendorAccessConfigVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_accounting_vendor_info_using_client_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_accounting_vendor_access_config_is_active_by_id(id, is_active, opts = {}) ⇒ VendorAccessConfigVO

Enable/Disable relation with particular accounting vendor. Enable/Disable link with particular accounting vendor.

Parameters:

  • id —

    id

  • is_active —

    is_active

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

    the optional parameters

Returns:



437
438
439
440
 
# File 'lib/integration_api/api/accounting_api.rb', line 437

def update_accounting_vendor_access_config_is_active_by_id(id, is_active, opts = {})
  data, _status_code, _headers = update_accounting_vendor_access_config_is_active_by_id_with_http_info(id, is_active, opts)
  data
end

#update_accounting_vendor_access_config_is_active_by_id_with_http_info(id, is_active, opts = {}) ⇒ Array<(VendorAccessConfigVO, Fixnum, Hash)>

Enable/Disable relation with particular accounting vendor. Enable/Disable link with particular accounting vendor.

Parameters:

  • id —

    id

  • is_active —

    is_active

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

    the optional parameters

Returns:

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

    VendorAccessConfigVO data, response status code and response headers



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/integration_api/api/accounting_api.rb', line 448

def update_accounting_vendor_access_config_is_active_by_id_with_http_info(id, is_active, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_accounting_vendor_access_config_is_active_by_id ...'
  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 AccountingApi.update_accounting_vendor_access_config_is_active_by_id"
  end
  # verify the required parameter 'is_active' is set
  if @api_client.config.client_side_validation && is_active.nil?
    fail ArgumentError, "Missing the required parameter 'is_active' when calling AccountingApi.update_accounting_vendor_access_config_is_active_by_id"
  end
  # resource path
  local_var_path = '/accounting/vendor/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'is_active'] = is_active

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'VendorAccessConfigVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_accounting_vendor_access_config_is_active_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_customer(nucleus_customer_id, opts = {}) ⇒ AccountingFinalResponseVO

Update customer in Nucleus for a given nucleus_customer_id Update customer in Nucleus for a given nucleus_customer_id

Parameters:

  • nucleus_customer_id —

    nucleus_customer_id

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

    the optional parameters

Returns:



497
498
499
500
 
# File 'lib/integration_api/api/accounting_api.rb', line 497

def update_customer(nucleus_customer_id, opts = {})
  data, _status_code, _headers = update_customer_with_http_info(nucleus_customer_id, opts)
  data
end

#update_customer_with_http_info(nucleus_customer_id, opts = {}) ⇒ Array<(AccountingFinalResponseVO, Fixnum, Hash)>

Update customer in Nucleus for a given nucleus_customer_id Update customer in Nucleus for a given nucleus_customer_id

Parameters:

  • nucleus_customer_id —

    nucleus_customer_id

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

    the optional parameters

Returns:

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

    AccountingFinalResponseVO data, response status code and response headers



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
539
540
541
542
543
 
# File 'lib/integration_api/api/accounting_api.rb', line 507

def update_customer_with_http_info(nucleus_customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_customer ...'
  end
  # verify the required parameter 'nucleus_customer_id' is set
  if @api_client.config.client_side_validation && nucleus_customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_customer_id' when calling AccountingApi.update_customer"
  end
  # resource path
  local_var_path = '/accounting/customer/{nucleus_customer_id}'.sub('{' + 'nucleus_customer_id' + '}', nucleus_customer_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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'AccountingFinalResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_invoice(nucleus_invoice_id, opts = {}) ⇒ AccountingFinalResponseVO

Update invoice in Nucleus for a given nucleus_invoice_id Update invoice in Nucleus for a given nucleus_invoice_id

Parameters:

  • nucleus_invoice_id —

    nucleus_invoice_id

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

    the optional parameters

Returns:



549
550
551
552
 
# File 'lib/integration_api/api/accounting_api.rb', line 549

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

#update_invoice_with_http_info(nucleus_invoice_id, opts = {}) ⇒ Array<(AccountingFinalResponseVO, Fixnum, Hash)>

Update invoice in Nucleus for a given nucleus_invoice_id Update invoice in Nucleus for a given nucleus_invoice_id

Parameters:

  • nucleus_invoice_id —

    nucleus_invoice_id

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

    the optional parameters

Returns:

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

    AccountingFinalResponseVO data, response status code and response headers



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
 
# File 'lib/integration_api/api/accounting_api.rb', line 559

def update_invoice_with_http_info(nucleus_invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_invoice ...'
  end
  # verify the required parameter 'nucleus_invoice_id' is set
  if @api_client.config.client_side_validation && nucleus_invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_invoice_id' when calling AccountingApi.update_invoice"
  end
  # resource path
  local_var_path = '/accounting/invoice/{nucleus_invoice_id}'.sub('{' + 'nucleus_invoice_id' + '}', nucleus_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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'AccountingFinalResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end