Class: NuvemfiscalSdkRuby::NfeApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NfeApi 



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

def api_client
  @api_client
end

Instance Method Details

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

Baixar PDF do cancelamento



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

def baixar_pdf_cancelamento_nfe(id, opts = {})
  data, _status_code, _headers = baixar_pdf_cancelamento_nfe_with_http_info(id, opts)
  data
end

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

Baixar PDF do cancelamento



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/nfe_api.rb', line 35

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

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

Baixar PDF da carta de correção



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

def baixar_pdf_carta_correcao_nfe(id, opts = {})
  data, _status_code, _headers = baixar_pdf_carta_correcao_nfe_with_http_info(id, opts)
  data
end

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

Baixar PDF da carta de correção



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/nfe_api.rb', line 96

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

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

Baixar PDF do evento



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

def baixar_pdf_evento_nfe(id, opts = {})
  data, _status_code, _headers = baixar_pdf_evento_nfe_with_http_info(id, opts)
  data
end

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

Baixar PDF do evento



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/nfe_api.rb', line 157

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

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

Baixar PDF da inutilização



209
210
211
212
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 209

def baixar_pdf_inutilizacao_nfe(id, opts = {})
  data, _status_code, _headers = baixar_pdf_inutilizacao_nfe_with_http_info(id, opts)
  data
end

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

Baixar PDF da inutilização



218
219
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
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 218

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

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

Baixar PDF do DANFE

Options Hash (opts):

  • :logotipo (Boolean) —

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

  • :nome_fantasia (Boolean) —

    Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota. (default to false)

  • :formato (String) —

    Formato de impressão do DANFE. Valores disponíveis: - &#x60;padrao&#x60;: será utilizado o formato definido no XML da NF-e (tag &quot;tpImp&quot;); - &#x60;retrato&#x60;: tamanho A4 em modo retrato; - &#x60;paisagem&#x60;: tamanho A4 em modo paisagem; - &#x60;simplificado&#x60;: formato simplificado utilizado nas operações realizadas fora do estabelecimento (Anexo II do MOC, item 3.11); - &#x60;etiqueta&#x60;: formato simplificado utilizado nas operações em comércio eletrônico (Anexo II do MOC, item 3.12 e NT 2020.004). (default to ‘padrao’)

  • :mensagem_rodape (String) —

    Imprime mensagem no rodapé do documento. O caractere &#x60;|&#x60; (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. **Exemplos de Uso:** * &#x60;&quot;esquerda&quot;&#x60; * &#x60;&quot;esquerda|centro&quot;&#x60; * &#x60;&quot;esquerda|centro|direita&quot;&#x60; * &#x60;&quot;|centro&quot;&#x60;, &#x60;&quot;|centro|&quot;&#x60; * &#x60;&quot;|centro|direita&quot;&#x60; * &#x60;&quot;||direita&quot;&#x60; * &#x60;&quot;esquerda||direita&quot;&#x60;

  • :canhoto (Boolean) —

    Imprime o documento com o bloco de canhoto. (default to true)



275
276
277
278
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 275

def baixar_pdf_nfe(id, opts = {})
  data, _status_code, _headers = baixar_pdf_nfe_with_http_info(id, opts)
  data
end

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

Baixar PDF do DANFE

