Class: TripletexApi::BankreconciliationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/api/bankreconciliation_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BankreconciliationApi

Returns a new instance of BankreconciliationApi.



19
20
21
 
# File 'lib/tripletex_api/api/bankreconciliation_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/tripletex_api/api/bankreconciliation_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#adjustment(id, opts = {}) ⇒ ListResponseBankReconciliationAdjustment

BETA

Add an adjustment to reconciliation by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

Returns:



29
30
31
32
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 29

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

#adjustment_with_http_info(id, opts = {}) ⇒ Array<(ListResponseBankReconciliationAdjustment, Fixnum, Hash)>

BETA

Add an adjustment to reconciliation by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

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
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 40

def adjustment_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BankreconciliationApi.adjustment ..."
  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 BankreconciliationApi.adjustment"
  end
  # resource path
  local_var_path = "/bank/reconciliation/{id}/:adjustment".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # 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(opts[:'body'])
  auth_names = ['tokenAuthScheme']
  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 => 'ListResponseBankReconciliationAdjustment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BankreconciliationApi#adjustment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

BETA

Delete bank reconciliation by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

  • (nil) 


83
84
85
86
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 83

def delete(id, opts = {})
  delete_with_http_info(id, opts)
  return nil
end

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

BETA

Delete bank reconciliation by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



93
94
95
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
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 93

def delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BankreconciliationApi.delete ..."
  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 BankreconciliationApi.delete"
  end
  # resource path
  local_var_path = "/bank/reconciliation/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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: BankreconciliationApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fetch_from_bank(account_id, accounting_period_id, opts = {}) ⇒ ResponseWrapperBankReconciliation

BETA

Create a bank reconciliation by fetching bank statement from the bank.

Parameters:

  • account_id —

    Element ID

  • accounting_period_id —

    Element ID

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

    the optional parameters

Returns:



134
135
136
137
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 134

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

#fetch_from_bank_with_http_info(account_id, accounting_period_id, opts = {}) ⇒ Array<(ResponseWrapperBankReconciliation, Fixnum, Hash)>

BETA

Create a bank reconciliation by fetching bank statement from the bank.

Parameters:

  • account_id —

    Element ID

  • accounting_period_id —

    Element ID

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

    the optional parameters

Returns:



145
146
147
148
149
150
151
152
153
154
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
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 145

def fetch_from_bank_with_http_info(, accounting_period_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BankreconciliationApi.fetch_from_bank ..."
  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 BankreconciliationApi.fetch_from_bank"
  end
  # verify the required parameter 'accounting_period_id' is set
  if @api_client.config.client_side_validation && accounting_period_id.nil?
    fail ArgumentError, "Missing the required parameter 'accounting_period_id' when calling BankreconciliationApi.fetch_from_bank"
  end
  # resource path
  local_var_path = "/bank/reconciliation/:fetchFromBank"

  # query parameters
  query_params = {}
  query_params[:'accountId'] = 
  query_params[:'accountingPeriodId'] = accounting_period_id

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#get(id, opts = {}) ⇒ ResponseWrapperBankReconciliation

BETA

Get bank reconciliation.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



193
194
195
196
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 193

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

#get_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperBankReconciliation, Fixnum, Hash)>

BETA

Get bank reconciliation.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



204
205
206
207
208
209
210
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
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 204

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BankreconciliationApi.get ..."
  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 BankreconciliationApi.get"
  end
  # resource path
  local_var_path = "/bank/reconciliation/{id}".sub('{' + 'id' + '}', id.to_s)

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#last_closed(account_id, opts = {}) ⇒ ResponseWrapperBankReconciliation

BETA

Get last closed reconciliation by account ID.

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    Format is yyyy-MM-dd

  • :fields (String) —

    Fields filter pattern

Returns:



248
249
250
251
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 248

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

#last_closed_with_http_info(account_id, opts = {}) ⇒ Array<(ResponseWrapperBankReconciliation, Fixnum, Hash)>

BETA

Get last closed reconciliation by account ID.

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    Format is yyyy-MM-dd

  • :fields (String) —

    Fields filter pattern

Returns:



260
261
262
263
264
265
266
267
268
269
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
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 260

def last_closed_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BankreconciliationApi.last_closed ..."
  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 BankreconciliationApi.last_closed"
  end
  # resource path
  local_var_path = "/bank/reconciliation/>lastClosed"

  # query parameters
  query_params = {}
  query_params[:'accountId'] = 
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#post(opts = {}) ⇒ ResponseWrapperBankReconciliation

BETA

Post a bank reconciliation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (BankReconciliation) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:



304
305
306
307
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 304

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

#post_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperBankReconciliation, Fixnum, Hash)>

BETA

Post a bank reconciliation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (BankReconciliation) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 314

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BankreconciliationApi.post ..."
  end
  # resource path
  local_var_path = "/bank/reconciliation"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # 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(opts[:'body'])
  auth_names = ['tokenAuthScheme']
  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 => 'ResponseWrapperBankReconciliation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BankreconciliationApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put(id, opts = {}) ⇒ ResponseWrapperBankReconciliation

BETA

Update a bank reconciliation.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

Returns:



354
355
356
357
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 354

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

#put_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperBankReconciliation, Fixnum, Hash)>

BETA

Update a bank reconciliation.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

Returns:



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
397
398
399
400
401
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 365

def put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BankreconciliationApi.put ..."
  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 BankreconciliationApi.put"
  end
  # resource path
  local_var_path = "/bank/reconciliation/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # 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(opts[:'body'])
  auth_names = ['tokenAuthScheme']
  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 => 'ResponseWrapperBankReconciliation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BankreconciliationApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseBankReconciliation

BETA

Find bank reconciliation corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :accounting_period_id (String) —

    List of IDs

  • :account_id (String) —

    List of IDs

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



414
415
416
417
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 414

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

#search_with_http_info(opts = {}) ⇒ Array<(ListResponseBankReconciliation, Fixnum, Hash)>

BETA

Find bank reconciliation corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :accounting_period_id (String) —

    List of IDs

  • :account_id (String) —

    List of IDs

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/tripletex_api/api/bankreconciliation_api.rb', line 430

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BankreconciliationApi.search ..."
  end
  # resource path
  local_var_path = "/bank/reconciliation"

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'accountingPeriodId'] = opts[:'accounting_period_id'] if !opts[:'accounting_period_id'].nil?
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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