Class: BudgeaClient::DocumentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/api/documents_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DocumentsApi

Returns a new instance of DocumentsApi.



19
20
21
 
# File 'lib/budgea_client/api/documents_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/budgea_client/api/documents_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#documenttypes_get(opts = {}) ⇒ InlineResponse20018

Get document types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



27
28
29
30
 
# File 'lib/budgea_client/api/documents_api.rb', line 27

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

#documenttypes_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20018, Fixnum, Hash)>

Get document types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20018 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
 
# File 'lib/budgea_client/api/documents_api.rb', line 37

def documenttypes_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.documenttypes_get ...'
  end
  # resource path
  local_var_path = '/documenttypes'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#documenttypes_id_documenttype_put(id_documenttype, name, attacheable, opts = {}) ⇒ DocumentType

Edit a document type Change value of a document type.

Parameters:

  • id_documenttype
  • name —

    Displayed name of document type

  • attacheable —

    If true, documents of this type can be attached to a transaction, and have amount related meta-data

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



81
82
83
84
 
# File 'lib/budgea_client/api/documents_api.rb', line 81

def documenttypes_id_documenttype_put(id_documenttype, name, attacheable, opts = {})
  data, _status_code, _headers = documenttypes_id_documenttype_put_with_http_info(id_documenttype, name, attacheable, opts)
  data
end

#documenttypes_id_documenttype_put_with_http_info(id_documenttype, name, attacheable, opts = {}) ⇒ Array<(DocumentType, Fixnum, Hash)>

Edit a document type Change value of a document type.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_documenttype
  • name —

    Displayed name of document type

  • attacheable —

    If true, documents of this type can be attached to a transaction, and have amount related meta-data

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    DocumentType data, response status code and response headers



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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/budgea_client/api/documents_api.rb', line 94