Options Hash (opts):

  • :logotipo (Boolean) —

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

  • :nome_fantasia (Boolean) —

    Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota. (default to false)

  • :formato (String) —

    Formato de impressão do DANFE. Valores disponíveis: - &#x60;padrao&#x60;: será utilizado o formato definido no XML da NF-e (tag &quot;tpImp&quot;); - &#x60;retrato&#x60;: tamanho A4 em modo retrato; - &#x60;paisagem&#x60;: tamanho A4 em modo paisagem; - &#x60;simplificado&#x60;: formato simplificado utilizado nas operações realizadas fora do estabelecimento (Anexo II do MOC, item 3.11); - &#x60;etiqueta&#x60;: formato simplificado utilizado nas operações em comércio eletrônico (Anexo II do MOC, item 3.12 e NT 2020.004). (default to ‘padrao’)

  • :mensagem_rodape (String) —

    Imprime mensagem no rodapé do documento. O caractere &#x60;|&#x60; (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. **Exemplos de Uso:** * &#x60;&quot;esquerda&quot;&#x60; * &#x60;&quot;esquerda|centro&quot;&#x60; * &#x60;&quot;esquerda|centro|direita&quot;&#x60; * &#x60;&quot;|centro&quot;&#x60;, &#x60;&quot;|centro|&quot;&#x60; * &#x60;&quot;|centro|direita&quot;&#x60; * &#x60;&quot;||direita&quot;&#x60; * &#x60;&quot;esquerda||direita&quot;&#x60;

  • :canhoto (Boolean) —

    Imprime o documento com o bloco de canhoto. (default to true)



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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 289

def baixar_pdf_nfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NfeApi.baixar_pdf_nfe ...'
  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 NfeApi.baixar_pdf_nfe"
  end
  if @api_client.config.client_side_validation && !opts[:'mensagem_rodape'].nil? && opts[:'mensagem_rodape'].to_s.length > 120
    fail ArgumentError, 'invalid value for "opts[:"mensagem_rodape"]" when calling NfeApi.baixar_pdf_nfe, the character length must be smaller than or equal to 120.'
  end

  # resource path
  local_var_path = '/nfe/{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?
  query_params[:'nome_fantasia'] = opts[:'nome_fantasia'] if !opts[:'nome_fantasia'].nil?
  query_params[:'formato'] = opts[:'formato'] if !opts[:'formato'].nil?
  query_params[:'mensagem_rodape'] = opts[:'mensagem_rodape'] if !opts[:'mensagem_rodape'].nil?
  query_params[:'canhoto'] = opts[:'canhoto'] if !opts[:'canhoto'].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 => :"NfeApi.baixar_pdf_nfe",
    :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: NfeApi#baixar_pdf_nfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#baixar_previa_pdf_nfe(body, opts = {}) ⇒ File

