Class: NuvemfiscalSdkRuby::MdfeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MdfeApi

Returns a new instance of MdfeApi.



19
20
21
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_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/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#baixar_pdf_cancelamento_mdfe(id, opts = {}) ⇒ File

Baixar PDF do cancelamento

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (File) 


26
27
28
29
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 26

def baixar_pdf_cancelamento_mdfe(id, opts = {})
  data, _status_code, _headers = baixar_pdf_cancelamento_mdfe_with_http_info(id, opts)
  data
end

#baixar_pdf_cancelamento_mdfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Baixar PDF do cancelamento

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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

def baixar_pdf_cancelamento_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.baixar_pdf_cancelamento_mdfe ...'
  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 MdfeApi.baixar_pdf_cancelamento_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/cancelamento/pdf'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.baixar_pdf_cancelamento_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#baixar_pdf_cancelamento_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#baixar_pdf_encerramento_mdfe(id, opts = {}) ⇒ File

Baixar PDF do encerramento

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (File) 


87
88
89
90
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 87

def baixar_pdf_encerramento_mdfe(id, opts = {})
  data, _status_code, _headers = baixar_pdf_encerramento_mdfe_with_http_info(id, opts)
  data
end

#baixar_pdf_encerramento_mdfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Baixar PDF do encerramento

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 96

def baixar_pdf_encerramento_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.baixar_pdf_encerramento_mdfe ...'
  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 MdfeApi.baixar_pdf_encerramento_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/encerramento/pdf'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.baixar_pdf_encerramento_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#baixar_pdf_encerramento_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#baixar_pdf_evento_mdfe(id, opts = {}) ⇒ File

Baixar PDF do evento

Parameters:

  • id (String) —

    ID único do evento gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (File) 


148
149
150
151
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 148

def baixar_pdf_evento_mdfe(id, opts = {})
  data, _status_code, _headers = baixar_pdf_evento_mdfe_with_http_info(id, opts)
  data
end

#baixar_pdf_evento_mdfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Baixar PDF do evento

Parameters:

  • id (String) —

    ID único do evento gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 157

def baixar_pdf_evento_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.baixar_pdf_evento_mdfe ...'
  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 MdfeApi.baixar_pdf_evento_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/eventos/{id}/pdf'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.baixar_pdf_evento_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#baixar_pdf_evento_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#baixar_pdf_mdfe(id, opts = {}) ⇒ File

Baixar PDF do DAMDFE

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Options Hash (opts):

  • :logotipo (Boolean) —

    Imprime o documento com logotipo, desde que esteja cadastrado na empresa. (default to false)

Returns:

  • (File) 


210
211
212
213
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 210

def baixar_pdf_mdfe(id, opts = {})
  data, _status_code, _headers = baixar_pdf_mdfe_with_http_info(id, opts)
  data
end

#baixar_pdf_mdfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Baixar PDF do DAMDFE

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Options Hash (opts):

  • :logotipo (Boolean) —

    Imprime o documento com logotipo, desde que esteja cadastrado na empresa. (default to false)

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



220
221
222
223
224
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
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 220

def baixar_pdf_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.baixar_pdf_mdfe ...'
  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 MdfeApi.baixar_pdf_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/pdf'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.baixar_pdf_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#baixar_pdf_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#baixar_xml_cancelamento_mdfe(id, opts = {}) ⇒ File

Baixar XML do cancelamento

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (File) 


273
274
275
276
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 273

def baixar_xml_cancelamento_mdfe(id, opts = {})
  data, _status_code, _headers = baixar_xml_cancelamento_mdfe_with_http_info(id, opts)
  data
end

#baixar_xml_cancelamento_mdfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Baixar XML do cancelamento

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



282
283
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
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 282

def baixar_xml_cancelamento_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.baixar_xml_cancelamento_mdfe ...'
  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 MdfeApi.baixar_xml_cancelamento_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/cancelamento/xml'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.baixar_xml_cancelamento_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#baixar_xml_cancelamento_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#baixar_xml_encerramento_mdfe(id, opts = {}) ⇒ File

Baixar XML do encerramento

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (File) 


334
335
336
337
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 334