def documenttypes_id_documenttype_put_with_http_info(id_documenttype, name, attacheable, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.documenttypes_id_documenttype_put ...'
  end
  # verify the required parameter 'id_documenttype' is set
  if @api_client.config.client_side_validation && id_documenttype.nil?
    fail ArgumentError, "Missing the required parameter 'id_documenttype' when calling DocumentsApi.documenttypes_id_documenttype_put"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling DocumentsApi.documenttypes_id_documenttype_put"
  end
  # verify the required parameter 'attacheable' is set
  if @api_client.config.client_side_validation && attacheable.nil?
    fail ArgumentError, "Missing the required parameter 'attacheable' when calling DocumentsApi.documenttypes_id_documenttype_put"
  end
  # resource path
  local_var_path = '/documenttypes/{id_documenttype}'.sub('{' + 'id_documenttype' + '}', id_documenttype.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['name'] = name
  form_params['attacheable'] = attacheable

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

#ocr_post(file, opts = {}) ⇒ nil

Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.

Parameters:

  • file —

    File of the document

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

    the optional parameters

Options Hash (opts):

  • :id_transaction (Integer) —

    Transaction used to help OCR to find data

  • :name (String) —

    Name of the document

Returns:

  • (nil) 


151
152
153
154
 
# File 'lib/budgea_client/api/documents_api.rb', line 151

def ocr_post(file, opts = {})
  ocr_post_with_http_info(file, opts)
  nil
end

#ocr_post_with_http_info(file, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.&lt;br&gt;&lt;br&gt;

Parameters:

  • file —

    File of the document

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

    the optional parameters

Options Hash (opts):

  • :id_transaction (Integer) —

    Transaction used to help OCR to find data

  • :name (String) —

    Name of the document

Returns:

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

    nil, response status code and response headers



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
199
200
201
202
203
 
# File 'lib/budgea_client/api/documents_api.rb', line 163

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file
  form_params['id_transaction'] = opts[:'id_transaction'] if !opts[:'id_transaction'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_delete(id_user, id_account, id_transaction, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



212
213
214
215
 
# File 'lib/budgea_client/api/documents_api.rb', line 212

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_delete_with_http_info(id_user, id_account, id_transaction, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/budgea_client/api/documents_api.rb', line 225

def (id_user, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_get(id_user, id_account, id_transaction, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



290
291
292
293
 
# File 'lib/budgea_client/api/documents_api.rb', line 290

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_get_with_http_info(id_user, id_account, id_transaction, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/budgea_client/api/documents_api.rb', line 312

def (id_user, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



378
379
380
381
 
# File 'lib/budgea_client/api/documents_api.rb', line 378

def (id_user, , id_transaction, id_document, opts = {})
  data, _status_code, _headers = (id_user, , id_transaction, id_document, opts)
  data
end

#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



392
393
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
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/budgea_client/api/documents_api.rb', line 392

def (id_user, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



464
465
466
467
 
# File 'lib/budgea_client/api/documents_api.rb', line 464

def (id_user, , id_transaction, id_document, opts = {})
  data, _status_code, _headers = (id_user, , id_transaction, id_document, opts)
  data
end

#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/budgea_client/api/documents_api.rb', line 489

def (id_user, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_post(id_user, id_account, id_transaction, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



572
573
574
575
 
# File 'lib/budgea_client/api/documents_api.rb', line 572

def (id_user, , id_transaction, date, duedate, opts = {})
  data, _status_code, _headers = (id_user, , id_transaction, date, duedate, opts)
  data
end

#users_id_user_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_account, id_transaction, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
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
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/budgea_client/api/documents_api.rb', line 597

def (id_user, , id_transaction, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_put(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



674
675
676
677
 
# File 'lib/budgea_client/api/documents_api.rb', line 674

def (id_user, , id_transaction, id_document, opts = {})
  data, _status_code, _headers = (id_user, , id_transaction, id_document, opts)
  data
end

#users_id_user_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/budgea_client/api/documents_api.rb', line 688

def (id_user, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_account, id_transactions_cluster, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



749
750
751
752
 
# File 'lib/budgea_client/api/documents_api.rb', line 749

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_account, id_transactions_cluster, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'lib/budgea_client/api/documents_api.rb', line 762

def (id_user, , id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_account, id_transactions_cluster, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



827
828
829
830
 
# File 'lib/budgea_client/api/documents_api.rb', line 827

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_account, id_transactions_cluster, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/budgea_client/api/documents_api.rb', line 849

def (id_user, , id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



915
916
917
918
 
# File 'lib/budgea_client/api/documents_api.rb', line 915

def (id_user, , id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = (id_user, , id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
 
# File 'lib/budgea_client/api/documents_api.rb', line 929

def (id_user, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



1001
1002
1003
1004
 
# File 'lib/budgea_client/api/documents_api.rb', line 1001

def (id_user, , id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = (id_user, , id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
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
 
# File 'lib/budgea_client/api/documents_api.rb', line 1026

def (id_user, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_account, id_transactions_cluster, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



1109
1110
1111
1112
 
# File 'lib/budgea_client/api/documents_api.rb', line 1109

def (id_user, , id_transactions_cluster, date, duedate, opts = {})
  data, _status_code, _headers = (id_user, , id_transactions_cluster, date, duedate, opts)
  data
end

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_account, id_transactions_cluster, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'lib/budgea_client/api/documents_api.rb', line 1134

def (id_user, , id_transactions_cluster, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1211
1212
1213
1214
 
# File 'lib/budgea_client/api/documents_api.rb', line 1211

def (id_user, , id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = (id_user, , id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
 
# File 'lib/budgea_client/api/documents_api.rb', line 1225

def (id_user, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1287
1288
1289
1290
 
# File 'lib/budgea_client/api/documents_api.rb', line 1287

def (id_user, id_connection, , id_transaction, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/budgea_client/api/documents_api.rb', line 1301

def (id_user, id_connection, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



1371
1372
1373
1374
 
# File 'lib/budgea_client/api/documents_api.rb', line 1371

def (id_user, id_connection, , id_transaction, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
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
 
# File 'lib/budgea_client/api/documents_api.rb', line 1394

def (id_user, id_connection, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1465
1466
1467
1468
 
# File 'lib/budgea_client/api/documents_api.rb', line 1465

def (id_user, id_connection, , id_transaction, id_document, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, id_document, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
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
 
# File 'lib/budgea_client/api/documents_api.rb', line 1480

def (id_user, id_connection, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



1557
1558
1559
1560
 
# File 'lib/budgea_client/api/documents_api.rb', line 1557

def (id_user, id_connection, , id_transaction, id_document, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, id_document, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
 
# File 'lib/budgea_client/api/documents_api.rb', line 1583

def (id_user, id_connection, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post(id_user, id_connection, id_account, id_transaction, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



1671
1672
1673
1674
 
# File 'lib/budgea_client/api/documents_api.rb', line 1671

def (id_user, id_connection, , id_transaction, date, duedate, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, date, duedate, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_account, id_transaction, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
 
# File 'lib/budgea_client/api/documents_api.rb', line 1697

def (id_user, id_connection, , id_transaction, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1779
1780
1781
1782
 
# File 'lib/budgea_client/api/documents_api.rb', line 1779

def (id_user, id_connection, , id_transaction, id_document, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, id_document, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
 
# File 'lib/budgea_client/api/documents_api.rb', line 1794

def (id_user, id_connection, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1860
1861
1862
1863
 
# File 'lib/budgea_client/api/documents_api.rb', line 1860

def (id_user, id_connection, , id_transactions_cluster, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transactions_cluster, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
 
# File 'lib/budgea_client/api/documents_api.rb', line 1874

def (id_user, id_connection, , id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



1944
1945
1946
1947
 
# File 'lib/budgea_client/api/documents_api.rb', line 1944

def (id_user, id_connection, , id_transactions_cluster, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transactions_cluster, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



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
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
 
# File 'lib/budgea_client/api/documents_api.rb', line 1967

def (id_user, id_connection, , id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2038
2039
2040
2041
 
# File 'lib/budgea_client/api/documents_api.rb', line 2038

def (id_user, id_connection, , id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
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
 
# File 'lib/budgea_client/api/documents_api.rb', line 2053

def (id_user, id_connection, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



2130
2131
2132
2133
 
# File 'lib/budgea_client/api/documents_api.rb', line 2130

def (id_user, id_connection, , id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'lib/budgea_client/api/documents_api.rb', line 2156

def (id_user, id_connection, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_connection, id_account, id_transactions_cluster, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



2244
2245
2246
2247
 
# File 'lib/budgea_client/api/documents_api.rb', line 2244

def (id_user, id_connection, , id_transactions_cluster, date, duedate, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transactions_cluster, date, duedate, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
 
# File 'lib/budgea_client/api/documents_api.rb', line 2270

def (id_user, id_connection, , id_transactions_cluster, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2352
2353
2354
2355
 
# File 'lib/budgea_client/api/documents_api.rb', line 2352

def (id_user, id_connection, , id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



2367
2368
2369
2370
2371
2372
2373
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
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
 
# File 'lib/budgea_client/api/documents_api.rb', line 2367

def (id_user, id_connection, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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

#users_id_user_connections_id_connection_documents_delete(id_user, id_connection, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2431
2432
2433
2434
 
# File 'lib/budgea_client/api/documents_api.rb', line 2431

def users_id_user_connections_id_connection_documents_delete(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_documents_delete_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_documents_delete_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
2481
2482
2483
2484
2485
2486
 
# File 'lib/budgea_client/api/documents_api.rb', line 2443

def users_id_user_connections_id_connection_documents_delete_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_documents_get(id_user, id_connection, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



2503
2504
2505
2506
 
# File 'lib/budgea_client/api/documents_api.rb', line 2503

def users_id_user_connections_id_connection_documents_get(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_documents_get_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_documents_get_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
 
# File 'lib/budgea_client/api/documents_api.rb', line 2524

def users_id_user_connections_id_connection_documents_get_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_documents_id_document_delete(id_user, id_connection, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2585
2586
2587
2588
 
# File 'lib/budgea_client/api/documents_api.rb', line 2585

def users_id_user_connections_id_connection_documents_id_document_delete(id_user, id_connection, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_documents_id_document_delete_with_http_info(id_user, id_connection, id_document, opts)
  data
end

#users_id_user_connections_id_connection_documents_id_document_delete_with_http_info(id_user, id_connection, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
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
 
# File 'lib/budgea_client/api/documents_api.rb', line 2598

def users_id_user_connections_id_connection_documents_id_document_delete_with_http_info(id_user, id_connection, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_documents_id_document_put(id_user, id_connection, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



2665
2666
2667
2668
 
# File 'lib/budgea_client/api/documents_api.rb', line 2665

def users_id_user_connections_id_connection_documents_id_document_put(id_user, id_connection, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_documents_id_document_put_with_http_info(id_user, id_connection, id_document, opts)
  data
end

#users_id_user_connections_id_connection_documents_id_document_put_with_http_info(id_user, id_connection, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
 
# File 'lib/budgea_client/api/documents_api.rb', line 2689

def users_id_user_connections_id_connection_documents_id_document_put_with_http_info(id_user, id_connection, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_documents_post(id_user, id_connection, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



2767
2768
2769
2770
 
# File 'lib/budgea_client/api/documents_api.rb', line 2767

def users_id_user_connections_id_connection_documents_post(id_user, id_connection, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_documents_post_with_http_info(id_user, id_connection, date, duedate, opts)
  data
end

#users_id_user_connections_id_connection_documents_post_with_http_info(id_user, id_connection, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



2791
2792
2793
2794
2795
2796
2797
2798
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
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
 
# File 'lib/budgea_client/api/documents_api.rb', line 2791

def users_id_user_connections_id_connection_documents_post_with_http_info(id_user, id_connection, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_documents_put(id_user, id_connection, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2863
2864
2865
2866
 
# File 'lib/budgea_client/api/documents_api.rb', line 2863

def users_id_user_connections_id_connection_documents_put(id_user, id_connection, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_documents_put_with_http_info(id_user, id_connection, id_document, opts)
  data
end

#users_id_user_connections_id_connection_documents_put_with_http_info(id_user, id_connection, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
 
# File 'lib/budgea_client/api/documents_api.rb', line 2876

def users_id_user_connections_id_connection_documents_put_with_http_info(id_user, id_connection, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete(id_user, id_connection, id_subscription, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2933
2934
2935
2936
 
# File 'lib/budgea_client/api/documents_api.rb', line 2933

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete(id_user, id_connection, id_subscription, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_connection, id_subscription, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_connection, id_subscription, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
 
# File 'lib/budgea_client/api/documents_api.rb', line 2946

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_connection, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get(id_user, id_connection, id_subscription, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



3011
3012
3013
3014
 
# File 'lib/budgea_client/api/documents_api.rb', line 3011

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get(id_user, id_connection, id_subscription, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_connection, id_subscription, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_connection, id_subscription, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
 
# File 'lib/budgea_client/api/documents_api.rb', line 3033

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_connection, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_subscription
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3099
3100
3101
3102
 
# File 'lib/budgea_client/api/documents_api.rb', line 3099

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete(id_user, id_connection, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_connection, id_subscription, id_document, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_subscription
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
 
# File 'lib/budgea_client/api/documents_api.rb', line 3113

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_subscription
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



3185
3186
3187
3188
 
# File 'lib/budgea_client/api/documents_api.rb', line 3185

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put(id_user, id_connection, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_subscription
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
 
# File 'lib/budgea_client/api/documents_api.rb', line 3210

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post(id_user, id_connection, id_subscription, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_subscription
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



3293
3294
3295
3296
 
# File 'lib/budgea_client/api/documents_api.rb', line 3293

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post(id_user, id_connection, id_subscription, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_connection, id_subscription, date, duedate, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_connection, id_subscription, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_subscription
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
 
# File 'lib/budgea_client/api/documents_api.rb', line 3318

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_connection, id_subscription, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_subscription
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3395
3396
3397
3398
 
# File 'lib/budgea_client/api/documents_api.rb', line 3395

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put(id_user, id_connection, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_subscription
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
 
# File 'lib/budgea_client/api/documents_api.rb', line 3409

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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

#users_id_user_connections_id_connection_transactions_id_transaction_documents_delete(id_user, id_connection, id_transaction, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3470
3471
3472
3473
 
# File 'lib/budgea_client/api/documents_api.rb', line 3470

def users_id_user_connections_id_connection_transactions_id_transaction_documents_delete(id_user, id_connection, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_transaction, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
 
# File 'lib/budgea_client/api/documents_api.rb', line 3483

def users_id_user_connections_id_connection_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactions_id_transaction_documents_get(id_user, id_connection, id_transaction, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



3548
3549
3550
3551
 
# File 'lib/budgea_client/api/documents_api.rb', line 3548

def users_id_user_connections_id_connection_transactions_id_transaction_documents_get(id_user, id_connection, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_transaction, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
 
# File 'lib/budgea_client/api/documents_api.rb', line 3570

def users_id_user_connections_id_connection_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3636
3637
3638
3639
 
# File 'lib/budgea_client/api/documents_api.rb', line 3636

def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete(id_user, id_connection, id_transaction, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_transaction, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
 
# File 'lib/budgea_client/api/documents_api.rb', line 3650

def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



3722
3723
3724
3725
 
# File 'lib/budgea_client/api/documents_api.rb', line 3722

def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put(id_user, id_connection, id_transaction, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
 
# File 'lib/budgea_client/api/documents_api.rb', line 3747

def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_transactions_id_transaction_documents_post(id_user, id_connection, id_transaction, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



3830
3831
3832
3833
 
# File 'lib/budgea_client/api/documents_api.rb', line 3830

def users_id_user_connections_id_connection_transactions_id_transaction_documents_post(id_user, id_connection, id_transaction, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_transaction, date, duedate, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_transaction, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
 
# File 'lib/budgea_client/api/documents_api.rb', line 3855

def users_id_user_connections_id_connection_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_transaction, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_transactions_id_transaction_documents_put(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3932
3933
3934
3935
 
# File 'lib/budgea_client/api/documents_api.rb', line 3932

def users_id_user_connections_id_connection_transactions_id_transaction_documents_put(id_user, id_connection, id_transaction, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
 
# File 'lib/budgea_client/api/documents_api.rb', line 3946

def users_id_user_connections_id_connection_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_connection, id_transactions_cluster, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4007
4008
4009
4010
 
# File 'lib/budgea_client/api/documents_api.rb', line 4007

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_connection, id_transactions_cluster, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_transactions_cluster, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
 
# File 'lib/budgea_client/api/documents_api.rb', line 4020

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_connection, id_transactions_cluster, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



4085
4086
4087
4088
 
# File 'lib/budgea_client/api/documents_api.rb', line 4085

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_connection, id_transactions_cluster, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_transactions_cluster, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
 
# File 'lib/budgea_client/api/documents_api.rb', line 4107

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4173
4174
4175
4176
 
# File 'lib/budgea_client/api/documents_api.rb', line 4173

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
 
# File 'lib/budgea_client/api/documents_api.rb', line 4187

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



4259
4260
4261
4262
 
# File 'lib/budgea_client/api/documents_api.rb', line 4259

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
 
# File 'lib/budgea_client/api/documents_api.rb', line 4284

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



4367
4368
4369
4370
 
# File 'lib/budgea_client/api/documents_api.rb', line 4367

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_transactions_cluster, date, duedate, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
 
# File 'lib/budgea_client/api/documents_api.rb', line 4392

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4469
4470
4471
4472
 
# File 'lib/budgea_client/api/documents_api.rb', line 4469

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
 
# File 'lib/budgea_client/api/documents_api.rb', line 4483

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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

#users_id_user_documents_delete(id_user, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4542
4543
4544
4545
 
# File 'lib/budgea_client/api/documents_api.rb', line 4542

def users_id_user_documents_delete(id_user, opts = {})
  data, _status_code, _headers = users_id_user_documents_delete_with_http_info(id_user, opts)
  data
end

#users_id_user_documents_delete_with_http_info(id_user, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
 
# File 'lib/budgea_client/api/documents_api.rb', line 4553

def users_id_user_documents_delete_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_documents_get(id_user, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



4608
4609
4610
4611
 
# File 'lib/budgea_client/api/documents_api.rb', line 4608

def users_id_user_documents_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_documents_get_with_http_info(id_user, opts)
  data
end

#users_id_user_documents_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
 
# File 'lib/budgea_client/api/documents_api.rb', line 4628

def users_id_user_documents_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_documents_id_document_delete(id_user, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4684
4685
4686
4687
 
# File 'lib/budgea_client/api/documents_api.rb', line 4684

def users_id_user_documents_id_document_delete(id_user, id_document, opts = {})
  data, _status_code, _headers = users_id_user_documents_id_document_delete_with_http_info(id_user, id_document, opts)
  data
end

#users_id_user_documents_id_document_delete_with_http_info(id_user, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
 
# File 'lib/budgea_client/api/documents_api.rb', line 4696

def users_id_user_documents_id_document_delete_with_http_info(id_user, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_documents_id_document_put(id_user, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



4758
4759
4760
4761
 
# File 'lib/budgea_client/api/documents_api.rb', line 4758

def users_id_user_documents_id_document_put(id_user, id_document, opts = {})
  data, _status_code, _headers = users_id_user_documents_id_document_put_with_http_info(id_user, id_document, opts)
  data
end

#users_id_user_documents_id_document_put_with_http_info(id_user, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
 
# File 'lib/budgea_client/api/documents_api.rb', line 4781

def users_id_user_documents_id_document_put_with_http_info(id_user, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_documents_post(id_user, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



4854
4855
4856
4857
 
# File 'lib/budgea_client/api/documents_api.rb', line 4854

def users_id_user_documents_post(id_user, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_documents_post_with_http_info(id_user, date, duedate, opts)
  data
end

#users_id_user_documents_post_with_http_info(id_user, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
 
# File 'lib/budgea_client/api/documents_api.rb', line 4877

def users_id_user_documents_post_with_http_info(id_user, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_documents_put(id_user, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4944
4945
4946
4947
 
# File 'lib/budgea_client/api/documents_api.rb', line 4944

def users_id_user_documents_put(id_user, id_document, opts = {})
  data, _status_code, _headers = users_id_user_documents_put_with_http_info(id_user, id_document, opts)
  data
end

#users_id_user_documents_put_with_http_info(id_user, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
 
# File 'lib/budgea_client/api/documents_api.rb', line 4956

def users_id_user_documents_put_with_http_info(id_user, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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

#users_id_user_ocr_post(id_user, file, opts = {}) ⇒ nil

Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • file —

    File of the document

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

    the optional parameters

Options Hash (opts):

  • :id_transaction (Integer) —

    Transaction used to help OCR to find data

  • :name (String) —

    Name of the document

Returns:

  • (nil) 


5009
5010
5011
5012
 
# File 'lib/budgea_client/api/documents_api.rb', line 5009

def users_id_user_ocr_post(id_user, file, opts = {})
  users_id_user_ocr_post_with_http_info(id_user, file, opts)
  nil
end

#users_id_user_ocr_post_with_http_info(id_user, file, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • file —

    File of the document

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

    the optional parameters

Options Hash (opts):

  • :id_transaction (Integer) —

    Transaction used to help OCR to find data

  • :name (String) —

    Name of the document

Returns:

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

    nil, response status code and response headers



5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
 
# File 'lib/budgea_client/api/documents_api.rb', line 5022

def users_id_user_ocr_post_with_http_info(id_user, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_ocr_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_ocr_post"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling DocumentsApi.users_id_user_ocr_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/ocr'.sub('{' + 'id_user' + '}', id_user.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file
  form_params['id_transaction'] = opts[:'id_transaction'] if !opts[:'id_transaction'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_subscriptions_id_subscription_documents_delete(id_user, id_subscription, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5074
5075
5076
5077
 
# File 'lib/budgea_client/api/documents_api.rb', line 5074

def users_id_user_subscriptions_id_subscription_documents_delete(id_user, id_subscription, opts = {})
  data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_subscription, opts)
  data
end

#users_id_user_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_subscription, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
 
# File 'lib/budgea_client/api/documents_api.rb', line 5086

def users_id_user_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_delete"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_subscriptions_id_subscription_documents_get(id_user, id_subscription, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



5146
5147
5148
5149
 
# File 'lib/budgea_client/api/documents_api.rb', line 5146

def users_id_user_subscriptions_id_subscription_documents_get(id_user, id_subscription, opts = {})
  data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_subscription, opts)
  data
end

#users_id_user_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_subscription, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
 
# File 'lib/budgea_client/api/documents_api.rb', line 5167

def users_id_user_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_get"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_subscriptions_id_subscription_documents_id_document_delete(id_user, id_subscription, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5228
5229
5230
5231
 
# File 'lib/budgea_client/api/documents_api.rb', line 5228

def users_id_user_subscriptions_id_subscription_documents_id_document_delete(id_user, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_subscription, id_document, opts)
  data
end

#users_id_user_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
 
# File 'lib/budgea_client/api/documents_api.rb', line 5241

def users_id_user_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_subscriptions_id_subscription_documents_id_document_put(id_user, id_subscription, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



5308
5309
5310
5311
 
# File 'lib/budgea_client/api/documents_api.rb', line 5308

def users_id_user_subscriptions_id_subscription_documents_id_document_put(id_user, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_subscription, id_document, opts)
  data
end

#users_id_user_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
 
# File 'lib/budgea_client/api/documents_api.rb', line 5332

def users_id_user_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_put"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_subscriptions_id_subscription_documents_post(id_user, id_subscription, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_subscription
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



5410
5411
5412
5413
 
# File 'lib/budgea_client/api/documents_api.rb', line 5410

def users_id_user_subscriptions_id_subscription_documents_post(id_user, id_subscription, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_subscription, date, duedate, opts)
  data
end

#users_id_user_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_subscription, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_subscription
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
 
# File 'lib/budgea_client/api/documents_api.rb', line 5434

def users_id_user_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_subscription, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_post"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_subscriptions_id_subscription_documents_put(id_user, id_subscription, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_subscription
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5506
5507
5508
5509
 
# File 'lib/budgea_client/api/documents_api.rb', line 5506

def users_id_user_subscriptions_id_subscription_documents_put(id_user, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_subscription, id_document, opts)
  data
end

#users_id_user_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_subscription
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
 
# File 'lib/budgea_client/api/documents_api.rb', line 5519

def users_id_user_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_put"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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

#users_id_user_transactions_id_transaction_documents_delete(id_user, id_transaction, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5575
5576
5577
5578
 
# File 'lib/budgea_client/api/documents_api.rb', line 5575

def users_id_user_transactions_id_transaction_documents_delete(id_user, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_delete_with_http_info(id_user, id_transaction, opts)
  data
end

#users_id_user_transactions_id_transaction_documents_delete_with_http_info(id_user, id_transaction, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
 
# File 'lib/budgea_client/api/documents_api.rb', line 5587

def users_id_user_transactions_id_transaction_documents_delete_with_http_info(id_user, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactions_id_transaction_documents_get(id_user, id_transaction, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



5647
5648
5649
5650
 
# File 'lib/budgea_client/api/documents_api.rb', line 5647

def users_id_user_transactions_id_transaction_documents_get(id_user, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_get_with_http_info(id_user, id_transaction, opts)
  data
end

#users_id_user_transactions_id_transaction_documents_get_with_http_info(id_user, id_transaction, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
 
# File 'lib/budgea_client/api/documents_api.rb', line 5668

def users_id_user_transactions_id_transaction_documents_get_with_http_info(id_user, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactions_id_transaction_documents_id_document_delete(id_user, id_transaction, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5729
5730
5731
5732
 
# File 'lib/budgea_client/api/documents_api.rb', line 5729

def users_id_user_transactions_id_transaction_documents_id_document_delete(id_user, id_transaction, id_document, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_transaction, id_document, opts)
  data
end

#users_id_user_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
 
# File 'lib/budgea_client/api/documents_api.rb', line 5742

def users_id_user_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactions_id_transaction_documents_id_document_put(id_user, id_transaction, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



5809
5810
5811
5812
 
# File 'lib/budgea_client/api/documents_api.rb', line 5809

def users_id_user_transactions_id_transaction_documents_id_document_put(id_user, id_transaction, id_document, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_transaction, id_document, opts)
  data
end

#users_id_user_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
 
# File 'lib/budgea_client/api/documents_api.rb', line 5833

def users_id_user_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_transactions_id_transaction_documents_post(id_user, id_transaction, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



5911
5912
5913
5914
 
# File 'lib/budgea_client/api/documents_api.rb', line 5911

def users_id_user_transactions_id_transaction_documents_post(id_user, id_transaction, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_post_with_http_info(id_user, id_transaction, date, duedate, opts)
  data
end

#users_id_user_transactions_id_transaction_documents_post_with_http_info(id_user, id_transaction, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
 
# File 'lib/budgea_client/api/documents_api.rb', line 5935

def users_id_user_transactions_id_transaction_documents_post_with_http_info(id_user, id_transaction, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_transactions_id_transaction_documents_put(id_user, id_transaction, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6007
6008
6009
6010
 
# File 'lib/budgea_client/api/documents_api.rb', line 6007

def users_id_user_transactions_id_transaction_documents_put(id_user, id_transaction, id_document, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_put_with_http_info(id_user, id_transaction, id_document, opts)
  data
end

#users_id_user_transactions_id_transaction_documents_put_with_http_info(id_user, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
 
# File 'lib/budgea_client/api/documents_api.rb', line 6020

def users_id_user_transactions_id_transaction_documents_put_with_http_info(id_user, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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

#users_id_user_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_transactions_cluster, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6076
6077
6078
6079
 
# File 'lib/budgea_client/api/documents_api.rb', line 6076

def users_id_user_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_transactions_cluster, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_transactions_cluster, opts)
  data
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_transactions_cluster, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
 
# File 'lib/budgea_client/api/documents_api.rb', line 6088

def users_id_user_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_transactions_cluster, opts = {}) ⇒ InlineResponse20032

Get documents Get list of documents

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



6148
6149
6150
6151
 
# File 'lib/budgea_client/api/documents_api.rb', line 6148

def users_id_user_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_transactions_cluster, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_transactions_cluster, opts)
  data
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_transactions_cluster, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
 
# File 'lib/budgea_client/api/documents_api.rb', line 6169

def users_id_user_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6230
6231
6232
6233
 
# File 'lib/budgea_client/api/documents_api.rb', line 6230

def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
 
# File 'lib/budgea_client/api/documents_api.rb', line 6243

def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



6310
6311
6312
6313
 
# File 'lib/budgea_client/api/documents_api.rb', line 6310

def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
 
# File 'lib/budgea_client/api/documents_api.rb', line 6334

def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_transactions_cluster, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



6412
6413
6414
6415
 
# File 'lib/budgea_client/api/documents_api.rb', line 6412

def users_id_user_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_transactions_cluster, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_transactions_cluster, date, duedate, opts)
  data
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_transactions_cluster, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
 
# File 'lib/budgea_client/api/documents_api.rb', line 6436

def users_id_user_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_transactions_cluster, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

#users_id_user_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6508
6509
6510
6511
 
# File 'lib/budgea_client/api/documents_api.rb', line 6508

def users_id_user_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
 
# File 'lib/budgea_client/api/documents_api.rb', line 6521

def users_id_user_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_document'] = id_document

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