Class: NuvemfiscalSdkRuby::CteApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CteApi

Returns a new instance of CteApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Baixar PDF do cancelamento

Parameters:

  • id (String) —

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

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

    the optional parameters

Returns:

  • (File) 


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

def baixar_pdf_cancelamento_cte(id, opts = {})
  data, _status_code, _headers = baixar_pdf_cancelamento_cte_with_http_info(id, opts)
  data
end

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

Baixar PDF do cancelamento

Parameters:

  • id (String) —

    ID único do CT-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/cte_api.rb', line 35

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

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

Baixar PDF da carta de correção

Parameters:

  • id (String) —

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

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

    the optional parameters

Returns:

  • (File) 


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

def baixar_pdf_carta_correcao_cte(id, opts = {})
  data, _status_code, _headers = baixar_pdf_carta_correcao_cte_with_http_info(id, opts)
  data
end

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

Baixar PDF da carta de correção

Parameters:

  • id (String) —

    ID único do CT-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/cte_api.rb', line 96

def baixar_pdf_carta_correcao_cte_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CteApi.baixar_pdf_carta_correcao_cte ...'
  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 CteApi.baixar_pdf_carta_correcao_cte"
  end
  # resource path
  local_var_path = '/cte/{id}/carta-correcao/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 => :"CteApi.baixar_pdf_carta_correcao_cte",
    :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: CteApi#baixar_pdf_carta_correcao_cte\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Baixar PDF do DACTE

Parameters:

  • id (String) —

    ID único do CT-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) 


149
150
151
152
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 149

def baixar_pdf_cte(id, opts = {})
  data, _status_code, _headers = baixar_pdf_cte_with_http_info(id, opts)
  data
end

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

Baixar PDF do DACTE

Parameters:

  • id (String) —

    ID único do CT-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



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
204
205
206
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 159

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

#baixar_pdf_evento_cte(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) 


212
213
214
215
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 212

def baixar_pdf_evento_cte(id, opts = {})
  data, _status_code, _headers = baixar_pdf_evento_cte_with_http_info(id, opts)
  data
end

#baixar_pdf_evento_cte_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



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/cte_api.rb', line 221

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

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

Baixar XML do cancelamento

Parameters:

  • id (String) —

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

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

    the optional parameters

Returns:

  • (File) 


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

def baixar_xml_cancelamento_cte(id, opts = {})
  data, _status_code, _headers = baixar_xml_cancelamento_cte_with_http_info(id, opts)
  data
end

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

Baixar XML do cancelamento

Parameters:

  • id (String) —

    ID único do CT-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/cte_api.rb', line 282

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

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

Baixar XML da carta de correção

Parameters:

  • id (String) —

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

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

    the optional parameters

Returns:

  • (File) 


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

def baixar_xml_carta_correcao_cte(id, opts = {})
  data, _status_code, _headers = baixar_xml_carta_correcao_cte_with_http_info(id, opts)
  data
end

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

Baixar XML da carta de correção

Parameters:

  • id (String) —

    ID único do CT-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/cte_api.rb', line 343

def baixar_xml_carta_correcao_cte_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CteApi.baixar_xml_carta_correcao_cte ...'
  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 CteApi.baixar_xml_carta_correcao_cte"
  end
  # resource path
  local_var_path = '/cte/{id}/carta-correcao/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 => :"CteApi.baixar_xml_carta_correcao_cte",
    :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: CteApi#baixar_xml_carta_correcao_cte\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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

Parameters:

  • id (String) —

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

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

    the optional parameters

Returns:

  • (File) 


396
397
398
399
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 396

def baixar_xml_cte(id, opts = {})
  data, _status_code, _headers = baixar_xml_cte_with_http_info(id, opts)
  data
end

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

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

Parameters:

  • id (String) —

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

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

    the optional parameters

Returns:

  • (File) 


459
460
461
462
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 459

def baixar_xml_cte_conhecimento(id, opts = {})
  data, _status_code, _headers = baixar_xml_cte_conhecimento_with_http_info(id, opts)
  data
end

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

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

Parameters:

  • id (String) —

    ID único da CT-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



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
514
515
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 469

def baixar_xml_cte_conhecimento_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CteApi.baixar_xml_cte_conhecimento ...'
  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 CteApi.baixar_xml_cte_conhecimento"
  end
  # resource path
  local_var_path = '/cte/{id}/xml/conhecimento'.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 => :"CteApi.baixar_xml_cte_conhecimento",
    :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: CteApi#baixar_xml_cte_conhecimento\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Baixar XML do Protocolo da SEFAZ