Prévia do PDF do DANFE Através desse endpoint, é possível enviar os dados de uma NF-e e gerar uma prévia do DANFE. Os dados de entrada são os mesmos do endpoint de emissão de NF-e (‘POST /nfe`). **Atenção**: O DANFE gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação. **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.

Options Hash (opts):

  • :logotipo (Boolean) —

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

  • :nome_fantasia (Boolean) —

    Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota. (default to false)

  • :formato (String) —

    Formato de impressão do DANFE. Valores disponíveis: - &#x60;padrao&#x60;: será utilizado o formato definido no XML da NF-e (tag &quot;tpImp&quot;); - &#x60;retrato&#x60;: tamanho A4 em modo retrato; - &#x60;paisagem&#x60;: tamanho A4 em modo paisagem; - &#x60;simplificado&#x60;: formato simplificado utilizado nas operações realizadas fora do estabelecimento (Anexo II do MOC, item 3.11); - &#x60;etiqueta&#x60;: formato simplificado utilizado nas operações em comércio eletrônico (Anexo II do MOC, item 3.12 e NT 2020.004). (default to ‘padrao’)

  • :mensagem_rodape (String) —

    Imprime mensagem no rodapé do documento. O caractere &#x60;|&#x60; (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. **Exemplos de Uso:** * &#x60;&quot;esquerda&quot;&#x60; * &#x60;&quot;esquerda|centro&quot;&#x60; * &#x60;&quot;esquerda|centro|direita&quot;&#x60; * &#x60;&quot;|centro&quot;&#x60;, &#x60;&quot;|centro|&quot;&#x60; * &#x60;&quot;|centro|direita&quot;&#x60; * &#x60;&quot;||direita&quot;&#x60; * &#x60;&quot;esquerda||direita&quot;&#x60;

  • :canhoto (Boolean) —

    Imprime o documento com o bloco de canhoto. (default to true)



356
357
358
359
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 356

def baixar_previa_pdf_nfe(body, opts = {})
  data, _status_code, _headers = baixar_previa_pdf_nfe_with_http_info(body, opts)
  data
end

#baixar_previa_pdf_nfe_with_http_info(body, opts = {}) ⇒ Array<(File, Integer, Hash)>

Prévia do PDF do DANFE Através desse endpoint, é possível enviar os dados de uma NF-e e gerar uma prévia do DANFE. Os dados de entrada são os mesmos do endpoint de emissão de NF-e (&#x60;POST /nfe&#x60;). **Atenção**: O DANFE gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação. **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.

Options Hash (opts):

  • :logotipo (Boolean) —

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

  • :nome_fantasia (Boolean) —

    Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota. (default to false)

  • :formato (String) —

    Formato de impressão do DANFE. Valores disponíveis: - &#x60;padrao&#x60;: será utilizado o formato definido no XML da NF-e (tag &quot;tpImp&quot;); - &#x60;retrato&#x60;: tamanho A4 em modo retrato; - &#x60;paisagem&#x60;: tamanho A4 em modo paisagem; - &#x60;simplificado&#x60;: formato simplificado utilizado nas operações realizadas fora do estabelecimento (Anexo II do MOC, item 3.11); - &#x60;etiqueta&#x60;: formato simplificado utilizado nas operações em comércio eletrônico (Anexo II do MOC, item 3.12 e NT 2020.004). (default to ‘padrao’)

  • :mensagem_rodape (String) —

    Imprime mensagem no rodapé do documento. O caractere &#x60;|&#x60; (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. **Exemplos de Uso:** * &#x60;&quot;esquerda&quot;&#x60; * &#x60;&quot;esquerda|centro&quot;&#x60; * &#x60;&quot;esquerda|centro|direita&quot;&#x60; * &#x60;&quot;|centro&quot;&#x60;, &#x60;&quot;|centro|&quot;&#x60; * &#x60;&quot;|centro|direita&quot;&#x60; * &#x60;&quot;||direita&quot;&#x60; * &#x60;&quot;esquerda||direita&quot;&#x60;

  • :canhoto (Boolean) —

    Imprime o documento com o bloco de canhoto. (default to true)



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 371

def baixar_previa_pdf_nfe_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NfeApi.baixar_previa_pdf_nfe ...'
  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 NfeApi.baixar_previa_pdf_nfe"
  end
  if @api_client.config.client_side_validation && !opts[:'mensagem_rodape'].nil? && opts[:'mensagem_rodape'].to_s.length > 120
    fail ArgumentError, 'invalid value for "opts[:"mensagem_rodape"]" when calling NfeApi.baixar_previa_pdf_nfe, the character length must be smaller than or equal to 120.'
  end

  # resource path
  local_var_path = '/nfe/previa/pdf'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'logotipo'] = opts[:'logotipo'] if !opts[:'logotipo'].nil?
  query_params[:'nome_fantasia'] = opts[:'nome_fantasia'] if !opts[:'nome_fantasia'].nil?
  query_params[:'formato'] = opts[:'formato'] if !opts[:'formato'].nil?
  query_params[:'mensagem_rodape'] = opts[:'mensagem_rodape'] if !opts[:'mensagem_rodape'].nil?
  query_params[:'canhoto'] = opts[:'canhoto'] if !opts[:'canhoto'].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']
  # 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] || 'File'

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

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

#baixar_previa_xml_nfe(body, opts = {}) ⇒ File

Prévia do XML da NF-e Através desse endpoint, é possível enviar os dados de uma NF-e e gerar uma prévia do XML, sem a assinatura digital. Os dados de entrada são os mesmos do endpoint de emissão de NF-e (‘POST /nfe`). **Atenção**: O XML gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação. **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.



