Class: NuvemfiscalSdkRuby::DistribuioNFEApi
- Inherits:
-
Object
- Object
- NuvemfiscalSdkRuby::DistribuioNFEApi
- Defined in:
- lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#baixar_pdf_documento_distribuicao_nfe(id, opts = {}) ⇒ File
Baixar PDF do documento Utilize esse endpoint para obter o PDF do documento.
-
#baixar_pdf_documento_distribuicao_nfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>
Baixar PDF do documento Utilize esse endpoint para obter o PDF do documento.
-
#baixar_xml_documento_distribuicao_nfe(id, opts = {}) ⇒ File
Baixar XML do documento Utilize esse endpoint para obter o XML das informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.
-
#baixar_xml_documento_distribuicao_nfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>
Baixar XML do documento Utilize esse endpoint para obter o XML das informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.
-
#consultar_distribuicao_nfe(id, opts = {}) ⇒ DistribuicaoNfe
Consultar distribuição.
-
#consultar_distribuicao_nfe_with_http_info(id, opts = {}) ⇒ Array<(DistribuicaoNfe, Integer, Hash)>
Consultar distribuição.
-
#consultar_documento_distribuicao_nfe(id, opts = {}) ⇒ DistribuicaoNfeDocumento
Consultar documento Utilize esse endpoint para obter as informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.
-
#consultar_documento_distribuicao_nfe_with_http_info(id, opts = {}) ⇒ Array<(DistribuicaoNfeDocumento, Integer, Hash)>
Consultar documento Utilize esse endpoint para obter as informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.
-
#consultar_manifestacao_nfe(id, opts = {}) ⇒ DistribuicaoNfeEvento
Consultar manifestação Consulta os detalhes de uma manifestação de NF-e já existente.
-
#consultar_manifestacao_nfe_with_http_info(id, opts = {}) ⇒ Array<(DistribuicaoNfeEvento, Integer, Hash)>
Consultar manifestação Consulta os detalhes de uma manifestação de NF-e já existente.
-
#gerar_distribuicao_nfe(body, opts = {}) ⇒ DistribuicaoNfe
Distribuir documentos Este endpoint permite que o destinatário obtenha Documentos Fiscais Eletrônicos (DF-e) emitidos contra o seu CNPJ ou CPF ou que seja de seu interesse.
-
#gerar_distribuicao_nfe_with_http_info(body, opts = {}) ⇒ Array<(DistribuicaoNfe, Integer, Hash)>
Distribuir documentos Este endpoint permite que o destinatário obtenha Documentos Fiscais Eletrônicos (DF-e) emitidos contra o seu CNPJ ou CPF ou que seja de seu interesse.
-
#initialize(api_client = ApiClient.default) ⇒ DistribuioNFEApi
constructor
A new instance of DistribuioNFEApi.
-
#listar_distribuicao_nfe(cpf_cnpj, ambiente, opts = {}) ⇒ DistribuicaoNfeListagem
Listar distribuições Retorna a lista de distribuições de NF-e de acordo com os critérios de busca utilizados.
-
#listar_distribuicao_nfe_with_http_info(cpf_cnpj, ambiente, opts = {}) ⇒ Array<(DistribuicaoNfeListagem, Integer, Hash)>
Listar distribuições Retorna a lista de distribuições de NF-e de acordo com os critérios de busca utilizados.
-
#listar_documento_distribuicao_nfe(cpf_cnpj, ambiente, opts = {}) ⇒ DistribuicaoNfeDocumentoListagem
Listar documentos Retorna a lista de documentos fiscais eletrônicos de interesse da pessoa ou empresa de acordo com os critérios de busca utilizados.
-
#listar_documento_distribuicao_nfe_with_http_info(cpf_cnpj, ambiente, opts = {}) ⇒ Array<(DistribuicaoNfeDocumentoListagem, Integer, Hash)>
Listar documentos Retorna a lista de documentos fiscais eletrônicos de interesse da pessoa ou empresa de acordo com os critérios de busca utilizados.
-
#listar_manifestacao_nfe(cpf_cnpj, ambiente, opts = {}) ⇒ ManifestacaoNfeListagem
Listar Manifestações Retorna a lista de manifestações de NF-e de acordo com os critérios de busca utilizados.
-
#listar_manifestacao_nfe_with_http_info(cpf_cnpj, ambiente, opts = {}) ⇒ Array<(ManifestacaoNfeListagem, Integer, Hash)>
Listar Manifestações Retorna a lista de manifestações de NF-e de acordo com os critérios de busca utilizados.
-
#listar_nfe_sem_manifestacao(cpf_cnpj, ambiente, opts = {}) ⇒ DistribuicaoNfeNotaListagem
Listar notas sem manifestação No processo de distribuição de DF-e, as notas fiscais eletrônicas (NF-e) são inicialmente disponibilizadas de forma resumida.
-
#listar_nfe_sem_manifestacao_with_http_info(cpf_cnpj, ambiente, opts = {}) ⇒ Array<(DistribuicaoNfeNotaListagem, Integer, Hash)>
Listar notas sem manifestação No processo de distribuição de DF-e, as notas fiscais eletrônicas (NF-e) são inicialmente disponibilizadas de forma resumida.
-
#manifestar_nfe(body, opts = {}) ⇒ DistribuicaoNfeEvento
Manifestar nota O processo de manifestação do destinatário permite que os destinatários de Notas Fiscais Eletrônicas (NF-e) registrem formalmente sua posição em relação às operações descritas nesses documentos fiscais.
-
#manifestar_nfe_with_http_info(body, opts = {}) ⇒ Array<(DistribuicaoNfeEvento, Integer, Hash)>
Manifestar nota O processo de manifestação do destinatário permite que os destinatários de Notas Fiscais Eletrônicas (NF-e) registrem formalmente sua posição em relação às operações descritas nesses documentos fiscais.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ DistribuioNFEApi
19 20 21 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_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/distribuio_nfe_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#baixar_pdf_documento_distribuicao_nfe(id, opts = {}) ⇒ File
Baixar PDF do documento Utilize esse endpoint para obter o PDF do documento. Schemas suportados: * procNFe_v4.00.xsd
27 28 29 30 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 27 def baixar_pdf_documento_distribuicao_nfe(id, opts = {}) data, _status_code, _headers = baixar_pdf_documento_distribuicao_nfe_with_http_info(id, opts) data end |
#baixar_pdf_documento_distribuicao_nfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>
Baixar PDF do documento Utilize esse endpoint para obter o PDF do documento. Schemas suportados: * procNFe_v4.00.xsd
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 82 83 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 37 def baixar_pdf_documento_distribuicao_nfe_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistribuioNFEApi.baixar_pdf_documento_distribuicao_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 DistribuioNFEApi.baixar_pdf_documento_distribuicao_nfe" end # resource path local_var_path = '/distribuicao/nfe/documentos/{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'] = opts.merge( :operation => :"DistribuioNFEApi.baixar_pdf_documento_distribuicao_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistribuioNFEApi#baixar_pdf_documento_distribuicao_nfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#baixar_xml_documento_distribuicao_nfe(id, opts = {}) ⇒ File
Baixar XML do documento Utilize esse endpoint para obter o XML das informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.
90 91 92 93 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 90 def baixar_xml_documento_distribuicao_nfe(id, opts = {}) data, _status_code, _headers = baixar_xml_documento_distribuicao_nfe_with_http_info(id, opts) data end |
#baixar_xml_documento_distribuicao_nfe_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>
Baixar XML do documento Utilize esse endpoint para obter o XML das informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.
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 143 144 145 146 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 100 def baixar_xml_documento_distribuicao_nfe_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistribuioNFEApi.baixar_xml_documento_distribuicao_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 DistribuioNFEApi.baixar_xml_documento_distribuicao_nfe" end # resource path local_var_path = '/distribuicao/nfe/documentos/{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'] = opts.merge( :operation => :"DistribuioNFEApi.baixar_xml_documento_distribuicao_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistribuioNFEApi#baixar_xml_documento_distribuicao_nfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#consultar_distribuicao_nfe(id, opts = {}) ⇒ DistribuicaoNfe
Consultar distribuição
152 153 154 155 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 152 def consultar_distribuicao_nfe(id, opts = {}) data, _status_code, _headers = consultar_distribuicao_nfe_with_http_info(id, opts) data end |
#consultar_distribuicao_nfe_with_http_info(id, opts = {}) ⇒ Array<(DistribuicaoNfe, Integer, Hash)>
Consultar distribuição
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 161 def consultar_distribuicao_nfe_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistribuioNFEApi.consultar_distribuicao_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 DistribuioNFEApi.consultar_distribuicao_nfe" end # resource path local_var_path = '/distribuicao/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] || 'DistribuicaoNfe' # auth_names auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2'] = opts.merge( :operation => :"DistribuioNFEApi.consultar_distribuicao_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistribuioNFEApi#consultar_distribuicao_nfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#consultar_documento_distribuicao_nfe(id, opts = {}) ⇒ DistribuicaoNfeDocumento
Consultar documento Utilize esse endpoint para obter as informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.
214 215 216 217 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 214 def consultar_documento_distribuicao_nfe(id, opts = {}) data, _status_code, _headers = consultar_documento_distribuicao_nfe_with_http_info(id, opts) data end |
#consultar_documento_distribuicao_nfe_with_http_info(id, opts = {}) ⇒ Array<(DistribuicaoNfeDocumento, Integer, Hash)>
Consultar documento Utilize esse endpoint para obter as informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 224 def consultar_documento_distribuicao_nfe_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistribuioNFEApi.consultar_documento_distribuicao_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 DistribuioNFEApi.consultar_documento_distribuicao_nfe" end # resource path local_var_path = '/distribuicao/nfe/documentos/{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] || 'DistribuicaoNfeDocumento' # auth_names auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2'] = opts.merge( :operation => :"DistribuioNFEApi.consultar_documento_distribuicao_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistribuioNFEApi#consultar_documento_distribuicao_nfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#consultar_manifestacao_nfe(id, opts = {}) ⇒ DistribuicaoNfeEvento
Consultar manifestação Consulta os detalhes de uma manifestação de NF-e já existente. Forneça o ID único obtido de uma requisição de manifestação ou de listagem de manifestações e a Nuvem Fiscal irá retornar as informações da manifestação correspondente.
277 278 279 280 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 277 def consultar_manifestacao_nfe(id, opts = {}) data, _status_code, _headers = consultar_manifestacao_nfe_with_http_info(id, opts) data end |
#consultar_manifestacao_nfe_with_http_info(id, opts = {}) ⇒ Array<(DistribuicaoNfeEvento, Integer, Hash)>
Consultar manifestação Consulta os detalhes de uma manifestação de NF-e já existente. Forneça o ID único obtido de uma requisição de manifestação ou de listagem de manifestações e a Nuvem Fiscal irá retornar as informações da manifestação correspondente.
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 287 def consultar_manifestacao_nfe_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistribuioNFEApi.consultar_manifestacao_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 DistribuioNFEApi.consultar_manifestacao_nfe" end # resource path local_var_path = '/distribuicao/nfe/manifestacoes/{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] || 'DistribuicaoNfeEvento' # auth_names auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2'] = opts.merge( :operation => :"DistribuioNFEApi.consultar_manifestacao_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistribuioNFEApi#consultar_manifestacao_nfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#gerar_distribuicao_nfe(body, opts = {}) ⇒ DistribuicaoNfe
Distribuir documentos Este endpoint permite que o destinatário obtenha Documentos Fiscais Eletrônicos (DF-e) emitidos contra o seu CNPJ ou CPF ou que seja de seu interesse. A distribuição pode ser feita de três formas: dist-nsu, cons-nsu e cons-chave. **Formas de Consulta**: - dist-nsu: Consulta pelo último NSU recebido. - cons-nsu: Consulta por um NSU específico. - cons-chave: Consulta pela chave de acesso da NF-e. **Retorno da Solicitação** A resposta da solicitação inclui a propriedade status no JSON, que pode ter os seguintes valores: - processando: A solicitação está em andamento. - concluido: A solicitação foi processada com sucesso. - erro: Ocorreu um erro no processamento da solicitação. Se o status retornado for processando, 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/Distribuicao-NF-e/operation/ConsultarDistribuicaoNfe">consultar distribuição</a> até que a API retorne o pedido com um status indicando o fim do processamento (concluido ou erro). **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por documento distribuído (retornado) ou requisição.
340 341 342 343 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 340 def gerar_distribuicao_nfe(body, opts = {}) data, _status_code, _headers = gerar_distribuicao_nfe_with_http_info(body, opts) data end |
#gerar_distribuicao_nfe_with_http_info(body, opts = {}) ⇒ Array<(DistribuicaoNfe, Integer, Hash)>
Distribuir documentos Este endpoint permite que o destinatário obtenha Documentos Fiscais Eletrônicos (DF-e) emitidos contra o seu CNPJ ou CPF ou que seja de seu interesse. A distribuição pode ser feita de três formas: dist-nsu, cons-nsu e cons-chave. **Formas de Consulta**: - dist-nsu: Consulta pelo último NSU recebido. - cons-nsu: Consulta por um NSU específico. - cons-chave: Consulta pela chave de acesso da NF-e. **Retorno da Solicitação** A resposta da solicitação inclui a propriedade status no JSON, que pode ter os seguintes valores: - processando: A solicitação está em andamento. - concluido: A solicitação foi processada com sucesso. - erro: Ocorreu um erro no processamento da solicitação. Se o status retornado for processando, 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/Distribuicao-NF-e/operation/ConsultarDistribuicaoNfe">consultar distribuição</a> até que a API retorne o pedido com um status indicando o fim do processamento (concluido ou erro). **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por documento distribuído (retornado) ou requisição.
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 350 def gerar_distribuicao_nfe_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistribuioNFEApi.gerar_distribuicao_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 DistribuioNFEApi.gerar_distribuicao_nfe" end # resource path local_var_path = '/distribuicao/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] || 'DistribuicaoNfe' # auth_names auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2'] = opts.merge( :operation => :"DistribuioNFEApi.gerar_distribuicao_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistribuioNFEApi#gerar_distribuicao_nfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#listar_distribuicao_nfe(cpf_cnpj, ambiente, opts = {}) ⇒ DistribuicaoNfeListagem
Listar distribuições Retorna a lista de distribuições de NF-e de acordo com os critérios de busca utilizados. As distribuições são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.
412 413 414 415 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 412 def listar_distribuicao_nfe(cpf_cnpj, ambiente, opts = {}) data, _status_code, _headers = listar_distribuicao_nfe_with_http_info(cpf_cnpj, ambiente, opts) data end |
#listar_distribuicao_nfe_with_http_info(cpf_cnpj, ambiente, opts = {}) ⇒ Array<(DistribuicaoNfeListagem, Integer, Hash)>
Listar distribuições Retorna a lista de distribuições de NF-e de acordo com os critérios de busca utilizados. As distribuições são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 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 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 426 def listar_distribuicao_nfe_with_http_info(cpf_cnpj, ambiente, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistribuioNFEApi.listar_distribuicao_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 DistribuioNFEApi.listar_distribuicao_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 DistribuioNFEApi.listar_distribuicao_nfe" end # resource path local_var_path = '/distribuicao/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? # 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] || 'DistribuicaoNfeListagem' # auth_names auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2'] = opts.merge( :operation => :"DistribuioNFEApi.listar_distribuicao_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistribuioNFEApi#listar_distribuicao_nfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#listar_documento_distribuicao_nfe(cpf_cnpj, ambiente, opts = {}) ⇒ DistribuicaoNfeDocumentoListagem
Listar documentos Retorna a lista de documentos fiscais eletrônicos de interesse da pessoa ou empresa de acordo com os critérios de busca utilizados. Os documentos são retornadas ordenados pela data da criação, com os mais recentes aparecendo primeiro.
496 497 498 499 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 496 def listar_documento_distribuicao_nfe(cpf_cnpj, ambiente, opts = {}) data, _status_code, _headers = listar_documento_distribuicao_nfe_with_http_info(cpf_cnpj, ambiente, opts) data end |
#listar_documento_distribuicao_nfe_with_http_info(cpf_cnpj, ambiente, opts = {}) ⇒ Array<(DistribuicaoNfeDocumentoListagem, Integer, Hash)>
Listar documentos Retorna a lista de documentos fiscais eletrônicos de interesse da pessoa ou empresa de acordo com os critérios de busca utilizados. Os documentos são retornadas ordenados pela data da criação, com os mais recentes aparecendo primeiro.
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 561 562 563 564 565 566 567 568 569 570 571 572 573 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 514 def listar_documento_distribuicao_nfe_with_http_info(cpf_cnpj, ambiente, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistribuioNFEApi.listar_documento_distribuicao_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 DistribuioNFEApi.listar_documento_distribuicao_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 DistribuioNFEApi.listar_documento_distribuicao_nfe" end # resource path local_var_path = '/distribuicao/nfe/documentos' # 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[:'dist_nsu'] = opts[:'dist_nsu'] if !opts[:'dist_nsu'].nil? query_params[:'tipo_documento'] = opts[:'tipo_documento'] if !opts[:'tipo_documento'].nil? query_params[:'forma_distribuicao'] = opts[:'forma_distribuicao'] if !opts[:'forma_distribuicao'].nil? query_params[:'chave_acesso'] = opts[:'chave_acesso'] if !opts[:'chave_acesso'].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] || 'DistribuicaoNfeDocumentoListagem' # auth_names auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2'] = opts.merge( :operation => :"DistribuioNFEApi.listar_documento_distribuicao_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistribuioNFEApi#listar_documento_distribuicao_nfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#listar_manifestacao_nfe(cpf_cnpj, ambiente, opts = {}) ⇒ ManifestacaoNfeListagem
Listar Manifestações Retorna a lista de manifestações de NF-e de acordo com os critérios de busca utilizados. As manifestações são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.
584 585 586 587 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 584 def listar_manifestacao_nfe(cpf_cnpj, ambiente, opts = {}) data, _status_code, _headers = listar_manifestacao_nfe_with_http_info(cpf_cnpj, ambiente, opts) data end |
#listar_manifestacao_nfe_with_http_info(cpf_cnpj, ambiente, opts = {}) ⇒ Array<(ManifestacaoNfeListagem, Integer, Hash)>
Listar Manifestações Retorna a lista de manifestações de NF-e de acordo com os critérios de busca utilizados. As manifestações são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 598 def listar_manifestacao_nfe_with_http_info(cpf_cnpj, ambiente, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistribuioNFEApi.listar_manifestacao_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 DistribuioNFEApi.listar_manifestacao_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 DistribuioNFEApi.listar_manifestacao_nfe" end # resource path local_var_path = '/distribuicao/nfe/manifestacoes' # 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? # 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] || 'ManifestacaoNfeListagem' # auth_names auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2'] = opts.merge( :operation => :"DistribuioNFEApi.listar_manifestacao_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistribuioNFEApi#listar_manifestacao_nfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#listar_nfe_sem_manifestacao(cpf_cnpj, ambiente, opts = {}) ⇒ DistribuicaoNfeNotaListagem
Listar notas sem manifestação No processo de distribuição de DF-e, as notas fiscais eletrônicas (NF-e) são inicialmente disponibilizadas de forma resumida. Para obter o XML completo, o destinatário deve manifestar a ciência da operação e, posteriormente, uma manifestação conclusiva dentro de um prazo legal. Para facilitar essa gestão e o cumprimento dos prazos legais de manifestação, a API da Nuvem Fiscal permite listar as notas que ainda não possuem manifestação, ajudando os usuários a identificar rapidamente as notas que necessitam de ação. O usuário pode optar por listar apenas as notas que não possuem manifestação conclusiva ou que não possuem qualquer tipo de manifestação. Essa flexibilidade permite um controle mais preciso e adequado às necessidades operacionais de cada empresa. Os documentos são retornados ordenados decrescentemente pela data de distribuição, permitindo uma visualização clara e organizada das notas mais recentes. **Cenários de uso:** * Identificar rapidamente as notas que ainda precisam de manifestação para obter o XML completo. * Listar todas as notas fiscais eletrônicas que foram registradas com ciência da operação, mas ainda não possuem uma manifestação conclusiva (confirmação da operação, desconhecimento da operação ou operação não realizada). * Listar todas as notas fiscais eletrônicas que não possuem nenhum tipo de manifestação registrada (nem ciência da operação, nem manifestação conclusiva).
665 666 667 668 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 665 def listar_nfe_sem_manifestacao(cpf_cnpj, ambiente, opts = {}) data, _status_code, _headers = listar_nfe_sem_manifestacao_with_http_info(cpf_cnpj, ambiente, opts) data end |
#listar_nfe_sem_manifestacao_with_http_info(cpf_cnpj, ambiente, opts = {}) ⇒ Array<(DistribuicaoNfeNotaListagem, Integer, Hash)>
Listar notas sem manifestação No processo de distribuição de DF-e, as notas fiscais eletrônicas (NF-e) são inicialmente disponibilizadas de forma resumida. Para obter o XML completo, o destinatário deve manifestar a ciência da operação e, posteriormente, uma manifestação conclusiva dentro de um prazo legal. Para facilitar essa gestão e o cumprimento dos prazos legais de manifestação, a API da Nuvem Fiscal permite listar as notas que ainda não possuem manifestação, ajudando os usuários a identificar rapidamente as notas que necessitam de ação. O usuário pode optar por listar apenas as notas que não possuem manifestação conclusiva ou que não possuem qualquer tipo de manifestação. Essa flexibilidade permite um controle mais preciso e adequado às necessidades operacionais de cada empresa. Os documentos são retornados ordenados decrescentemente pela data de distribuição, permitindo uma visualização clara e organizada das notas mais recentes. **Cenários de uso:** * Identificar rapidamente as notas que ainda precisam de manifestação para obter o XML completo. * Listar todas as notas fiscais eletrônicas que foram registradas com ciência da operação, mas ainda não possuem uma manifestação conclusiva (confirmação da operação, desconhecimento da operação ou operação não realizada). * Listar todas as notas fiscais eletrônicas que não possuem nenhum tipo de manifestação registrada (nem ciência da operação, nem manifestação conclusiva).
680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 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 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 680 def listar_nfe_sem_manifestacao_with_http_info(cpf_cnpj, ambiente, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistribuioNFEApi.listar_nfe_sem_manifestacao ...' 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 DistribuioNFEApi.listar_nfe_sem_manifestacao" 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 DistribuioNFEApi.listar_nfe_sem_manifestacao" end # resource path local_var_path = '/distribuicao/nfe/notas-sem-manifestacao' # 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[:'conclusiva'] = opts[:'conclusiva'] if !opts[:'conclusiva'].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] || 'DistribuicaoNfeNotaListagem' # auth_names auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2'] = opts.merge( :operation => :"DistribuioNFEApi.listar_nfe_sem_manifestacao", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistribuioNFEApi#listar_nfe_sem_manifestacao\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#manifestar_nfe(body, opts = {}) ⇒ DistribuicaoNfeEvento
Manifestar nota O processo de manifestação do destinatário permite que os destinatários de Notas Fiscais Eletrônicas (NF-e) registrem formalmente sua posição em relação às operações descritas nesses documentos fiscais. Ele envolve eventos que indicam se a operação foi confirmada, desconhecida ou não realizada. Os seguintes tipos de manifestação são suportados pela NF-e: * **Confirmação da Operação (210200)**: Manifestação do destinatário confirmando que a operação descrita na NF-e ocorreu exatamente como informado na NF-e. Esse evento libera a possibilidade de download da NF-e pelo destinatário e impede que a empresa emitente cancele a NF-e após a confirmação. * **Ciência da Operação (210210)**: Declara que o destinatário tem ciência da existência da NF-e, mas ainda não possui elementos suficientes para manifestar-se conclusivamente. Este é um evento opcional que pode ser usado pelo destinatário para indicar que está ciente da NF-e enquanto coleta mais informações. Esse evento libera a possibilidade de download da NF-e pelo destinatário. * **Desconhecimento da Operação (210220)**: Manifestação do destinatário declarando que a operação descrita da NF-e não foi por ele solicitada. * **Operação não Realizada (210240)**: Manifestação do destinatário reconhecendo sua participação na operação descrita na NF-e, mas declarando que a operação não ocorreu ou não se efetivou como informado nesta NF-e. **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.
743 744 745 746 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 743 def manifestar_nfe(body, opts = {}) data, _status_code, _headers = manifestar_nfe_with_http_info(body, opts) data end |
#manifestar_nfe_with_http_info(body, opts = {}) ⇒ Array<(DistribuicaoNfeEvento, Integer, Hash)>
Manifestar nota O processo de manifestação do destinatário permite que os destinatários de Notas Fiscais Eletrônicas (NF-e) registrem formalmente sua posição em relação às operações descritas nesses documentos fiscais. Ele envolve eventos que indicam se a operação foi confirmada, desconhecida ou não realizada. Os seguintes tipos de manifestação são suportados pela NF-e: * **Confirmação da Operação (210200)**: Manifestação do destinatário confirmando que a operação descrita na NF-e ocorreu exatamente como informado na NF-e. Esse evento libera a possibilidade de download da NF-e pelo destinatário e impede que a empresa emitente cancele a NF-e após a confirmação. * **Ciência da Operação (210210)**: Declara que o destinatário tem ciência da existência da NF-e, mas ainda não possui elementos suficientes para manifestar-se conclusivamente. Este é um evento opcional que pode ser usado pelo destinatário para indicar que está ciente da NF-e enquanto coleta mais informações. Esse evento libera a possibilidade de download da NF-e pelo destinatário. * **Desconhecimento da Operação (210220)**: Manifestação do destinatário declarando que a operação descrita da NF-e não foi por ele solicitada. * **Operação não Realizada (210240)**: Manifestação do destinatário reconhecendo sua participação na operação descrita na NF-e, mas declarando que a operação não ocorreu ou não se efetivou como informado nesta NF-e. **Informações adicionais**: - Cota: <a href="/docs/limites#dfe-eventos">dfe-eventos</a> - Consumo: 1 unidade por requisição.
753 754 755 756 757 758 759 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 |
# File 'lib/nuvemfiscal_sdk_ruby/api/distribuio_nfe_api.rb', line 753 def manifestar_nfe_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistribuioNFEApi.manifestar_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 DistribuioNFEApi.manifestar_nfe" end # resource path local_var_path = '/distribuicao/nfe/manifestacoes' # 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] || 'DistribuicaoNfeEvento' # auth_names auth_names = opts[:debug_auth_names] || ['jwt', 'oauth2'] = opts.merge( :operation => :"DistribuioNFEApi.manifestar_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DistribuioNFEApi#manifestar_nfe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |