Ir para o conteúdo principal

OS 105182 - MELHORIA - NOTA FISCAL DE VENDA DE SEMINOVOS

Objetivo:

A solicitação tem como objetivo disponibilizar uma nova forma de integração para o processo de emissão de Nota Fiscal Eletrônica de venda de seminovos, permitindo que um sistema externo realize, por meio de APIs, as operações de geração da NF-e, transmissão/autorização junto à SEFAZ e cancelamento da nota fiscal.

A nova integração tem como objetivo automatizar o processo atualmente realizado por meio da importação de planilhas, possibilitando que as informações sejam enviadas diretamente ao sistema responsável pelo faturamento.

Mesmo com a disponibilização das APIs, o processo tradicional de importação por planilha deverá continuar disponível e funcionando normalmente, mantendo as parametrizações e rotinas já existentes.

Para validação da integração, as chamadas às APIs serão simuladas por meio de uma ferramenta de testes, permitindo conferir os dados enviados, os retornos recebidos e os reflexos de cada operação dentro do sistema.

Os testes deverão ser realizados em pelo menos dois ambientes/clientes, sempre que estes estiverem aptos à execução das operações fiscais necessárias.

Premissas:

  • Necessário o ambiente estar atualizado com as versões:
    • Doc. Eletrônico de número XXXX ou superior;
    • Faturamento de número XXXX ou superior;

Teste realizado após a atualização.

Cenário 01: Preparar a planilha para importação dos pedidos

Objetivo:
Preparar a planilha que será utilizada na validação do processo tradicional de importação de pedidos, utilizando o modelo disponibilizado pelo próprio sistema.

Pré-condição:
O usuário deve possuir acesso ao módulo de Vendas e à funcionalidade de Importação de pedidos por Excel.

Resultado Esperado:
O modelo da planilha deve ser disponibilizado pelo sistema e permitir o preenchimento dos dados necessários para posterior importação do pedido.

Passo a passo:

  1. Acessar o módulo Vendas.

    image.png


  2. Acessar Orçamentos/Pedidos > Importação de pedidos por excel.

    image.png


  3. Na tela Importação de Pedidos por Excel, clicar em Baixar modelo de planilha.

    image.png


  4. Abrir a planilha disponibilizada pelo sistema.
  5. Preencher ou alterar os dados da planilha conforme o pedido que será utilizado no teste.
  6. Informar dados válidos para os campos obrigatórios do processo.
  7. Nos campos destinados ao endereço de e-mail, informar um e-mail válido e ao qual o responsável pelo teste possua acesso, pois posteriormente será necessário validar o recebimento dos documentos da NF-e.
  8. Conferir as informações preenchidas.
  9. Salvar a planilha para utilizá-la no cenário de importação.

    image.png

Atenção: Dados técnicos de autenticação, tokens e endereços internos não devem ser apresentados na documentação destinada ao cliente.


Cenário 02: Importar a planilha e validar a geração do pedido

Objetivo:
Validar que a planilha preparada anteriormente possa ser importada pelo processo tradicional, realizando corretamente o processamento e a geração do pedido no sistema.

Pré-condição:
A planilha deve ter sido preparada conforme o Cenário 01, utilizando o modelo disponibilizado pelo próprio sistema e contendo dados válidos para importação.

Resultado Esperado:
A planilha deve ser importada e processada sem erros. Após o processamento, o sistema deve gerar o pedido correspondente aos dados informados no arquivo, permitindo sua continuidade no processo de faturamento.