def baixar_xml_encerramento_mdfe(id, opts = {})
  data, _status_code, _headers = baixar_xml_encerramento_mdfe_with_http_info(id, opts)
  data
end

#baixar_xml_encerramento_mdfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Baixar XML do encerramento

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
388
389
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 343

def baixar_xml_encerramento_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.baixar_xml_encerramento_mdfe ...'
  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 MdfeApi.baixar_xml_encerramento_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/encerramento/xml'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.baixar_xml_encerramento_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#baixar_xml_encerramento_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#baixar_xml_evento_mdfe(id, opts = {}) ⇒ File

Baixar XML do evento

Parameters:

  • id (String) —

    ID único do evento gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (File) 


395
396
397
398
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 395

def baixar_xml_evento_mdfe(id, opts = {})
  data, _status_code, _headers = baixar_xml_evento_mdfe_with_http_info(id, opts)
  data
end

#baixar_xml_evento_mdfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Baixar XML do evento

Parameters:

  • id (String) —

    ID único do evento gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
444
445
446
447
448
449
450
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 404

def baixar_xml_evento_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.baixar_xml_evento_mdfe ...'
  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 MdfeApi.baixar_xml_evento_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/eventos/{id}/xml'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.baixar_xml_evento_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#baixar_xml_evento_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#baixar_xml_mdfe(id, opts = {}) ⇒ File

Baixar XML do MDF-e processado Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz ‘mdfeProc`). O XML só estará disponível nesse endpoint caso o manifesto tenha sido autorizado ou denegado pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /mdfe/id/xml/manifesto`.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (File) 


457
458
459
460
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 457

def baixar_xml_mdfe(id, opts = {})
  data, _status_code, _headers = baixar_xml_mdfe_with_http_info(id, opts)
  data
end

#baixar_xml_mdfe_manifesto(id, opts = {}) ⇒ File

Baixar XML do MDF-e Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ. O XML estará disponível nesse endpoint mesmo em casos que o manifesto tenha sido rejeitado.

Parameters:

  • id (String) —

    ID único da MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (File) 


520
521
522
523
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 520

def baixar_xml_mdfe_manifesto(id, opts = {})
  data, _status_code, _headers = baixar_xml_mdfe_manifesto_with_http_info(id, opts)
  data
end

#baixar_xml_mdfe_manifesto_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Baixar XML do MDF-e Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ. O XML estará disponível nesse endpoint mesmo em casos que o manifesto tenha sido rejeitado.

Parameters:

  • id (String) —

    ID único da MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 530

def baixar_xml_mdfe_manifesto_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.baixar_xml_mdfe_manifesto ...'
  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 MdfeApi.baixar_xml_mdfe_manifesto"
  end
  # resource path
  local_var_path = '/mdfe/{id}/xml/manifesto'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.baixar_xml_mdfe_manifesto",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#baixar_xml_mdfe_manifesto\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#baixar_xml_mdfe_protocolo(id, opts = {}) ⇒ File

Baixar XML do Protocolo da SEFAZ

Parameters:

  • id (String) —

    ID único da MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (File) 


582
583
584
585
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 582

def baixar_xml_mdfe_protocolo(id, opts = {})
  data, _status_code, _headers = baixar_xml_mdfe_protocolo_with_http_info(id, opts)
  data
end

#baixar_xml_mdfe_protocolo_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Baixar XML do Protocolo da SEFAZ

Parameters:

  • id (String) —

    ID único da MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 591

def baixar_xml_mdfe_protocolo_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.baixar_xml_mdfe_protocolo ...'
  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 MdfeApi.baixar_xml_mdfe_protocolo"
  end
  # resource path
  local_var_path = '/mdfe/{id}/xml/protocolo'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.baixar_xml_mdfe_protocolo",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#baixar_xml_mdfe_protocolo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#baixar_xml_mdfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Baixar XML do MDF-e processado Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz &#x60;mdfeProc&#x60;). O XML só estará disponível nesse endpoint caso o manifesto tenha sido autorizado ou denegado pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint &#x60;GET /mdfe/id/xml/manifesto&#x60;.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 467