438
439
440
441
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 438

def baixar_previa_xml_nfe(body, opts = {})
  data, _status_code, _headers = baixar_previa_xml_nfe_with_http_info(body, opts)
  data
end

#baixar_previa_xml_nfe_with_http_info(body, opts = {}) ⇒ Array<(File, Integer, Hash)>

Prévia do XML da NF-e Através desse endpoint, é possível enviar os dados de uma NF-e e gerar uma prévia do XML, sem a assinatura digital. Os dados de entrada são os mesmos do endpoint de emissão de NF-e (&#x60;POST /nfe&#x60;). **Atenção**: O XML gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação. **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.



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 448

def baixar_previa_xml_nfe_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NfeApi.baixar_previa_xml_nfe ...'
  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 NfeApi.baixar_previa_xml_nfe"
  end
  # resource path
  local_var_path = '/nfe/previa/xml'

  # 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']
  # 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] || 'File'

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

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

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

Baixar XML do cancelamento



505
506
507
508
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 505

def baixar_xml_cancelamento_nfe(id, opts = {})
  data, _status_code, _headers = baixar_xml_cancelamento_nfe_with_http_info(id, opts)
  data
end

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

Baixar XML do cancelamento



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 514

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

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

Baixar XML da carta de correção



566
567
568
569
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 566

def baixar_xml_carta_correcao_nfe(id, opts = {})
  data, _status_code, _headers = baixar_xml_carta_correcao_nfe_with_http_info(id, opts)
  data
end

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

Baixar XML da carta de correção



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 575

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

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

Baixar XML do evento



627
628
629
630
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 627

def baixar_xml_evento_nfe(id, opts = {})
  data, _status_code, _headers = baixar_xml_evento_nfe_with_http_info(id, opts)
  data
end

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

Baixar XML do evento



636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 636

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

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

Baixar XML da inutilização



688
689
690
691
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 688

def baixar_xml_inutilizacao_nfe(id, opts = {})
  data, _status_code, _headers = baixar_xml_inutilizacao_nfe_with_http_info(id, opts)
  data
end

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

Baixar XML da inutilização



697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 697

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

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

Baixar XML da NF-e processada Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz ‘nfeProc`). O XML só estará disponível nesse endpoint caso a nota tenha sido autorizada ou denegada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /nfe/id/xml/nota`.



750
751
752
753
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 750

def baixar_xml_nfe(id, opts = {})
  data, _status_code, _headers = baixar_xml_nfe_with_http_info(id, opts)
  data
end

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

Baixar XML da NF-e Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ. O XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.



813
814
815
816
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 813

def baixar_xml_nfe_nota(id, opts = {})
  data, _status_code, _headers = baixar_xml_nfe_nota_with_http_info(id, opts)
  data
end

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

Baixar XML da NF-e Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ. O XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
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
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 823

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

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

Baixar XML do Protocolo da SEFAZ



875
876
877
878
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 875

def baixar_xml_nfe_protocolo(id, opts = {})
  data, _status_code, _headers = baixar_xml_nfe_protocolo_with_http_info(id, opts)
  data
end

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

Baixar XML do Protocolo da SEFAZ



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 884

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

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

Baixar XML da NF-e processada Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz &#x60;nfeProc&#x60;). O XML só estará disponível nesse endpoint caso a nota tenha sido autorizada ou denegada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint &#x60;GET /nfe/id/xml/nota&#x60;.



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

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

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

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

Options Hash (opts):



938
939
940
941
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 938

def cancelar_nfe(id, opts = {})
  data, _status_code, _headers = cancelar_nfe_with_http_info(id, opts)
  data
end

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

Cancelar uma NF-e autorizada **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.

Options Hash (opts):



949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 949

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

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

Consultar o cancelamento da NF-e



1006
1007
1008
1009
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1006

def consultar_cancelamento_nfe(id, opts = {})
  data, _status_code, _headers = consultar_cancelamento_nfe_with_http_info(id, opts)
  data
end

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

Consultar o cancelamento da NF-e



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1015

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

#consultar_carta_correcao_nfe(id, opts = {}) ⇒ DfeCartaCorrecao

Consultar a solicitação de correção da NF-e



1067
1068
1069
1070
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1067

def consultar_carta_correcao_nfe(id, opts = {})
  data, _status_code, _headers = consultar_carta_correcao_nfe_with_http_info(id, opts)
  data
end

#consultar_carta_correcao_nfe_with_http_info(id, opts = {}) ⇒ Array<(DfeCartaCorrecao, Integer, Hash)>

Consultar a solicitação de correção da NF-e



1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
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
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1076

def consultar_carta_correcao_nfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NfeApi.consultar_carta_correcao_nfe ...'
  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 NfeApi.consultar_carta_correcao_nfe"
  end
  # resource path
  local_var_path = '/nfe/{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] || 'DfeCartaCorrecao'

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

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

#consultar_contribuinte_nfe(cpf_cnpj, argumento, documento, opts = {}) ⇒ DfeContribuinteInfCons

Consultar contribuinte Consulta o Cadastro Centralizado de Contribuintes (CCC) do ICMS da unidade federada. **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.

Options Hash (opts):

  • :uf (String) —

    Sigla da UF consultada. Utilize &#x60;SU&#x60; para SUFRAMA. *Caso não seja informada, será utilizada a UF da empresa.*



1132
1133
1134
1135
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1132

def consultar_contribuinte_nfe(cpf_cnpj, argumento, documento, opts = {})
  data, _status_code, _headers = consultar_contribuinte_nfe_with_http_info(cpf_cnpj, argumento, documento, opts)
  data
end

#consultar_contribuinte_nfe_with_http_info(cpf_cnpj, argumento, documento, opts = {}) ⇒ Array<(DfeContribuinteInfCons, Integer, Hash)>

Consultar contribuinte Consulta o Cadastro Centralizado de Contribuintes (CCC) do ICMS da unidade federada. **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.

Options Hash (opts):

  • :uf (String) —

    Sigla da UF consultada. Utilize &#x60;SU&#x60; para SUFRAMA. *Caso não seja informada, será utilizada a UF da empresa.*



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1145

def consultar_contribuinte_nfe_with_http_info(cpf_cnpj, argumento, documento, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NfeApi.consultar_contribuinte_nfe ...'
  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 NfeApi.consultar_contribuinte_nfe"
  end
  # verify the required parameter 'argumento' is set
  if @api_client.config.client_side_validation && argumento.nil?
    fail ArgumentError, "Missing the required parameter 'argumento' when calling NfeApi.consultar_contribuinte_nfe"
  end
  # verify the required parameter 'documento' is set
  if @api_client.config.client_side_validation && documento.nil?
    fail ArgumentError, "Missing the required parameter 'documento' when calling NfeApi.consultar_contribuinte_nfe"
  end
  # resource path
  local_var_path = '/nfe/cadastro-contribuinte'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cpf_cnpj'] = cpf_cnpj
  query_params[:'argumento'] = argumento
  query_params[:'documento'] = documento
  query_params[:'uf'] = opts[:'uf'] if !opts[:'uf'].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] || 'DfeContribuinteInfCons'

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

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

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

Consultar evento



1209
1210
1211
1212
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1209

def consultar_evento_nfe(id, opts = {})
  data, _status_code, _headers = consultar_evento_nfe_with_http_info(id, opts)
  data
end

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

Consultar evento



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
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1218

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

#consultar_inutilizacao_nfe(id, opts = {}) ⇒ DfeInutilizacao

Consultar a inutilização de sequência de numeração



1270
1271
1272
1273
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1270

def consultar_inutilizacao_nfe(id, opts = {})
  data, _status_code, _headers = consultar_inutilizacao_nfe_with_http_info(id, opts)
  data
end

#consultar_inutilizacao_nfe_with_http_info(id, opts = {}) ⇒ Array<(DfeInutilizacao, Integer, Hash)>

Consultar a inutilização de sequência de numeração



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
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1279

def consultar_inutilizacao_nfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NfeApi.consultar_inutilizacao_nfe ...'
  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 NfeApi.consultar_inutilizacao_nfe"
  end
  # resource path
  local_var_path = '/nfe/inutilizacoes/{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] || 'DfeInutilizacao'

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

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

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

Consultar lote de NF-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.



1332
1333
1334
1335
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1332

def consultar_lote_nfe(id, opts = {})
  data, _status_code, _headers = consultar_lote_nfe_with_http_info(id, opts)
  data
end

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

Consultar lote de NF-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.



1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1342

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

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

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



1395
1396
1397
1398
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1395

def consultar_nfe(id, opts = {})
  data, _status_code, _headers = consultar_nfe_with_http_info(id, opts)
  data
end

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

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



1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1405

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

#consultar_status_sefaz_nfe(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 7.0, item 5.5.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).

Options Hash (opts):

  • :autorizador (String) —

    Ambiente Autorizador. Autorizadores disponíveis: &#x60;AM&#x60;, &#x60;BA&#x60;, &#x60;GO&#x60;, &#x60;MG&#x60;, &#x60;MS&#x60;, &#x60;MT&#x60;, &#x60;PE&#x60;, &#x60;PR&#x60;, &#x60;RS&#x60;, &#x60;SP&#x60;, &#x60;SVAN&#x60;, &#x60;SVRS&#x60;, &#x60;SVCAN&#x60;, &#x60;SVCRS&#x60;, &#x60;AN&#x60;. *Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*



1459
1460
1461
1462
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1459

def consultar_status_sefaz_nfe(cpf_cnpj, opts = {})
  data, _status_code, _headers = consultar_status_sefaz_nfe_with_http_info(cpf_cnpj, opts)
  data
end

#consultar_status_sefaz_nfe_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 7.0, item 5.5.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).

Options Hash (opts):

  • :autorizador (String) —

    Ambiente Autorizador. Autorizadores disponíveis: &#x60;AM&#x60;, &#x60;BA&#x60;, &#x60;GO&#x60;, &#x60;MG&#x60;, &#x60;MS&#x60;, &#x60;MT&#x60;, &#x60;PE&#x60;, &#x60;PR&#x60;, &#x60;RS&#x60;, &#x60;SP&#x60;, &#x60;SVAN&#x60;, &#x60;SVRS&#x60;, &#x60;SVCAN&#x60;, &#x60;SVCRS&#x60;, &#x60;AN&#x60;. *Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*



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
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1470

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

#criar_carta_correcao_nfe(id, body, opts = {}) ⇒ DfeCartaCorrecao

Solicitar correção da NF-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.



1526
1527
1528
1529
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1526

def criar_carta_correcao_nfe(id, body, opts = {})
  data, _status_code, _headers = criar_carta_correcao_nfe_with_http_info(id, body, opts)
  data
end

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

Solicitar correção da NF-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.



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
1587
1588
1589
1590
1591
1592
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1537

def criar_carta_correcao_nfe_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NfeApi.criar_carta_correcao_nfe ...'
  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 NfeApi.criar_carta_correcao_nfe"
  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 NfeApi.criar_carta_correcao_nfe"
  end
  # resource path
  local_var_path = '/nfe/{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] || 'DfeCartaCorrecao'

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

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

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

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



1599
1600
1601
1602
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1599

def emitir_lote_nfe(body, opts = {})
  data, _status_code, _headers = emitir_lote_nfe_with_http_info(body, opts)
  data
end

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

Emitir lote de NF-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 NF-e.



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1609

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

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

Emitir NF-e Este endpoint permite a emissão de Notas Fiscais Eletrônicas (NF-e). A solicitação deve ser feita enviando os dados necessários para a emissão de uma NF-e. A estrutura do JSON utilizado na solicitação segue a hierarquia e nomenclatura de campos definidos no <a href="www.nfe.fazenda.gov.br/portal/principal.aspx" target="_blank"> Manual de Orientação ao Contribuinte (MOC)</a>. Esta conformidade visa facilitar a integração de novos usuários que já possuem familiaridade com o padrão, além de permitir a resolução de dúvidas diretamente no MOC, com um profissional de contabilidade habilitado ou em outras fontes confiáveis que tratam do mesmo assunto. **Comportamento Assíncrono** A resposta desse endpoint inclui a propriedade status no JSON. Caso o valor retornado seja pendente, significa que a solicitação está sendo realizada de forma assíncrona pela API. Nesse caso, o usuário deverá adotar um fluxo que consiste em requisitar periodicamente o endpoint <a href="#tag/Nfe/operation/ConsultarNfe">Consultar NF-e</a> até que seja retornado um status indicando o fim da emissão. **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.



1667
1668
1669
1670
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1667

def emitir_nfe(body, opts = {})
  data, _status_code, _headers = emitir_nfe_with_http_info(body, opts)
  data
end

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

Emitir NF-e Este endpoint permite a emissão de Notas Fiscais Eletrônicas (NF-e). A solicitação deve ser feita enviando os dados necessários para a emissão de uma NF-e. A estrutura do JSON utilizado na solicitação segue a hierarquia e nomenclatura de campos definidos no &lt;a href&#x3D;&quot;www.nfe.fazenda.gov.br/portal/principal.aspx&quot; target&#x3D;&quot;_blank&quot;&gt; Manual de Orientação ao Contribuinte (MOC)&lt;/a&gt;. Esta conformidade visa facilitar a integração de novos usuários que já possuem familiaridade com o padrão, além de permitir a resolução de dúvidas diretamente no MOC, com um profissional de contabilidade habilitado ou em outras fontes confiáveis que tratam do mesmo assunto. **Comportamento Assíncrono** A resposta desse endpoint inclui a propriedade status no JSON. Caso o valor retornado seja pendente, significa que a solicitação está sendo realizada de forma assíncrona pela API. Nesse caso, o usuário deverá adotar um fluxo que consiste em requisitar periodicamente o endpoint &lt;a href&#x3D;&quot;#tag/Nfe/operation/ConsultarNfe&quot;&gt;Consultar NF-e&lt;/a&gt; até que seja retornado um status indicando o fim da emissão. **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.



1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
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
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1677

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

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

#enviar_email_nfe(id, opts = {}) ⇒ EmailStatusResponse

Enviar e-mail Envia o XML e PDF da nota via email. **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.

Options Hash (opts):



1736
1737
1738
1739
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1736

def enviar_email_nfe(id, opts = {})
  data, _status_code, _headers = enviar_email_nfe_with_http_info(id, opts)
  data
end

#enviar_email_nfe_with_http_info(id, opts = {}) ⇒ Array<(EmailStatusResponse, Integer, Hash)>

Enviar e-mail Envia o XML e PDF da nota via email. **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.

Options Hash (opts):



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1747

def enviar_email_nfe_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NfeApi.enviar_email_nfe ...'
  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 NfeApi.enviar_email_nfe"
  end
  # resource path
  local_var_path = '/nfe/{id}/email'.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] || 'EmailStatusResponse'

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

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

