Class: TripletexRubyClient::SupplierInvoiceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/supplier_invoice_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SupplierInvoiceApi

Returns a new instance of SupplierInvoiceApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_payment(invoice_id, payment_type, opts = {}) ⇒ ResponseWrapperSupplierInvoice

BETA

Register payment, paymentType == 0 finds the last paymentType for this vendor

Parameters:

  • invoice_id —

    Invoice ID.

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

    the optional parameters

Options Hash (opts):

  • :amount (String)
  • :kid_or_receiver_reference (String)
  • :bban (String)
  • :payment_date (String)
  • :use_default_payment_type (BOOLEAN) —

    Set paymentType to last type for vendor, autopay, nets or first available other type (default to false)

  • :partial_payment (BOOLEAN) —

    Set to true to allow multiple payments registered. (default to false)

Returns:



34
35
36
37
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 34

def add_payment(invoice_id, payment_type, opts = {})
  data, _status_code, _headers = add_payment_with_http_info(invoice_id, payment_type, opts)
  data
end

#add_payment_with_http_info(invoice_id, payment_type, opts = {}) ⇒ Array<(ResponseWrapperSupplierInvoice, Fixnum, Hash)>

BETA

Register payment, paymentType &#x3D;&#x3D; 0 finds the last paymentType for this vendor

Parameters:

  • invoice_id —

    Invoice ID.

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

    the optional parameters

Options Hash (opts):

  • :amount (String)
  • :kid_or_receiver_reference (String)
  • :bban (String)
  • :payment_date (String)
  • :use_default_payment_type (BOOLEAN) —

    Set paymentType to last type for vendor, autopay, nets or first available other type

  • :partial_payment (BOOLEAN) —

    Set to true to allow multiple payments registered.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 51