Passo a passo:

  1. Acessar o módulo Vendas.
  2. Acessar Orçamentos/Pedidos > Importação de pedidos por excel.
    image.png
  3. No campo Tipo de Pedido, selecionar o tipo correspondente ao processo que será realizado.
  4. Na seção Importação de Excel de pedidos, clicar em Adicionar Arquivos.
  5. Localizar e selecionar a planilha preparada no Cenário 01.
  6. Confirmar que o arquivo selecionado foi apresentado na tela.
  7. Após o carregamento do arquivo, clicar em Confirmar para iniciar o processamento da importação.

    image.png

  8. Acessar Vendas > Orçamentos/Pedidos > Monitoramento de Processos Excel.
  9. Localizar o processamento referente à importação realizada.
  10. Acessar a lupa correspondente ao processamento para consultar seu resultado.

    image.png


  11. Confirmar que a importação foi concluída sem erros.
  12. Conferir a mensagem apresentada pelo processamento e identificar o número do pedido gerado.
    image.png

  13. Acessar Vendas > Orçamentos/Pedidos > Emissão/Alteração.

    image.png


  14. Localizar o pedido gerado pela importação.


  15. Abrir o pedido e conferir os dados importados, incluindo cliente, itens, quantidades, valores e demais informações preenchidas na planilha.
  16. Confirmar que o pedido foi criado corretamente e está disponível para continuidade do processo de faturamento.



Cenário 03: Gerar a NF-e pelo processo tradicional

Objetivo:
Validar que os pedidos gerados pela importação da planilha continuem disponíveis para faturamento pelo processo tradicional, permitindo a geração da NF-e normalmente pelo sistema.

Pré-condição:
A planilha deve ter sido importada e processada com sucesso, conforme o cenário anterior, e deve existir ao menos um pedido gerado pela importação disponível para faturamento.

Resultado Esperado:
O pedido gerado pela importação deve ser apresentado normalmente na rotina de faturamento. Ao realizar o faturamento, o sistema deve gerar a NF-e com sucesso, mantendo as informações correspondentes ao pedido e disponibilizando a nota para transmissão.

Passo a passo:

  1. No LOG de Processamento da importação realizada no cenário anterior, selecionar um dos pedidos apresentados como cadastrado com sucesso e anotar seu número.
  2. Acessar o módulo Faturamento.

    image.png


  3. Acessar Notas Fiscais > Emissão Simplificada.

    image.png


  4. Na tela Pedidos a Faturar, no campo Tipo, selecionar PD – PEDIDOS DIVERSOS.
  5. Em Filtrar por, selecionar Pedido.
  6. No campo Valor, informar o número do pedido selecionado no processamento da importação.
  7. Localizar o pedido apresentado na relação de documentos disponíveis para faturamento.
  8. Conferir as informações apresentadas para o pedido, como parceiro, filial, razão social, frete, pagamento, finalidade e valor a faturar.
  9. Marcar a caixa de seleção correspondente ao pedido.
  10. Clicar em Faturar Selecionados.
  11. Aguardar a conclusão do processamento.
  12. Confirmar que o processo foi concluído sem erros.
  13. No resultado do processamento, verificar a mensagem informando que a nota fiscal foi gerada com sucesso.
  14. Anotar o número da NF-e gerada.
  15. Acessar Faturamento > Notas Fiscais > Consulta Nota Fiscal.
  16. Pesquisar pelo número da NF-e gerada.
  17. Abrir a consulta da nota fiscal.
  18. Conferir as informações gerais, totais, transportes, pagamento, itens e pedido relacionado.
  19. Confirmar que os dados da NF-e correspondem às informações do pedido utilizado no faturamento.

Cenário 04: Transmitir e autorizar a NF-e pelo processo tradicional

Objetivo:
Validar que a NF-e gerada pelo processo tradicional possa ser transmitida e autorizada normalmente no ambiente de homologação da SEFAZ.

Pré-condição:
Deve existir uma NF-e gerada com sucesso pelo processo tradicional e disponível para transmissão.

Resultado Esperado:
A NF-e deve ser transmitida sem erros e autorizada no ambiente de homologação, passando a possuir chave de acesso e protocolo de autorização.