#inutilizar_numeracao_nfe(body, opts = {}) ⇒ DfeInutilizacao

Inutilizar uma sequência de numeração de NF-e **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.



1805
1806
1807
1808
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1805

def inutilizar_numeracao_nfe(body, opts = {})
  data, _status_code, _headers = inutilizar_numeracao_nfe_with_http_info(body, opts)
  data
end

#inutilizar_numeracao_nfe_with_http_info(body, opts = {}) ⇒ Array<(DfeInutilizacao, Integer, Hash)>

Inutilizar uma sequência de numeração de NF-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.



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1815

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

  # 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] || 'DfeInutilizacao'

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

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

#listar_eventos_nfe(dfe_id, opts = {}) ⇒ DfeEventoListagem

Listar eventos Retorna a lista de eventos vinculados a um documento fiscal de acordo com os critérios de busca utilizados. Os eventos são retornados ordenados pela data da criação, com as mais recentes aparecendo primeiro.

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)



1876
1877
1878
1879
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1876

def listar_eventos_nfe(dfe_id, opts = {})
  data, _status_code, _headers = listar_eventos_nfe_with_http_info(dfe_id, opts)
  data
end

#listar_eventos_nfe_with_http_info(dfe_id, opts = {}) ⇒ Array<(DfeEventoListagem, Integer, Hash)>