def baixar_xml_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.baixar_xml_mdfe ...'
  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 MdfeApi.baixar_xml_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/xml'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.baixar_xml_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#baixar_xml_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cancelar_mdfe(id, opts = {}) ⇒ DfeCancelamento

Cancelar um MDF-e autorizado **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Options Hash (opts):

Returns:



645
646
647
648
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 645

def cancelar_mdfe(id, opts = {})
  data, _status_code, _headers = cancelar_mdfe_with_http_info(id, opts)
  data
end

#cancelar_mdfe_with_http_info(id, opts = {}) ⇒ Array<(DfeCancelamento, Integer, Hash)>

Cancelar um MDF-e autorizado **Informações adicionais**: - Cota: &lt;a href&#x3D;&quot;/docs/limites#dfe-eventos&quot;&gt;dfe-eventos&lt;/a&gt; - Consumo: 1 unidade por requisição.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DfeCancelamento, Integer, Hash)>) —

    DfeCancelamento data, response status code and response headers



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 656

def cancelar_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.cancelar_mdfe ...'
  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 MdfeApi.cancelar_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/cancelamento'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type] || 'DfeCancelamento'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.cancelar_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#cancelar_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_cancelamento_mdfe(id, opts = {}) ⇒ DfeCancelamento

Consultar o cancelamento do MDF-e

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



713
714
715
716
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 713

def consultar_cancelamento_mdfe(id, opts = {})
  data, _status_code, _headers = consultar_cancelamento_mdfe_with_http_info(id, opts)
  data
end

#consultar_cancelamento_mdfe_with_http_info(id, opts = {}) ⇒ Array<(DfeCancelamento, Integer, Hash)>

Consultar o cancelamento do MDF-e

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(DfeCancelamento, Integer, Hash)>) —

    DfeCancelamento data, response status code and response headers



722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 722

def consultar_cancelamento_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.consultar_cancelamento_mdfe ...'
  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 MdfeApi.consultar_cancelamento_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/cancelamento'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DfeCancelamento'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.consultar_cancelamento_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#consultar_cancelamento_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_encerramento_mdfe(id, opts = {}) ⇒ MdfeEncerramento

Consultar encerramento do MDF-e

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



774
775
776
777
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 774

def consultar_encerramento_mdfe(id, opts = {})
  data, _status_code, _headers = consultar_encerramento_mdfe_with_http_info(id, opts)
  data
end

#consultar_encerramento_mdfe_with_http_info(id, opts = {}) ⇒ Array<(MdfeEncerramento, Integer, Hash)>

Consultar encerramento do MDF-e

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(MdfeEncerramento, Integer, Hash)>) —

    MdfeEncerramento data, response status code and response headers



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
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 783

def consultar_encerramento_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.consultar_encerramento_mdfe ...'
  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 MdfeApi.consultar_encerramento_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/encerramento'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MdfeEncerramento'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.consultar_encerramento_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#consultar_encerramento_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_evento_mdfe(id, opts = {}) ⇒ DfeEvento

Consultar evento do MDF-e

Parameters:

  • id (String) —

    ID único do evento gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



835
836
837
838
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 835

def consultar_evento_mdfe(id, opts = {})
  data, _status_code, _headers = consultar_evento_mdfe_with_http_info(id, opts)
  data
end

#consultar_evento_mdfe_with_http_info(id, opts = {}) ⇒ Array<(DfeEvento, Integer, Hash)>

Consultar evento do MDF-e

Parameters:

  • id (String) —

    ID único do evento gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(DfeEvento, Integer, Hash)>) —

    DfeEvento data, response status code and response headers



844
845
846
847
848
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
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 844

def consultar_evento_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.consultar_evento_mdfe ...'
  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 MdfeApi.consultar_evento_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/eventos/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DfeEvento'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.consultar_evento_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#consultar_evento_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_lote_mdfe(id, opts = {}) ⇒ DfeLote

Consultar lote de MDF-e Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a Nuvem Fiscal irá retornar as informações do lote correspondente.

Parameters:

  • id (String) —

    ID único do lote gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



897
898
899
900
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 897

