Class: ConnectWise::AccountingBatchesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/api/accounting_batches_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountingBatchesApi

Returns a new instance of AccountingBatchesApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 8

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



6
7
8
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#finance_accounting_batches_count_get(opts = {}) ⇒ Count

Get Batches Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



17
18
19
20
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 17

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

#finance_accounting_batches_count_get_with_http_info(opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Batches Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:

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

    Count data, response status code and response headers



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 27

def finance_accounting_batches_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountingBatchesApi.finance_accounting_batches_count_get ..."
  end
  # resource path
  local_var_path = "/finance/accounting/batches/count"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].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 = ['BasicAuth']
  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 => 'Count')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingBatchesApi#finance_accounting_batches_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_accounting_batches_get(opts = {}) ⇒ Array<AccountingBatch>

Get Batches

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:



72
73
74
75
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 72

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

#finance_accounting_batches_get_with_http_info(opts = {}) ⇒ Array<(Array<AccountingBatch>, Fixnum, Hash)>

Get Batches

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:

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

    Array<AccountingBatch> data, response status code and response headers



87
88
89
90
91
92
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
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 87

def finance_accounting_batches_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountingBatchesApi.finance_accounting_batches_get ..."
  end
  # resource path
  local_var_path = "/finance/accounting/batches"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil?
  query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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 = ['BasicAuth']
  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 => 'Array<AccountingBatch>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingBatchesApi#finance_accounting_batches_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Batch By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


132
133
134
135
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 132

def finance_accounting_batches_id_delete(id, opts = {})
  finance_accounting_batches_id_delete_with_http_info(id, opts)
  return nil
end

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

Delete Batch By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 142

def finance_accounting_batches_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountingBatchesApi.finance_accounting_batches_id_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 AccountingBatchesApi.finance_accounting_batches_id_delete"
  end
  # resource path
  local_var_path = "/finance/accounting/batches/{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 = ['BasicAuth']
  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: AccountingBatchesApi#finance_accounting_batches_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_accounting_batches_id_export_post(id, batch_export_parameters, opts = {}) ⇒ GLExport

Re-export the payload data from an existing batch (RecreateBatch in SOAP)

Parameters:

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

    the optional parameters

Returns:



183
184
185
186
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 183

def finance_accounting_batches_id_export_post(id, batch_export_parameters, opts = {})
  data, _status_code, _headers = finance_accounting_batches_id_export_post_with_http_info(id, batch_export_parameters, opts)
  return data
end

#finance_accounting_batches_id_export_post_with_http_info(id, batch_export_parameters, opts = {}) ⇒ Array<(GLExport, Fixnum, Hash)>

Re-export the payload data from an existing batch (RecreateBatch in SOAP)

Parameters:

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

    the optional parameters

Returns:

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

    GLExport data, response status code and response headers



194
195
196
197
198
199
200
201
202
203
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
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 194

def finance_accounting_batches_id_export_post_with_http_info(id, batch_export_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountingBatchesApi.finance_accounting_batches_id_export_post ..."
  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 AccountingBatchesApi.finance_accounting_batches_id_export_post"
  end
  # verify the required parameter 'batch_export_parameters' is set
  if @api_client.config.client_side_validation && batch_export_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'batch_export_parameters' when calling AccountingBatchesApi.finance_accounting_batches_id_export_post"
  end
  # resource path
  local_var_path = "/finance/accounting/batches/{id}/export".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(['application/json'])
  # 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 = @api_client.object_to_http_body(batch_export_parameters)
  auth_names = ['BasicAuth']
  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 => 'GLExport')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingBatchesApi#finance_accounting_batches_id_export_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_accounting_batches_id_get(id, opts = {}) ⇒ AccountingBatch

Get Batch By Id

Parameters:

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

    the optional parameters

Returns:



243
244
245
246
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 243

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

#finance_accounting_batches_id_get_with_http_info(id, opts = {}) ⇒ Array<(AccountingBatch, Fixnum, Hash)>

Get Batch By Id

Parameters:

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

    the optional parameters

Returns:

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

    AccountingBatch data, response status code and response headers



253
254
255
256
257
258
259
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
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 253

def finance_accounting_batches_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountingBatchesApi.finance_accounting_batches_id_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 AccountingBatchesApi.finance_accounting_batches_id_get"
  end
  # resource path
  local_var_path = "/finance/accounting/batches/{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(['application/json'])

  # form parameters
  form_params = {}

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

#finance_accounting_batches_post(accounting_batch_parameters, opts = {}) ⇒ GLExport

Creates the Accounting Batch and updates GL Records (UpdateBatch in SOAP)

Parameters:

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

    the optional parameters

Returns:



296
297
298
299
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 296

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

#finance_accounting_batches_post_with_http_info(accounting_batch_parameters, opts = {}) ⇒ Array<(GLExport, Fixnum, Hash)>

Creates the Accounting Batch and updates GL Records (UpdateBatch in SOAP)

Parameters:

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

    the optional parameters

Returns:

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

    GLExport data, response status code and response headers



306
307
308
309
310
311
312
313
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
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 306

def finance_accounting_batches_post_with_http_info(accounting_batch_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountingBatchesApi.finance_accounting_batches_post ..."
  end
  # verify the required parameter 'accounting_batch_parameters' is set
  if @api_client.config.client_side_validation && accounting_batch_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'accounting_batch_parameters' when calling AccountingBatchesApi.finance_accounting_batches_post"
  end
  # resource path
  local_var_path = "/finance/accounting/batches"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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 = @api_client.object_to_http_body(accounting_batch_parameters)
  auth_names = ['BasicAuth']
  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 => 'GLExport')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingBatchesApi#finance_accounting_batches_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_accounting_export_post(batch_export_parameters, opts = {}) ⇒ GLExport

Exports accouting batch payload based on parameters (CreateBatch in SOAP)

Parameters:

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

    the optional parameters

Returns:



351
352
353
354
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 351

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

#finance_accounting_export_post_with_http_info(batch_export_parameters, opts = {}) ⇒ Array<(GLExport, Fixnum, Hash)>

Exports accouting batch payload based on parameters (CreateBatch in SOAP)

Parameters:

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

    the optional parameters

Returns:

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

    GLExport data, response status code and response headers



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
397
398
399
 
# File 'lib/connectwise-ruby-sdk/api/accounting_batches_api.rb', line 361

def finance_accounting_export_post_with_http_info(batch_export_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountingBatchesApi.finance_accounting_export_post ..."
  end
  # verify the required parameter 'batch_export_parameters' is set
  if @api_client.config.client_side_validation && batch_export_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'batch_export_parameters' when calling AccountingBatchesApi.finance_accounting_export_post"
  end
  # resource path
  local_var_path = "/finance/accounting/export"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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 = @api_client.object_to_http_body(batch_export_parameters)
  auth_names = ['BasicAuth']
  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 => 'GLExport')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingBatchesApi#finance_accounting_export_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end