Passo a passo:

  1. Anotar o número da NF-e gerada no cenário anterior.
  2. Acessar o módulo Documento Eletrônico.
  3. Acessar NFE > Transmissão.
  4. Confirmar que a rotina está sendo utilizada no Ambiente de Homologação.
  5. No campo NF Inicial, informar o número da NF-e gerada.
  6. No campo NF Final, informar o mesmo número da NF-e.
  7. Executar a pesquisa.
  8. Localizar a NF-e na relação de Notas a transmitir.
  9. Conferir o número, série, cliente e demais informações apresentadas.
  10. Marcar a caixa de seleção correspondente à nota.
  11. Clicar em Transmitir.
  12. Aguardar a conclusão do processamento.
  13. Confirmar que o sistema apresenta a mensagem de transmissão realizada com sucesso.
  14. Retornar ao módulo Faturamento.
  15. Acessar Notas Fiscais > Consulta Nota Fiscal.
  16. Pesquisar pela NF-e transmitida.
  17. Confirmar que a nota apresenta a situação correspondente à transmissão.
  18. Abrir a consulta da NF-e.
  19. Conferir a Chave da NF-e.
  20. Conferir o Protocolo NF-e.
  21. Confirmar que os demais dados do documento permaneceram corretos após a transmissão.

Cenário 05: Validar a NF-e na SEFAZ e o envio dos documentos por e-mail

Objetivo:
Confirmar que a NF-e transmitida pelo processo tradicional esteja registrada no ambiente de homologação da SEFAZ e que os respectivos documentos fiscais possam ser encaminhados por e-mail.

Pré-condição:
A NF-e deve estar transmitida e autorizada, possuir chave de acesso e ter um endereço eletrônico válido informado para recebimento.

Resultado Esperado:
A NF-e deve ser localizada no ambiente de homologação da SEFAZ com informações correspondentes ao documento gerado no sistema. O e-mail deve ser enviado com sucesso, contendo os documentos fiscais correspondentes à nota.

Passo a passo:

  1. Na consulta da NF-e no sistema, copiar a Chave da NF-e.
  2. Acessar o portal de consulta de NF-e do ambiente de homologação da SEFAZ.
  3. Informar a chave de acesso.
  4. Realizar a consulta.
  5. Conferir o número e a série da NF-e.
  6. Conferir os dados do emitente e destinatário.
  7. Conferir os produtos e valores apresentados.
  8. Confirmar que as informações correspondem à NF-e gerada e transmitida pelo sistema.
  9. Retornar ao módulo Documento Eletrônico.
  10. Acessar NFE > Envio de E-mail.
  11. Utilizar os filtros disponíveis para localizar a NF-e utilizada no teste.
  12. Conferir o número da nota e o endereço de e-mail apresentado para envio.
  13. Selecionar a NF-e.
  14. Clicar em Enviar.
  15. Aguardar a confirmação do processamento.
  16. Acessar a caixa de e-mail utilizada no teste.
  17. Localizar a mensagem correspondente à NF-e.
  18. Conferir o número da nota e a chave eletrônica apresentados na mensagem.
  19. Conferir os documentos anexados.
  20. Validar o recebimento do XML e do documento auxiliar da NF-e.
  21. Confirmar que os arquivos recebidos correspondem à NF-e utilizada no teste.

Cenário 06: Cancelar a NF-e e o pedido pelo processo tradicional

Objetivo:
Validar que uma NF-e autorizada pelo processo tradicional possa ser cancelada no sistema, juntamente com o respectivo pedido.

Pré-condição:
Deve existir uma NF-e previamente gerada e autorizada no ambiente de homologação.

Resultado Esperado:
O sistema deve permitir realizar o cancelamento da NF-e e do pedido relacionado, registrando corretamente a operação e deixando o documento disponível para transmissão do cancelamento à SEFAZ.