Parameters:

  • id (String) —

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

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

    the optional parameters

Returns:

  • (File) 


521
522
523
524
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 521

def baixar_xml_cte_protocolo(id, opts = {})
  data, _status_code, _headers = baixar_xml_cte_protocolo_with_http_info(id, opts)
  data
end

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

Baixar XML do Protocolo da SEFAZ

Parameters:

  • id (String) —

    ID único da CT-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/cte_api.rb', line 530

def baixar_xml_cte_protocolo_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CteApi.baixar_xml_cte_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 CteApi.baixar_xml_cte_protocolo"
  end
  # resource path
  local_var_path = '/cte/{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 => :"CteApi.baixar_xml_cte_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: CteApi#baixar_xml_cte_protocolo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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

Parameters:

  • id (String) —

    ID único do CT-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



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
451
452
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 406

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

#baixar_xml_evento_cte(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) 


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

def baixar_xml_evento_cte(id, opts = {})
  data, _status_code, _headers = baixar_xml_evento_cte_with_http_info(id, opts)
  data
end

#baixar_xml_evento_cte_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



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/cte_api.rb', line 591

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

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

Cancelar um CT-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 CT-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/cte_api.rb', line 645

def cancelar_cte(id, opts = {})
  data, _status_code, _headers = cancelar_cte_with_http_info(id, opts)
  data
end

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

Cancelar um CT-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 CT-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/cte_api.rb', line 656

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

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

Consultar o cancelamento do CT-e

Parameters:

  • id (String) —

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

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

    the optional parameters

Returns:



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

def consultar_cancelamento_cte(id, opts = {})
  data, _status_code, _headers = consultar_cancelamento_cte_with_http_info(id, opts)
  data
end

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

Consultar o cancelamento do CT-e

Parameters:

  • id (String) —

    ID único do CT-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/cte_api.rb', line 722

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

#consultar_carta_correcao_cte(id, opts = {}) ⇒ CteCartaCorrecao

Consultar a solicitação de correção do CT-e

Parameters:

  • id (String) —

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

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

    the optional parameters

Returns:



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

def consultar_carta_correcao_cte(id, opts = {})
  data, _status_code, _headers = consultar_carta_correcao_cte_with_http_info(id, opts)
  data
end

#consultar_carta_correcao_cte_with_http_info(id, opts = {}) ⇒ Array<(CteCartaCorrecao, Integer, Hash)>

Consultar a solicitação de correção do CT-e

Parameters:

  • id (String) —

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

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

    the optional parameters

Returns:

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

    CteCartaCorrecao 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/cte_api.rb', line 783