def add_payment_with_http_info(invoice_id, payment_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.add_payment ...'
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling SupplierInvoiceApi.add_payment"
  end
  # verify the required parameter 'payment_type' is set
  if @api_client.config.client_side_validation && payment_type.nil?
    fail ArgumentError, "Missing the required parameter 'payment_type' when calling SupplierInvoiceApi.add_payment"
  end
  # resource path
  local_var_path = '/supplierInvoice/{invoiceId}/:addPayment'.sub('{' + 'invoiceId' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'paymentType'] = payment_type
  query_params[:'amount'] = opts[:'amount'] if !opts[:'amount'].nil?
  query_params[:'kidOrReceiverReference'] = opts[:'kid_or_receiver_reference'] if !opts[:'kid_or_receiver_reference'].nil?
  query_params[:'bban'] = opts[:'bban'] if !opts[:'bban'].nil?
  query_params[:'paymentDate'] = opts[:'payment_date'] if !opts[:'payment_date'].nil?
  query_params[:'useDefaultPaymentType'] = opts[:'use_default_payment_type'] if !opts[:'use_default_payment_type'].nil?
  query_params[:'partialPayment'] = opts[:'partial_payment'] if !opts[:'partial_payment'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#add_recipient(invoice_id, employee_id, opts = {}) ⇒ ResponseWrapperSupplierInvoice

BETA

Add recipient to supplier invoices.

Parameters:

  • invoice_id —

    Invoice ID.

  • employee_id —

    ID of the elements

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    comment

Returns:



104
105
106
107
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 104

def add_recipient(invoice_id, employee_id, opts = {})
  data, _status_code, _headers = add_recipient_with_http_info(invoice_id, employee_id, opts)
  data
end

#add_recipient_to_many(employee_id, opts = {}) ⇒ ListResponseSupplierInvoice

BETA

Add recipient.

Parameters:

  • employee_id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :invoice_ids (String) —

    ID of the elements

  • :comment (String) —

    comment

Returns:



164
165
166
167
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 164

def add_recipient_to_many(employee_id, opts = {})
  data, _status_code, _headers = add_recipient_to_many_with_http_info(employee_id, opts)
  data
end

#add_recipient_to_many_with_http_info(employee_id, opts = {}) ⇒ Array<(ListResponseSupplierInvoice, Fixnum, Hash)>

BETA

Add recipient.

Parameters:

  • employee_id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :invoice_ids (String) —

    ID of the elements

  • :comment (String) —

    comment

Returns:



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
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 176

def add_recipient_to_many_with_http_info(employee_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.add_recipient_to_many ...'
  end
  # verify the required parameter 'employee_id' is set
  if @api_client.config.client_side_validation && employee_id.nil?
    fail ArgumentError, "Missing the required parameter 'employee_id' when calling SupplierInvoiceApi.add_recipient_to_many"
  end
  # resource path
  local_var_path = '/supplierInvoice/:addRecipient'

  # query parameters
  query_params = {}
  query_params[:'employeeId'] = employee_id
  query_params[:'invoiceIds'] = opts[:'invoice_ids'] if !opts[:'invoice_ids'].nil?
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#add_recipient_with_http_info(invoice_id, employee_id, opts = {}) ⇒ Array<(ResponseWrapperSupplierInvoice, Fixnum, Hash)>

BETA

Add recipient to supplier invoices.

Parameters:

  • invoice_id —

    Invoice ID.

  • employee_id —

    ID of the elements

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    comment

Returns:



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
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 116

def add_recipient_with_http_info(invoice_id, employee_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.add_recipient ...'
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling SupplierInvoiceApi.add_recipient"
  end
  # verify the required parameter 'employee_id' is set
  if @api_client.config.client_side_validation && employee_id.nil?
    fail ArgumentError, "Missing the required parameter 'employee_id' when calling SupplierInvoiceApi.add_recipient"
  end
  # resource path
  local_var_path = '/supplierInvoice/{invoiceId}/:addRecipient'.sub('{' + 'invoiceId' + '}', invoice_id.to_s)

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#approve(invoice_id, opts = {}) ⇒ ResponseWrapperSupplierInvoice

BETA

Approve supplier invoice.

Parameters:

  • invoice_id —

    ID of the elements

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    comment

Returns:



220
221
222
223
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 220

def approve(invoice_id, opts = {})
  data, _status_code, _headers = approve_with_http_info(invoice_id, opts)
  data
end

#approve_many(opts = {}) ⇒ ListResponseSupplierInvoice

BETA

Approve supplier invoices.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :invoice_ids (String) —

    ID of the elements

  • :comment (String) —

    comment

Returns:



273
274
275
276
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 273

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

#approve_many_with_http_info(opts = {}) ⇒ Array<(ListResponseSupplierInvoice, Fixnum, Hash)>

BETA

Approve supplier invoices.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :invoice_ids (String) —

    ID of the elements

  • :comment (String) —

    comment

Returns:



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 284

def approve_many_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.approve_many ...'
  end
  # resource path
  local_var_path = '/supplierInvoice/:approve'

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#approve_with_http_info(invoice_id, opts = {}) ⇒ Array<(ResponseWrapperSupplierInvoice, Fixnum, Hash)>

BETA

Approve supplier invoice.

Parameters:

  • invoice_id —

    ID of the elements

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    comment

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 231

def approve_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.approve ...'
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling SupplierInvoiceApi.approve"
  end
  # resource path
  local_var_path = '/supplierInvoice/{invoiceId}/:approve'.sub('{' + 'invoiceId' + '}', invoice_id.to_s)

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#change_dimension_many(invoice_id, dimension, dimension_id, opts = {}) ⇒ ResponseWrapperSupplierInvoice

Change dimension on a supplier invoice.

Parameters:

  • invoice_id —

    Invoice ID.

  • dimension —

    Dimension

  • dimension_id —

    DimensionID

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

    the optional parameters

Options Hash (opts):

  • :debit_posting_ids (String) —

    ID of the elements

Returns:



325
326
327
328
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 325

def change_dimension_many(invoice_id, dimension, dimension_id, opts = {})
  data, _status_code, _headers = change_dimension_many_with_http_info(invoice_id, dimension, dimension_id, opts)
  data
end

#change_dimension_many_with_http_info(invoice_id, dimension, dimension_id, opts = {}) ⇒ Array<(ResponseWrapperSupplierInvoice, Fixnum, Hash)>

Change dimension on a supplier invoice.

Parameters:

  • invoice_id —

    Invoice ID.

  • dimension —

    Dimension

  • dimension_id —

    DimensionID

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

    the optional parameters

Options Hash (opts):

  • :debit_posting_ids (String) —

    ID of the elements

Returns:



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 338

def change_dimension_many_with_http_info(invoice_id, dimension, dimension_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.change_dimension_many ...'
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling SupplierInvoiceApi.change_dimension_many"
  end
  # verify the required parameter 'dimension' is set
  if @api_client.config.client_side_validation && dimension.nil?
    fail ArgumentError, "Missing the required parameter 'dimension' when calling SupplierInvoiceApi.change_dimension_many"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['PROJECT', 'DEPARTMENT', 'EMPLOYEE', 'PRODUCT'].include?(dimension)
    fail ArgumentError, "invalid value for 'dimension', must be one of PROJECT, DEPARTMENT, EMPLOYEE, PRODUCT"
  end
  # verify the required parameter 'dimension_id' is set
  if @api_client.config.client_side_validation && dimension_id.nil?
    fail ArgumentError, "Missing the required parameter 'dimension_id' when calling SupplierInvoiceApi.change_dimension_many"
  end
  # resource path
  local_var_path = '/supplierInvoice/{invoiceId}/:changeDimension'.sub('{' + 'invoiceId' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'dimension'] = dimension
  query_params[:'dimensionId'] = dimension_id
  query_params[:'debitPostingIds'] = opts[:'debit_posting_ids'] if !opts[:'debit_posting_ids'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#download_pdf(invoice_id, opts = {}) ⇒ String

BETA

Get supplierInvoice document by invoice ID.

Parameters:

  • invoice_id —

    Invoice ID from which document is downloaded.

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

    the optional parameters

Options Hash (opts):

  • :return_type (String) —

    ‘String’ type set as default

Returns:

  • (String) 


394
395
396
397
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 394

def download_pdf(invoice_id, opts = {})
  data, _status_code, _headers = download_pdf_with_http_info(invoice_id, opts)
  data
end

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

BETA

Get supplierInvoice document by invoice ID.

Parameters:

  • invoice_id —

    Invoice ID from which document is downloaded.

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

    the optional parameters

Options Hash (opts):

  • :return_type (String) —

    ‘String’ type set as default

Returns:

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

    String data, response status code and response headers



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
444
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 405

def download_pdf_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.download_pdf ...'
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling SupplierInvoiceApi.download_pdf"
  end
  # resource path
  local_var_path = '/supplierInvoice/{invoiceId}/pdf'.sub('{' + 'invoiceId' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # return_type
  return_type = opts[:'return_type'] || 'String'

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

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

BETA

Get supplierInvoice by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



451
452
453
454
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 451

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

#get_approval_invoices(opts = {}) ⇒ ListResponseSupplierInvoice

BETA

Get supplierInvoices for approval

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_text (String) —

    Search for department, employee, project and more

  • :show_all (BOOLEAN) —

    Show all or just your own (default to false)

  • :employee_id (Integer) —

    Default is logged in employee

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



509
510
511
512
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 509

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

#get_approval_invoices_with_http_info(opts = {}) ⇒ Array<(ListResponseSupplierInvoice, Fixnum, Hash)>

BETA

Get supplierInvoices for approval

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_text (String) —

    Search for department, employee, project and more

  • :show_all (BOOLEAN) —

    Show all or just your own

  • :employee_id (Integer) —

    Default is logged in employee

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



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
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 525

def get_approval_invoices_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.get_approval_invoices ...'
  end
  # resource path
  local_var_path = '/supplierInvoice/forApproval'

  # query parameters
  query_params = {}
  query_params[:'searchText'] = opts[:'search_text'] if !opts[:'search_text'].nil?
  query_params[:'showAll'] = opts[:'show_all'] if !opts[:'show_all'].nil?
  query_params[:'employeeId'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

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

BETA

Get supplierInvoice by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 462

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

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#put_postings(id, opts = {}) ⇒ ResponseWrapperSupplierInvoice

BETA

Put debit postings.

Parameters:

  • id —

    Voucher id

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

    the optional parameters

Options Hash (opts):

  • :body (Array<OrderLinePostingDTO>) —

    Postings

  • :send_to_ledger (BOOLEAN) —

    Equals (default to false)

  • :voucher_date (String) —

    If set, the date of the voucher and the supplier invoice will be changed to this date. If empty, date will not be changed

Returns:



571
572
573
574
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 571

def put_postings(id, opts = {})
  data, _status_code, _headers = put_postings_with_http_info(id, opts)
  data
end

#put_postings_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperSupplierInvoice, Fixnum, Hash)>

BETA

Put debit postings.

Parameters:

  • id —

    Voucher id

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

    the optional parameters

Options Hash (opts):

  • :body (Array<OrderLinePostingDTO>) —

    Postings

  • :send_to_ledger (BOOLEAN) —

    Equals

  • :voucher_date (String) —

    If set, the date of the voucher and the supplier invoice will be changed to this date. If empty, date will not be changed

Returns:



584
585
586
587
588
589
590
591
592
593
594
595
596
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
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 584

def put_postings_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.put_postings ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SupplierInvoiceApi.put_postings"
  end
  # resource path
  local_var_path = '/supplierInvoice/voucher/{id}/postings'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'sendToLedger'] = opts[:'send_to_ledger'] if !opts[:'send_to_ledger'].nil?
  query_params[:'voucherDate'] = opts[:'voucher_date'] if !opts[:'voucher_date'].nil?

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

  # form parameters
  form_params = {}

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

#reject(invoice_id, comment, opts = {}) ⇒ ResponseWrapperSupplierInvoice

BETA

reject supplier invoice.

Parameters:

  • invoice_id —

    Invoice ID.

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

    the optional parameters

Returns:



629
630
631
632
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 629

def reject(invoice_id, comment, opts = {})
  data, _status_code, _headers = reject_with_http_info(invoice_id, comment, opts)
  data
end

#reject_many(comment, opts = {}) ⇒ ListResponseSupplierInvoice

BETA

reject supplier invoices.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :invoice_ids (String) —

    ID of the elements

Returns:



686
687
688
689
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 686

def reject_many(comment, opts = {})
  data, _status_code, _headers = reject_many_with_http_info(comment, opts)
  data
end

#reject_many_with_http_info(comment, opts = {}) ⇒ Array<(ListResponseSupplierInvoice, Fixnum, Hash)>

BETA

reject supplier invoices.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :invoice_ids (String) —

    ID of the elements

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 697

def reject_many_with_http_info(comment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.reject_many ...'
  end
  # verify the required parameter 'comment' is set
  if @api_client.config.client_side_validation && comment.nil?
    fail ArgumentError, "Missing the required parameter 'comment' when calling SupplierInvoiceApi.reject_many"
  end
  # resource path
  local_var_path = '/supplierInvoice/:reject'

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#reject_with_http_info(invoice_id, comment, opts = {}) ⇒ Array<(ResponseWrapperSupplierInvoice, Fixnum, Hash)>

BETA

reject supplier invoice.

Parameters:

  • invoice_id —

    Invoice ID.

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

    the optional parameters

Returns:



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
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 640

def reject_with_http_info(invoice_id, comment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.reject ...'
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling SupplierInvoiceApi.reject"
  end
  # verify the required parameter 'comment' is set
  if @api_client.config.client_side_validation && comment.nil?
    fail ArgumentError, "Missing the required parameter 'comment' when calling SupplierInvoiceApi.reject"
  end
  # resource path
  local_var_path = '/supplierInvoice/{invoiceId}/:reject'.sub('{' + 'invoiceId' + '}', invoice_id.to_s)

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#search(invoice_date_from, invoice_date_to, opts = {}) ⇒ ListResponseSupplierInvoice

BETA

Find supplierInvoices corresponding with sent data.

Parameters:

  • invoice_date_from —

    From and including

  • invoice_date_to —

    To and excluding

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :invoice_number (String) —

    Equals

  • :kid (String) —

    Equals

  • :voucher_id (String) —

    Equals

  • :supplier_id (String) —

    Equals

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



749
750
751
752
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 749

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

#search_with_http_info(invoice_date_from, invoice_date_to, opts = {}) ⇒ Array<(ListResponseSupplierInvoice, Fixnum, Hash)>

BETA

Find supplierInvoices corresponding with sent data.

Parameters:

  • invoice_date_from —

    From and including

  • invoice_date_to —

    To and excluding

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :invoice_number (String) —

    Equals

  • :kid (String) —

    Equals

  • :voucher_id (String) —

    Equals

  • :supplier_id (String) —

    Equals

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



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
810
811
812
813
814
815
816
817
818
 
# File 'lib/tripletex_ruby_client/api/supplier_invoice_api.rb', line 769

def search_with_http_info(invoice_date_from, invoice_date_to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupplierInvoiceApi.search ...'
  end
  # verify the required parameter 'invoice_date_from' is set
  if @api_client.config.client_side_validation && invoice_date_from.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_date_from' when calling SupplierInvoiceApi.search"
  end
  # verify the required parameter 'invoice_date_to' is set
  if @api_client.config.client_side_validation && invoice_date_to.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_date_to' when calling SupplierInvoiceApi.search"
  end
  # resource path
  local_var_path = '/supplierInvoice'

  # query parameters
  query_params = {}
  query_params[:'invoiceDateFrom'] = invoice_date_from
  query_params[:'invoiceDateTo'] = invoice_date_to
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'invoiceNumber'] = opts[:'invoice_number'] if !opts[:'invoice_number'].nil?
  query_params[:'kid'] = opts[:'kid'] if !opts[:'kid'].nil?
  query_params[:'voucherId'] = opts[:'voucher_id'] if !opts[:'voucher_id'].nil?
  query_params[:'supplierId'] = opts[:'supplier_id'] if !opts[:'supplier_id'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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