Passo a passo:

  1. Acessar o módulo Faturamento.
  2. Acessar Notas Fiscais > Cancela Nota Fiscal.
  3. Informar o número da NF-e utilizada no teste.
  4. Executar a pesquisa.
  5. Localizar a nota fiscal.
  6. No campo referente ao retorno do pedido, selecionar a opção correspondente ao cancelamento do pedido.
  7. No campo referente à transmissão da nota cancelada, selecionar a opção para cancelar e transmitir posteriormente.
  8. Conferir se a NF-e apresentada corresponde ao documento utilizado no teste.
  9. Selecionar a nota fiscal.
  10. Executar o cancelamento.
  11. Aguardar a conclusão do processamento.
  12. Acessar Faturamento > Notas Fiscais > Consulta Nota Fiscal.
  13. Pesquisar novamente pela NF-e.
  14. Confirmar que a nota apresenta a situação Cancelada.
  15. Confirmar que o pedido relacionado também recebeu o tratamento previsto para o cancelamento.

Cenário 07: Transmitir e validar o cancelamento da NF-e na SEFAZ pelo processo tradicional

Objetivo:
Validar que o cancelamento realizado pelo processo tradicional seja transmitido corretamente para a SEFAZ.

Pré-condição:
A NF-e deve estar cancelada no sistema e possuir autorização eletrônica anterior.

Resultado Esperado:
O cancelamento deve ser transmitido sem erros e aceito no ambiente de homologação da SEFAZ. Após a transmissão, a consulta da NF-e deverá demonstrar que o evento de cancelamento foi registrado.

Passo a passo:

  1. Acessar o módulo Documento Eletrônico.
  2. Acessar NFE > Transmissão.
  3. Confirmar que a rotina está sendo executada no Ambiente de Homologação.
  4. Localizar a NF-e cancelada no cenário anterior.
  5. Selecionar a nota.
  6. Executar a transmissão.
  7. Aguardar o retorno do processamento.
  8. Confirmar que a transmissão do cancelamento foi concluída sem erros.
  9. Utilizar a chave de acesso da NF-e.
  10. Acessar o portal de consulta de NF-e do ambiente de homologação da SEFAZ.
  11. Consultar novamente o documento.
  12. Confirmar que o evento de cancelamento foi registrado para a NF-e.

Atenção: Durante o desenvolvimento foi identificada uma ocorrência na rotina de cancelamento eletrônico do próprio sistema. Neste cenário deverá ser confirmado que o cancelamento pode ser transmitido normalmente e concluído junto à SEFAZ.


Processo via API

Cenário 08: Preparar a ferramenta para execução das APIs

Objetivo:
Preparar a ferramenta de testes para simular as requisições que serão realizadas pelo sistema integrado nas operações de geração, transmissão e cancelamento da NF-e.

Pré-condição:
Possuir acesso à ferramenta utilizada para execução das APIs, ao arquivo de configuração das requisições e às informações necessárias para acesso ao ambiente de homologação.

Resultado Esperado:
As requisições devem ser importadas e configuradas corretamente para o ambiente de testes, ficando disponíveis para execução.

Passo a passo:

  1. Abrir o Postman.
  2. Acessar o menu principal da ferramenta.
  3. Selecionar File > Import.
  4. Selecionar o arquivo de configuração disponibilizado para execução dos testes.
  5. Confirmar a importação.
  6. Caso a ferramenta informe que a coleção já existe, selecionar a opção para Importar como cópia (Import as Copy), evitando substituir configurações existentes.
  7. Acessar a coleção importada.
  8. Confirmar que as requisições necessárias ao processo estão disponíveis.
  9. Em cada requisição, substituir o endereço configurado localmente pelo endereço correspondente ao ambiente de QA.
  10. Acessar a aba Authorization.
  11. Selecionar o tipo de autenticação Bearer Token.
  12. Informar a credencial disponibilizada para utilização no ambiente.
  13. Repetir a configuração para as demais requisições.
  14. Confirmar que todas as requisições estão apontando para o ambiente correto antes de iniciar os testes.

Atenção: As credenciais, tokens e endereços técnicos utilizados para configuração da integração devem ser tratados conforme as orientações de acesso fornecidas para o ambiente e não devem ser expostos na documentação.


Cenário 09: Gerar pedido e NF-e por meio da API

Objetivo:
Validar que a integração permita enviar os dados necessários para geração automática do pedido e da respectiva NF-e no sistema.