def consultar_lote_mdfe(id, opts = {})
  data, _status_code, _headers = consultar_lote_mdfe_with_http_info(id, opts)
  data
end

#consultar_lote_mdfe_with_http_info(id, opts = {}) ⇒ Array<(DfeLote, Integer, Hash)>

Consultar lote de MDF-e Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a Nuvem Fiscal irá retornar as informações do lote correspondente.

Parameters:

  • id (String) —

    ID único do lote gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(DfeLote, Integer, Hash)>) —

    DfeLote data, response status code and response headers



907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
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
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 907

def consultar_lote_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.consultar_lote_mdfe ...'
  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 MdfeApi.consultar_lote_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/lotes/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DfeLote'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.consultar_lote_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#consultar_lote_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_mdfe(id, opts = {}) ⇒ Dfe

Consultar manifesto Consulta os detalhes de um manifesto já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de manifestos e a Nuvem Fiscal irá retornar as informações do manifesto correspondente.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



960
961
962
963
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 960

def consultar_mdfe(id, opts = {})
  data, _status_code, _headers = consultar_mdfe_with_http_info(id, opts)
  data
end

#consultar_mdfe_nao_encerrados(cpf_cnpj, opts = {}) ⇒ MdfeNaoEncerrados

Consulta MDF-e não encerrados

Parameters:

  • cpf_cnpj (String) —

    CPF/CNPJ do emitente. Utilize o valor sem máscara.

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

    the optional parameters

Returns:



1022
1023
1024
1025
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1022

def consultar_mdfe_nao_encerrados(cpf_cnpj, opts = {})
  data, _status_code, _headers = consultar_mdfe_nao_encerrados_with_http_info(cpf_cnpj, opts)
  data
end

#consultar_mdfe_nao_encerrados_with_http_info(cpf_cnpj, opts = {}) ⇒ Array<(MdfeNaoEncerrados, Integer, Hash)>

Consulta MDF-e não encerrados

Parameters:

  • cpf_cnpj (String) —

    CPF/CNPJ do emitente. Utilize o valor sem máscara.

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

    the optional parameters

Returns:

  • (Array<(MdfeNaoEncerrados, Integer, Hash)>) —

    MdfeNaoEncerrados data, response status code and response headers



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
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1031

def consultar_mdfe_nao_encerrados_with_http_info(cpf_cnpj, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.consultar_mdfe_nao_encerrados ...'
  end
  # verify the required parameter 'cpf_cnpj' is set
  if @api_client.config.client_side_validation && cpf_cnpj.nil?
    fail ArgumentError, "Missing the required parameter 'cpf_cnpj' when calling MdfeApi.consultar_mdfe_nao_encerrados"
  end
  # resource path
  local_var_path = '/mdfe/nao-encerrados'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cpf_cnpj'] = cpf_cnpj

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MdfeNaoEncerrados'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.consultar_mdfe_nao_encerrados",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#consultar_mdfe_nao_encerrados\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_mdfe_with_http_info(id, opts = {}) ⇒ Array<(Dfe, Integer, Hash)>

Consultar manifesto Consulta os detalhes de um manifesto já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de manifestos e a Nuvem Fiscal irá retornar as informações do manifesto correspondente.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(Dfe, Integer, Hash)>) —

    Dfe data, response status code and response headers



970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 970

def consultar_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.consultar_mdfe ...'
  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 MdfeApi.consultar_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Dfe'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.consultar_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#consultar_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#consultar_status_sefaz_mdfe(cpf_cnpj, opts = {}) ⇒ DfeSefazStatus

Consulta do Status do Serviço na SEFAZ Autorizadora Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual. A Nuvem Fiscal mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 3.0.0a, item 4.6.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).

Parameters:

  • cpf_cnpj (String) —

    CPF/CNPJ do emitente. Utilize o valor sem máscara.

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

    the optional parameters

Options Hash (opts):

  • :autorizador (String) —

    Ambiente Autorizador. Autorizadores disponíveis: &#x60;SVRS&#x60;. *Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*

Returns:



1086
1087
1088
1089
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1086

def consultar_status_sefaz_mdfe(cpf_cnpj, opts = {})
  data, _status_code, _headers = consultar_status_sefaz_mdfe_with_http_info(cpf_cnpj, opts)
  data