Listar eventos Retorna a lista de eventos vinculados a um documento fiscal de acordo com os critérios de busca utilizados. Os eventos são retornados ordenados pela data da criação, com as mais recentes aparecendo primeiro.

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)



1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1889

def listar_eventos_nfe_with_http_info(dfe_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NfeApi.listar_eventos_nfe ...'
  end
  # verify the required parameter 'dfe_id' is set
  if @api_client.config.client_side_validation && dfe_id.nil?
    fail ArgumentError, "Missing the required parameter 'dfe_id' when calling NfeApi.listar_eventos_nfe"
  end
  # resource path
  local_var_path = '/nfe/eventos'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dfe_id'] = dfe_id
  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?

  # 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] || 'DfeEventoListagem'

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

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

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

Listar lotes de NF-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.

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) 


1951
1952
1953
1954
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1951

def listar_lotes_nfe(cpf_cnpj, ambiente, opts = {})
  data, _status_code, _headers = listar_lotes_nfe_with_http_info(cpf_cnpj, ambiente, opts)
  data
end

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

Listar lotes de NF-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.

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) 


1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 1966

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

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

Listar NF-e Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

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.



2036
2037
2038
2039
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 2036

def listar_nfe(cpf_cnpj, ambiente, opts = {})
  data, _status_code, _headers = listar_nfe_with_http_info(cpf_cnpj, ambiente, opts)
  data