Pré-condição:
As requisições devem estar configuradas para o ambiente de QA e os dados utilizados no teste devem ser válidos.

Resultado Esperado:
A requisição deve ser processada sem erro e retornar a confirmação da geração, incluindo os números correspondentes ao pedido e à NF-e.

O pedido e a nota fiscal gerados devem ser registrados no sistema com os dados enviados pela integração.

Passo a passo:

  1. No Postman, acessar a requisição responsável pela geração do pedido/NF-e.
  2. Acessar a aba Body.
  3. Localizar o conteúdo JSON da requisição.
  4. Preencher ou alterar os dados necessários para o pedido que será utilizado no teste.
  5. Conferir os dados informados antes do envio.
  6. Clicar em Send.
  7. Aguardar o retorno da requisição.
  8. Confirmar que a chamada foi processada com sucesso.
  9. Conferir no JSON retornado a indicação de Geracao = true.
  10. Conferir o número do pedido retornado.
  11. Conferir o número da NF-e retornado.
  12. Confirmar que não foi apresentada mensagem de erro.
  13. Anotar os números retornados, pois serão utilizados nas próximas etapas.
  14. Acessar o módulo Faturamento.
  15. Acessar Notas Fiscais > Consulta Nota Fiscal.
  16. Pesquisar pelo número da NF-e retornado pela integração.
  17. Abrir a consulta da nota.
  18. Conferir as informações gerais.
  19. Conferir os totais.
  20. Conferir transportes, pagamento e itens.
  21. Conferir o pedido relacionado.
  22. Confirmar que os dados gravados correspondem às informações enviadas pela API.

Cenário 10: Transmitir e autorizar a NF-e por meio da API

Objetivo:
Validar que uma NF-e gerada pela integração possa ser transmitida e autorizada eletronicamente por meio da API.

Pré-condição:
O pedido e a NF-e devem ter sido gerados com sucesso pela API no cenário anterior.

Resultado Esperado:
A requisição deve concluir a transmissão sem erros, retornando a confirmação da operação e a chave de acesso da NF-e. A autorização também deve ser refletida corretamente no sistema.

Passo a passo:

  1. No Postman, acessar a requisição responsável pela transmissão da NF-e.
  2. Acessar a aba Body.
  3. Informar no JSON o número do pedido retornado no cenário anterior.
  4. Conferir os demais identificadores necessários para a transmissão.
  5. Clicar em Send.
  6. Aguardar o retorno da requisição.
  7. Confirmar que a chamada foi processada com sucesso.
  8. Conferir no JSON retornado a indicação de Transmissao = true.
  9. Conferir a chave de acesso retornada.
  10. Confirmar que não foi apresentada mensagem de erro.
  11. Acessar o módulo Faturamento.
  12. Acessar Notas Fiscais > Consulta Nota Fiscal.
  13. Pesquisar pela NF-e gerada via API.
  14. Confirmar que a nota apresenta a situação correspondente à transmissão.
  15. Abrir a consulta da NF-e.
  16. Conferir a chave de acesso.
  17. Conferir o protocolo de autorização.
  18. Confirmar que as demais informações da nota permaneceram corretas.

Cenário 11: Validar a NF-e gerada via API na SEFAZ e o envio por e-mail

Objetivo:
Confirmar que a NF-e transmitida pela API tenha sido efetivamente autorizada no ambiente de homologação da SEFAZ e que os documentos fiscais tenham sido encaminhados ao endereço eletrônico informado.

Pré-condição:
A NF-e deve ter sido transmitida com sucesso pela API e possuir chave de acesso.

Resultado Esperado:
A NF-e deve ser localizada no ambiente de homologação da SEFAZ com os mesmos dados existentes no sistema. O retorno da integração deve indicar sucesso no envio do e-mail e os documentos fiscais devem ser recebidos corretamente.

Passo a passo:

  1. Conferir no retorno da transmissão a indicação de Email = true.
  2. Copiar a chave de acesso retornada pela API.
  3. Acessar o portal de consulta de NF-e do ambiente de homologação da SEFAZ.
  4. Informar a chave de acesso.
  5. Realizar a consulta.
  6. Conferir o número e a série da NF-e.
  7. Conferir os dados do emitente e destinatário.
  8. Conferir os produtos e valores.
  9. Confirmar que os dados correspondem à NF-e gerada pela integração.
  10. Acessar a caixa de e-mail utilizada no teste.
  11. Localizar a mensagem referente à NF-e.
  12. Conferir o número da nota e a chave eletrônica apresentados na mensagem.
  13. Conferir os anexos recebidos.
  14. Validar o XML e o documento auxiliar da NF-e.
  15. Confirmar que os documentos correspondem à nota gerada via API.

Cenário 12: Cancelar o pedido e a NF-e por meio da API

Objetivo:
Validar que a integração permita solicitar o cancelamento do pedido e da NF-e anteriormente gerados e autorizados.

Pré-condição:
Deve existir uma NF-e gerada via API e previamente autorizada no ambiente de homologação.

Resultado Esperado:
A requisição de cancelamento deve ser processada sem erro, indicando que o cancelamento foi realizado no sistema. A NF-e deverá apresentar a situação correspondente ao cancelamento.

Passo a passo:

  1. No Postman, acessar a requisição utilizada para o cancelamento.
  2. Acessar a aba Body.
  3. Informar o número do pedido correspondente à NF-e utilizada no teste.
  4. Informar o motivo do cancelamento no campo correspondente.
  5. Conferir os dados da requisição.
  6. Clicar em Send.
  7. Aguardar o retorno.
  8. Confirmar que a chamada foi processada com sucesso.
  9. Conferir no JSON retornado a indicação de Geracao = true.
  10. Confirmar que não foi apresentada mensagem de erro referente ao cancelamento interno.
  11. Acessar o módulo Faturamento.
  12. Acessar Notas Fiscais > Consulta Nota Fiscal.
  13. Pesquisar pela NF-e utilizada no teste.
  14. Confirmar que o documento apresenta a situação Cancelada.

Cenário 13: Transmitir e validar o cancelamento da NF-e na SEFAZ por meio da API

Objetivo:
Validar que o cancelamento realizado por meio da integração possa ser transmitido e registrado corretamente na SEFAZ.

Pré-condição:
A NF-e deve estar cancelada no sistema e possuir autorização eletrônica anterior.

Resultado Esperado:
A requisição deve ser concluída sem mensagem de erro e o retorno referente à transmissão deve indicar Transmissao = true, demonstrando que o cancelamento foi transmitido com sucesso.

O evento de cancelamento também deverá ser localizado no ambiente de homologação da SEFAZ.

Passo a passo:

  1. No Postman, retornar à requisição responsável pela transmissão da NF-e.
  2. Acessar a aba Body.
  3. Informar o número do pedido correspondente à NF-e cancelada.
  4. Conferir os dados da requisição.
  5. Clicar em Send.
  6. Aguardar o retorno.
  7. Confirmar que não foi apresentada mensagem de erro.
  8. Conferir no JSON retornado a indicação de Transmissao = true.
  9. Conferir, quando aplicável ao retorno da operação, a indicação referente ao envio de e-mail.
  10. Utilizar a chave de acesso da NF-e cancelada.
  11. Acessar o portal de consulta de NF-e do ambiente de homologação da SEFAZ.
  12. Informar a chave de acesso.
  13. Realizar a consulta.
  14. Confirmar que o evento de cancelamento foi registrado para a NF-e.

Atenção: Durante o desenvolvimento foi identificada uma ocorrência na rotina de cancelamento eletrônico do sistema. O resultado esperado deste teste é que a chamada não apresente erro e que o retorno da transmissão seja true, confirmando a conclusão do cancelamento junto à SEFAZ.

Ficou com alguma dúvida .png

ATENÇÃO: As informações neste documento são meramente ilustrativas e utilizadas apenas para fins de teste.