def consultar_carta_correcao_cte_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CteApi.consultar_carta_correcao_cte ...'
  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 CteApi.consultar_carta_correcao_cte"
  end
  # resource path
  local_var_path = '/cte/{id}/carta-correcao'.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] || 'CteCartaCorrecao'

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

  new_options = opts.merge(
    :operation => :"CteApi.consultar_carta_correcao_cte",
    :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: CteApi#consultar_carta_correcao_cte\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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

Parameters:

  • id (String) —

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

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

    the optional parameters

Returns:



836
837
838
839
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 836

def consultar_cte(id, opts = {})
  data, _status_code, _headers = consultar_cte_with_http_info(id, opts)
  data
end

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

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

Parameters:

  • id (String) —

    ID único do CT-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



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
891
892
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 846

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

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

Consultar evento

Parameters:

  • id (String) —

    ID único do evento gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



898
899
900
901
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 898

def consultar_evento_cte(id, opts = {})
  data, _status_code, _headers = consultar_evento_cte_with_http_info(id, opts)
  data
end

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

Consultar evento

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



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/cte_api.rb', line 907

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

#consultar_status_sefaz_cte(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;MT&#x60;, &#x60;MS&#x60;, &#x60;MG&#x60;, &#x60;PR&#x60;, &#x60;RS&#x60;, &#x60;SP&#x60;, &#x60;SVRS&#x60;, &#x60;SVSP&#x60;, &#x60;AN&#x60;. *Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*

Returns:



961
962
963
964
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 961

def consultar_status_sefaz_cte(cpf_cnpj, opts = {})
  data, _status_code, _headers = consultar_status_sefaz_cte_with_http_info(cpf_cnpj, opts)
  data
end

#consultar_status_sefaz_cte_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;MT&#x60;, &#x60;MS&#x60;, &#x60;MG&#x60;, &#x60;PR&#x60;, &#x60;RS&#x60;, &#x60;SP&#x60;, &#x60;SVRS&#x60;, &#x60;SVSP&#x60;, &#x60;AN&#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



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
1017
1018
1019
1020
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 972

def consultar_status_sefaz_cte_with_http_info(cpf_cnpj, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CteApi.consultar_status_sefaz_cte ...'
  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 CteApi.consultar_status_sefaz_cte"
  end
  # resource path
  local_var_path = '/cte/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 => :"CteApi.consultar_status_sefaz_cte",
    :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: CteApi#consultar_status_sefaz_cte\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#criar_carta_correcao_cte(id, body, opts = {}) ⇒ CteCartaCorrecao

Solicitar correção do CT-e É possível enviar até 20 correções diferentes, sendo que será válido sempre a última correção enviada. **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 CT-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



1028
1029
1030
1031
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 1028

def criar_carta_correcao_cte(id, body, opts = {})
  data, _status_code, _headers = criar_carta_correcao_cte_with_http_info(id, body, opts)
  data
end

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

Solicitar correção do CT-e É possível enviar até 20 correções diferentes, sendo que será válido sempre a última correção enviada. **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 CT-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:

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

    CteCartaCorrecao data, response status code and response headers



1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 1039

def criar_carta_correcao_cte_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CteApi.criar_carta_correcao_cte ...'
  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 CteApi.criar_carta_correcao_cte"
  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 CteApi.criar_carta_correcao_cte"
  end
  # resource path
  local_var_path = '/cte/{id}/carta-correcao'.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] || 'CteCartaCorrecao'

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

  new_options = opts.merge(
    :operation => :"CteApi.criar_carta_correcao_cte",
    :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: CteApi#criar_carta_correcao_cte\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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

Parameters:

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

    the optional parameters

Returns:



1101
1102
1103
1104
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 1101

def emitir_cte(body, opts = {})
  data, _status_code, _headers = emitir_cte_with_http_info(body, opts)
  data
end

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

Emitir CT-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:

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

    the optional parameters

Returns:

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

    Dfe data, response status code and response headers



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
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 1111

def emitir_cte_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CteApi.emitir_cte ...'
  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 CteApi.emitir_cte"
  end
  # resource path
  local_var_path = '/cte'

  # 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 => :"CteApi.emitir_cte",
    :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: CteApi#emitir_cte\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Listar CT-e Retorna a lista de CT-e de acordo com os critérios de busca utilizados. Os CT-e 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:



1176
1177
1178
1179
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 1176

def listar_cte(cpf_cnpj, ambiente, opts = {})
  data, _status_code, _headers = listar_cte_with_http_info(cpf_cnpj, ambiente, opts)
  data
end

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

Listar CT-e Retorna a lista de CT-e de acordo com os critérios de busca utilizados. Os CT-e 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



1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 1193

def listar_cte_with_http_info(cpf_cnpj, ambiente, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CteApi.listar_cte ...'
  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 CteApi.listar_cte"
  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 CteApi.listar_cte"
  end
  # resource path
  local_var_path = '/cte'

  # 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 => :"CteApi.listar_cte",
    :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: CteApi#listar_cte\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Sincroniza dados no CT-e a partir da SEFAZ Realiza a sincronização dos dados a partir da consulta da situação atual da CT-e na Base de Dados do Portal da Secretaria de Fazenda Estadual. **Cenários de uso**: * Sincronizar um CT-e 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 CT-e que se encontra com o status `autorizado`na Nuvem Fiscal, mas está cancelado na SEFAZ. * Sincronizar todos os eventos de Cancelamento e Carta de Correção de um CT-e 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 CT-e gerado pela Nuvem Fiscal.

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

    the optional parameters

Returns:



1258
1259
1260
1261
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 1258

def sincronizar_cte(id, opts = {})
  data, _status_code, _headers = sincronizar_cte_with_http_info(id, opts)
  data
end

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

Sincroniza dados no CT-e a partir da SEFAZ Realiza a sincronização dos dados a partir da consulta da situação atual da CT-e na Base de Dados do Portal da Secretaria de Fazenda Estadual. **Cenários de uso**: * Sincronizar um CT-e 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 CT-e que se encontra com o status &#x60;autorizado&#x60;na Nuvem Fiscal, mas está cancelado na SEFAZ. * Sincronizar todos os eventos de Cancelamento e Carta de Correção de um CT-e 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 CT-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



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/nuvemfiscal_sdk_ruby/api/cte_api.rb', line 1268

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