Class: TripletexRubyClient::PurchaseOrdergoodsReceiptApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PurchaseOrdergoodsReceiptApi

Returns a new instance of PurchaseOrdergoodsReceiptApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_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/purchase_ordergoods_receipt_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#confirm(id, opts = {}) ⇒ ResponseWrapperPurchaseOrder

BETA

Confirm goods receipt. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

  • id —

    Purchase Order ID.

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

    the optional parameters

Options Hash (opts):

  • :create_rest_order (BOOLEAN) —

    Create restorder if quantity received is less than ordered (default to false)

  • :fields (String) —

    Fields filter pattern (default to *)

Returns:



29
30
31
32
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 29

def confirm(id, opts = {})
  data, _status_code, _headers = confirm_with_http_info(id, opts)
  data
end

#confirm_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperPurchaseOrder, Fixnum, Hash)>

BETA

Confirm goods receipt. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

  • id —

    Purchase Order ID.

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

    the optional parameters

Options Hash (opts):

  • :create_rest_order (BOOLEAN) —

    Create restorder if quantity received is less than ordered

  • :fields (String) —

    Fields filter pattern

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 41

def confirm_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptApi.confirm ...'
  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 PurchaseOrdergoodsReceiptApi.confirm"
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceipt/{id}/:confirm'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'createRestOrder'] = opts[:'create_rest_order'] if !opts[:'create_rest_order'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].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 = 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 => 'ResponseWrapperPurchaseOrder')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PurchaseOrdergoodsReceiptApi#confirm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

BETA

Delete goods receipt by ID. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

  • (nil) 


85
86
87
88
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 85

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

#delete_by_ids(ids, opts = {}) ⇒ nil

BETA

Delete multiple goods receipt by ID. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

  • ids —

    ID of the elements

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

    the optional parameters

Returns:

  • (nil) 


134
135
136
137
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 134

def delete_by_ids(ids, opts = {})
  delete_by_ids_with_http_info(ids, opts)
  nil
end

#delete_by_ids_with_http_info(ids, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

BETA

Delete multiple goods receipt by ID. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

  • ids —

    ID of the elements

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 144

def delete_by_ids_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptApi.delete_by_ids ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling PurchaseOrdergoodsReceiptApi.delete_by_ids"
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceipt/list'

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

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

BETA

Delete goods receipt by ID. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

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

BETA

Get goods receipt by purchase order ID. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



185
186
187
188
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 185

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

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

BETA

Get goods receipt by purchase order ID. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 196

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptApi.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 PurchaseOrdergoodsReceiptApi.get"
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceipt/{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 => 'ResponseWrapperGoodsReceipt')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PurchaseOrdergoodsReceiptApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post(opts = {}) ⇒ ResponseWrapperGoodsReceipt

BETA

Register goods receipt without an existing purchase order. When registration of several goods receipt, use /list for better performance. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (GoodsReceipt) —

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

  • :fields (String) —

    Fields filter pattern (default to *)

Returns:



238
239
240
241
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 238

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

#post_list(opts = {}) ⇒ ListResponseGoodsReceipt

BETA

Register multiple goods receipt without an existing purchase order. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<GoodsReceipt>) —

    JSON representing a list of new object to be created. Should not have ID and version set.

  • :fields (String) —

    Fields filter pattern (default to *)

Returns:



289
290
291
292
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 289

def post_list(opts = {})
  data, _status_code, _headers = post_list_with_http_info(opts)
  data
end

#post_list_with_http_info(opts = {}) ⇒ Array<(ListResponseGoodsReceipt, Fixnum, Hash)>

BETA

Register multiple goods receipt without an existing purchase order. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<GoodsReceipt>) —

    JSON representing a list of new object to be created. Should not have ID and version set.

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseGoodsReceipt data, response status code and response headers



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 300

def post_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptApi.post_list ...'
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceipt/list'

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

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

BETA

Register goods receipt without an existing purchase order. When registration of several goods receipt, use /list for better performance. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (GoodsReceipt) —

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

  • :fields (String) —

    Fields filter pattern

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 249

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptApi.post ...'
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceipt'

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

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

BETA

Update goods receipt. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

  • id —

    Goods Receipt ID.

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

    the optional parameters

Options Hash (opts):

  • :body (GoodsReceipt) —

    Partial object describing what should be updated

  • :fields (String) —

    Fields filter pattern (default to *)

Returns:



341
342
343
344
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 341

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

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

BETA

Update goods receipt. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

  • id —

    Goods Receipt ID.

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

    the optional parameters

Options Hash (opts):

  • :body (GoodsReceipt) —

    Partial object describing what should be updated

  • :fields (String) —

    Fields filter pattern

Returns:



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
388
389
390
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 353

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

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

#receive_and_confirm(id, received_date, opts = {}) ⇒ ResponseWrapperPurchaseOrder

BETA

Receive all ordered products and approve goods receipt. Only available for users that have activated the Logistics/Logistics Plus Beta-program in ‘Our customer account’

Parameters:

  • id —

    Purchase Order ID.

  • received_date —

    The approval date for the subscription.

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

    the optional parameters