end

#consultar_status_sefaz_mdfe_with_http_info(cpf_cnpj, opts = {}) ⇒ Array<(DfeSefazStatus, Integer, Hash)>

Consulta do Status do Serviço na SEFAZ Autorizadora Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual. A Nuvem Fiscal mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 3.0.0a, item 4.6.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).

Parameters:

  • cpf_cnpj (String) —

    CPF/CNPJ do emitente. Utilize o valor sem máscara.

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

    the optional parameters

Options Hash (opts):

  • :autorizador (String) —

    Ambiente Autorizador. Autorizadores disponíveis: &#x60;SVRS&#x60;. *Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*

Returns:

  • (Array<(DfeSefazStatus, Integer, Hash)>) —

    DfeSefazStatus data, response status code and response headers



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1097

def consultar_status_sefaz_mdfe_with_http_info(cpf_cnpj, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.consultar_status_sefaz_mdfe ...'
  end
  # verify the required parameter 'cpf_cnpj' is set
  if @api_client.config.client_side_validation && cpf_cnpj.nil?
    fail ArgumentError, "Missing the required parameter 'cpf_cnpj' when calling MdfeApi.consultar_status_sefaz_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/sefaz/status'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DfeSefazStatus'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.consultar_status_sefaz_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#consultar_status_sefaz_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#emitir_lote_mdfe(body, opts = {}) ⇒ DfeLote

Emitir lote de MDF-e **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por MDF-e.

Parameters:

Returns:



1152
1153
1154
1155
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1152

def emitir_lote_mdfe(body, opts = {})
  data, _status_code, _headers = emitir_lote_mdfe_with_http_info(body, opts)
  data
end

#emitir_lote_mdfe_with_http_info(body, opts = {}) ⇒ Array<(DfeLote, Integer, Hash)>

Emitir lote de MDF-e **Informações adicionais**: - Cota: &lt;a href&#x3D;&quot;/docs/limites#dfe-eventos&quot;&gt;dfe-eventos&lt;/a&gt; - Consumo: 1 unidade por MDF-e.

Parameters:

Returns:

  • (Array<(DfeLote, Integer, Hash)>) —

    DfeLote data, response status code and response headers



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
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1162

def emitir_lote_mdfe_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.emitir_lote_mdfe ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MdfeApi.emitir_lote_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/lotes'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'DfeLote'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.emitir_lote_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#emitir_lote_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#emitir_mdfe(body, opts = {}) ⇒ Dfe

Emitir MDF-e **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.

Parameters:

Returns:



1220
1221
1222
1223
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1220

def emitir_mdfe(body, opts = {})
  data, _status_code, _headers = emitir_mdfe_with_http_info(body, opts)
  data
end

#emitir_mdfe_with_http_info(body, opts = {}) ⇒ Array<(Dfe, Integer, Hash)>

Emitir MDF-e **Informações adicionais**: - Cota: &lt;a href&#x3D;&quot;/docs/limites#dfe-eventos&quot;&gt;dfe-eventos&lt;/a&gt; - Consumo: 1 unidade por requisição.

Parameters:

Returns:

  • (Array<(Dfe, Integer, Hash)>) —

    Dfe data, response status code and response headers



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
1278
1279
1280
1281
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1230

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Dfe'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.emitir_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#emitir_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#encerrar_mdfe(id, body, opts = {}) ⇒ MdfeEncerramento

Encerrar um MDF-e autorizado **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



1289
1290
1291
1292
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1289

def encerrar_mdfe(id, body, opts = {})
  data, _status_code, _headers = encerrar_mdfe_with_http_info(id, body, opts)
  data
end

#encerrar_mdfe_with_http_info(id, body, opts = {}) ⇒ Array<(MdfeEncerramento, Integer, Hash)>

Encerrar um MDF-e autorizado **Informações adicionais**: - Cota: &lt;a href&#x3D;&quot;/docs/limites#dfe-eventos&quot;&gt;dfe-eventos&lt;/a&gt; - Consumo: 1 unidade por requisição.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(MdfeEncerramento, Integer, Hash)>) —

    MdfeEncerramento data, response status code and response headers



1300
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
1353
1354
1355
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1300

def encerrar_mdfe_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.encerrar_mdfe ...'
  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 MdfeApi.encerrar_mdfe"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MdfeApi.encerrar_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/encerramento'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'MdfeEncerramento'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.encerrar_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#encerrar_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#incluir_condutor_mdfe(id, body, opts = {}) ⇒ MdfeInclusaoCondutor

Incluir um condutor em um MDF-e autorizado **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



1363
1364
1365
1366
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1363

def incluir_condutor_mdfe(id, body, opts = {})
  data, _status_code, _headers = incluir_condutor_mdfe_with_http_info(id, body, opts)
  data
end

#incluir_condutor_mdfe_with_http_info(id, body, opts = {}) ⇒ Array<(MdfeInclusaoCondutor, Integer, Hash)>

Incluir um condutor em um MDF-e autorizado **Informações adicionais**: - Cota: &lt;a href&#x3D;&quot;/docs/limites#dfe-eventos&quot;&gt;dfe-eventos&lt;/a&gt; - Consumo: 1 unidade por requisição.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(MdfeInclusaoCondutor, Integer, Hash)>) —

    MdfeInclusaoCondutor data, response status code and response headers



1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
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
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1374

def incluir_condutor_mdfe_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.incluir_condutor_mdfe ...'
  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 MdfeApi.incluir_condutor_mdfe"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MdfeApi.incluir_condutor_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/inclusao-condutor'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'MdfeInclusaoCondutor'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.incluir_condutor_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#incluir_condutor_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#incluir_dfe_mdfe(id, body, opts = {}) ⇒ MdfeInclusaoDfe

Incluir um DF-e em um MDF-e autorizado **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



1437
1438
1439
1440
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1437

def incluir_dfe_mdfe(id, body, opts = {})
  data, _status_code, _headers = incluir_dfe_mdfe_with_http_info(id, body, opts)
  data
end

#incluir_dfe_mdfe_with_http_info(id, body, opts = {}) ⇒ Array<(MdfeInclusaoDfe, Integer, Hash)>

Incluir um DF-e em um MDF-e autorizado **Informações adicionais**: - Cota: &lt;a href&#x3D;&quot;/docs/limites#dfe-eventos&quot;&gt;dfe-eventos&lt;/a&gt; - Consumo: 1 unidade por requisição.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(MdfeInclusaoDfe, Integer, Hash)>) —

    MdfeInclusaoDfe data, response status code and response headers



1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1448

def incluir_dfe_mdfe_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.incluir_dfe_mdfe ...'
  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 MdfeApi.incluir_dfe_mdfe"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MdfeApi.incluir_dfe_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/inclusao-dfe'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'MdfeInclusaoDfe'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.incluir_dfe_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#incluir_dfe_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#listar_lotes_mdfe(cpf_cnpj, ambiente, opts = {}) ⇒ DfeLoteListagem

Listar lotes de MDF-e Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Parameters:

  • cpf_cnpj (String) —

    Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.

  • ambiente (String) —

    Identificação do Ambiente. Valores aceitos: homologacao, producao

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

    the optional parameters

Options Hash (opts):

  • :top (Integer) —

    Limite no número de objetos a serem retornados pela API, entre 1 e 100. (default to 10)

  • :skip (Integer) —

    Quantidade de objetos que serão ignorados antes da lista começar a ser retornada. (default to 0)

  • :inlinecount (Boolean) —

    Inclui no JSON de resposta, na propriedade &#x60;@count&#x60;, o número total de registros que o filtro retornaria, independente dos filtros de paginação. (default to false)

  • :referencia (String)

Returns:



1515
1516
1517
1518
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1515

def listar_lotes_mdfe(cpf_cnpj, ambiente, opts = {})
  data, _status_code, _headers = listar_lotes_mdfe_with_http_info(cpf_cnpj, ambiente, opts)
  data
end

#listar_lotes_mdfe_with_http_info(cpf_cnpj, ambiente, opts = {}) ⇒ Array<(DfeLoteListagem, Integer, Hash)>

Listar lotes de MDF-e Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Parameters:

  • cpf_cnpj (String) —

    Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.

  • ambiente (String) —

    Identificação do Ambiente. Valores aceitos: homologacao, producao

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

    the optional parameters

Options Hash (opts):

  • :top (Integer) —

    Limite no número de objetos a serem retornados pela API, entre 1 e 100. (default to 10)

  • :skip (Integer) —

    Quantidade de objetos que serão ignorados antes da lista começar a ser retornada. (default to 0)

  • :inlinecount (Boolean) —

    Inclui no JSON de resposta, na propriedade &#x60;@count&#x60;, o número total de registros que o filtro retornaria, independente dos filtros de paginação. (default to false)

  • :referencia (String)

Returns:

  • (Array<(DfeLoteListagem, Integer, Hash)>) —

    DfeLoteListagem data, response status code and response headers



1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1530

def listar_lotes_mdfe_with_http_info(cpf_cnpj, ambiente, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.listar_lotes_mdfe ...'
  end
  # verify the required parameter 'cpf_cnpj' is set
  if @api_client.config.client_side_validation && cpf_cnpj.nil?
    fail ArgumentError, "Missing the required parameter 'cpf_cnpj' when calling MdfeApi.listar_lotes_mdfe"
  end
  # verify the required parameter 'ambiente' is set
  if @api_client.config.client_side_validation && ambiente.nil?
    fail ArgumentError, "Missing the required parameter 'ambiente' when calling MdfeApi.listar_lotes_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/lotes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cpf_cnpj'] = cpf_cnpj
  query_params[:'ambiente'] = ambiente
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'referencia'] = opts[:'referencia'] if !opts[:'referencia'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DfeLoteListagem'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.listar_lotes_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#listar_lotes_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#listar_mdfe(cpf_cnpj, ambiente, opts = {}) ⇒ DfeListagem

Listar MDF-e Retorna a lista de manifestos de acordo com os critérios de busca utilizados. Os manifestos são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Parameters:

  • cpf_cnpj (String) —

    Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.

  • ambiente (String) —

    Identificação do Ambiente. Valores aceitos: homologacao, producao

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

    the optional parameters

Options Hash (opts):

  • :top (Integer) —

    Limite no número de objetos a serem retornados pela API, entre 1 e 100. (default to 10)

  • :skip (Integer) —

    Quantidade de objetos que serão ignorados antes da lista começar a ser retornada. (default to 0)

  • :inlinecount (Boolean) —

    Inclui no JSON de resposta, na propriedade &#x60;@count&#x60;, o número total de registros que o filtro retornaria, independente dos filtros de paginação. (default to false)

  • :referencia (String) —

    Seu identificador único para o documento.

  • :chave (String) —

    Chave de acesso do DF-e.

  • :serie (String) —

    Série do DF-e.

Returns:



1600
1601
1602
1603
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1600

def listar_mdfe(cpf_cnpj, ambiente, opts = {})
  data, _status_code, _headers = listar_mdfe_with_http_info(cpf_cnpj, ambiente, opts)
  data
end

#listar_mdfe_with_http_info(cpf_cnpj, ambiente, opts = {}) ⇒ Array<(DfeListagem, Integer, Hash)>

Listar MDF-e Retorna a lista de manifestos de acordo com os critérios de busca utilizados. Os manifestos são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Parameters:

  • cpf_cnpj (String) —

    Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.

  • ambiente (String) —

    Identificação do Ambiente. Valores aceitos: homologacao, producao

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

    the optional parameters

Options Hash (opts):

  • :top (Integer) —

    Limite no número de objetos a serem retornados pela API, entre 1 e 100. (default to 10)

  • :skip (Integer) —

    Quantidade de objetos que serão ignorados antes da lista começar a ser retornada. (default to 0)

  • :inlinecount (Boolean) —

    Inclui no JSON de resposta, na propriedade &#x60;@count&#x60;, o número total de registros que o filtro retornaria, independente dos filtros de paginação. (default to false)

  • :referencia (String) —

    Seu identificador único para o documento.

  • :chave (String) —

    Chave de acesso do DF-e.

  • :serie (String) —

    Série do DF-e.

Returns:

  • (Array<(DfeListagem, Integer, Hash)>) —

    DfeListagem data, response status code and response headers



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
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1617

def listar_mdfe_with_http_info(cpf_cnpj, ambiente, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.listar_mdfe ...'
  end
  # verify the required parameter 'cpf_cnpj' is set
  if @api_client.config.client_side_validation && cpf_cnpj.nil?
    fail ArgumentError, "Missing the required parameter 'cpf_cnpj' when calling MdfeApi.listar_mdfe"
  end
  # verify the required parameter 'ambiente' is set
  if @api_client.config.client_side_validation && ambiente.nil?
    fail ArgumentError, "Missing the required parameter 'ambiente' when calling MdfeApi.listar_mdfe"
  end
  # resource path
  local_var_path = '/mdfe'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cpf_cnpj'] = cpf_cnpj
  query_params[:'ambiente'] = ambiente
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$inlinecount'] = opts[:'inlinecount'] if !opts[:'inlinecount'].nil?
  query_params[:'referencia'] = opts[:'referencia'] if !opts[:'referencia'].nil?
  query_params[:'chave'] = opts[:'chave'] if !opts[:'chave'].nil?
  query_params[:'serie'] = opts[:'serie'] if !opts[:'serie'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DfeListagem'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.listar_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#listar_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sincronizar_mdfe(id, opts = {}) ⇒ DfeSincronizacao

Sincroniza dados no MDF-e a partir da SEFAZ Realiza a sincronização dos dados a partir da consulta da situação atual da MDF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual. **Cenários de uso**: * Sincronizar um manifesto que se encontra com o status ‘erro` na Nuvem Fiscal, mas está autorizado na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts). * Sincronizar um manifesto que se encontra com o status `autorizado`na Nuvem Fiscal, mas está cancelado ou encerrado na SEFAZ. * Sincronizar todos os eventos de Cancelamento, Encerramento, Inclusão de condutor e Inclusão de DF-e de um manifesto que porventura não tenham sido feitos a partir da Nuvem Fiscal. **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por evento sincronizado ou requisição.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



1682
1683
1684
1685
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1682

def sincronizar_mdfe(id, opts = {})
  data, _status_code, _headers = sincronizar_mdfe_with_http_info(id, opts)
  data
end

#sincronizar_mdfe_with_http_info(id, opts = {}) ⇒ Array<(DfeSincronizacao, Integer, Hash)>

Sincroniza dados no MDF-e a partir da SEFAZ Realiza a sincronização dos dados a partir da consulta da situação atual da MDF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual. **Cenários de uso**: * Sincronizar um manifesto que se encontra com o status &#x60;erro&#x60; na Nuvem Fiscal, mas está autorizado na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts). * Sincronizar um manifesto que se encontra com o status &#x60;autorizado&#x60;na Nuvem Fiscal, mas está cancelado ou encerrado na SEFAZ. * Sincronizar todos os eventos de Cancelamento, Encerramento, Inclusão de condutor e Inclusão de DF-e de um manifesto que porventura não tenham sido feitos a partir da Nuvem Fiscal. **Informações adicionais**: - Cota: &lt;a href&#x3D;&quot;/docs/limites#dfe-eventos&quot;&gt;dfe-eventos&lt;/a&gt; - Consumo: 1 unidade por evento sincronizado ou requisição.

Parameters:

  • id (String) —

    ID único do MDF-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

  • (Array<(DfeSincronizacao, Integer, Hash)>) —

    DfeSincronizacao data, response status code and response headers



1692
1693
1694
1695
1696
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
 
# File 'lib/nuvemfiscal_sdk_ruby/api/mdfe_api.rb', line 1692

def sincronizar_mdfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MdfeApi.sincronizar_mdfe ...'
  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 MdfeApi.sincronizar_mdfe"
  end
  # resource path
  local_var_path = '/mdfe/{id}/sincronizar'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DfeSincronizacao'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2']

  new_options = opts.merge(
    :operation => :"MdfeApi.sincronizar_mdfe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MdfeApi#sincronizar_mdfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end