end

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

Listar NF-e Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

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.



2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 2053

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

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

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

Sincroniza dados na NF-e a partir da SEFAZ Realiza a sincronização dos dados a partir da consulta da situação atual da NF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual. **Cenários de uso**: * Sincronizar uma nota que se encontra com o status ‘erro` na Nuvem Fiscal, mas está autorizada na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts). * Sincronizar uma nota que se encontra com o status `autorizado`na Nuvem Fiscal, mas está cancelada na SEFAZ. * Sincronizar todos os eventos de Cancelamento, Carta de Correção e EPEC de uma nota 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.



2118
2119
2120
2121
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 2118

def sincronizar_nfe(id, opts = {})
  data, _status_code, _headers = sincronizar_nfe_with_http_info(id, opts)
  data
end

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

Sincroniza dados na NF-e a partir da SEFAZ Realiza a sincronização dos dados a partir da consulta da situação atual da NF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual. **Cenários de uso**: * Sincronizar uma nota que se encontra com o status &#x60;erro&#x60; na Nuvem Fiscal, mas está autorizada na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts). * Sincronizar uma nota que se encontra com o status &#x60;autorizado&#x60;na Nuvem Fiscal, mas está cancelada na SEFAZ. * Sincronizar todos os eventos de Cancelamento, Carta de Correção e EPEC de uma nota 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.



2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
 
# File 'lib/nuvemfiscal_sdk_ruby/api/nfe_api.rb', line 2128

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