Options Hash (opts):

  • :inventory_id (Integer) —

    ID of inventory. Main inventory is set as default

  • :fields (String) —

    Fields filter pattern (default to *)

Returns:



399
400
401
402
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 399

def receive_and_confirm(id, received_date, opts = {})
  data, _status_code, _headers = receive_and_confirm_with_http_info(id, received_date, opts)
  data
end

#receive_and_confirm_with_http_info(id, received_date, opts = {}) ⇒ Array<(ResponseWrapperPurchaseOrder, Fixnum, Hash)>

BETA

Receive all ordered products and approve goods receipt. Only available for users that have activated the Logistics/Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

  • id —

    Purchase Order ID.

  • received_date —

    The approval date for the subscription.

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

    the optional parameters

Options Hash (opts):

  • :inventory_id (Integer) —

    ID of inventory. Main inventory is set as default

  • :fields (String) —

    Fields filter pattern

Returns:



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
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 412

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

  # query parameters
  query_params = {}
  query_params[:'receivedDate'] = received_date
  query_params[:'inventoryId'] = opts[:'inventory_id'] if !opts[:'inventory_id'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].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 = 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 => 'ResponseWrapperPurchaseOrder')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PurchaseOrdergoodsReceiptApi#receive_and_confirm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#register_goods_receipt(id, registration_date, opts = {}) ⇒ ResponseWrapperGoodsReceipt

BETA

Register goods receipt. Quantity received on the products is set to the same as quantity ordered. To update the quantity received, use PUT /purchaseOrder/goodsReceiptLine/id. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

  • id —

    Purchase Order ID.

  • registration_date —

    yyyy-MM-dd. Defaults to today.

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

    the optional parameters

Options Hash (opts):

  • :inventory_id (Integer) —

    ID of inventory. Main inventory is set as default

  • :comment (String) —

    Containing

  • :fields (String) —

    Fields filter pattern (default to *)

Returns:



465
466
467
468
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 465

def register_goods_receipt(id, registration_date, opts = {})
  data, _status_code, _headers = register_goods_receipt_with_http_info(id, registration_date, opts)
  data
end

#register_goods_receipt_with_http_info(id, registration_date, opts = {}) ⇒ Array<(ResponseWrapperGoodsReceipt, Fixnum, Hash)>

BETA

Register goods receipt. Quantity received on the products is set to the same as quantity ordered. To update the quantity received, use PUT /purchaseOrder/goodsReceiptLine/id. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

  • id —

    Purchase Order ID.

  • registration_date —

    yyyy-MM-dd. Defaults to today.

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

    the optional parameters

Options Hash (opts):

  • :inventory_id (Integer) —

    ID of inventory. Main inventory is set as default

  • :comment (String) —

    Containing

  • :fields (String) —

    Fields filter pattern

Returns:



479
480
481
482
483
484
485
486
487
488
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
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 479

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

  # query parameters
  query_params = {}
  query_params[:'registrationDate'] = registration_date
  query_params[:'inventoryId'] = opts[:'inventory_id'] if !opts[:'inventory_id'].nil?
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].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 = 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 => 'ResponseWrapperGoodsReceipt')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PurchaseOrdergoodsReceiptApi#register_goods_receipt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseGoodsReceipt

BETA

Get goods receipt. Only available for users that have activated the Logistics Plus Beta-program in ‘Our customer account’

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :received_date_from (String) —

    Format is yyyy-MM-dd (from and incl.).

  • :received_date_to (String) —

    Format is yyyy-MM-dd (to and incl.).

  • :status (String) —

    Equals

  • :without_purchase (BOOLEAN) —

    Equals (default to false)

  • :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:



536
537
538
539
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 536

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

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

BETA

Get goods receipt. Only available for users that have activated the Logistics Plus Beta-program in &#39;Our customer account&#39;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :received_date_from (String) —

    Format is yyyy-MM-dd (from and incl.).

  • :received_date_to (String) —

    Format is yyyy-MM-dd (to and incl.).

  • :status (String) —

    Equals

  • :without_purchase (BOOLEAN) —

    Equals

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseGoodsReceipt data, response status code and response headers



553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/tripletex_ruby_client/api/purchase_ordergoods_receipt_api.rb', line 553

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PurchaseOrdergoodsReceiptApi.search ...'
  end
  if @api_client.config.client_side_validation && opts[:'status'] && !['STATUS_OPEN', 'STATUS_CONFIRMED'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of STATUS_OPEN, STATUS_CONFIRMED'
  end
  # resource path
  local_var_path = '/purchaseOrder/goodsReceipt'

  # query parameters
  query_params = {}
  query_params[:'receivedDateFrom'] = opts[:'received_date_from'] if !opts[:'received_date_from'].nil?
  query_params[:'receivedDateTo'] = opts[:'received_date_to'] if !opts[:'received_date_to'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'withoutPurchase'] = opts[:'without_purchase'] if !opts[:'without_purchase'].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 => 'ListResponseGoodsReceipt')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PurchaseOrdergoodsReceiptApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end