Ir para o conteúdo principal

OS 91207 - OBRIGAÇÕES - DOCUMENTO ELETRÔNICO - CANCELAMENTO DE LANÇAMENTO - ORIGEM ENCONTRO DE CONTAS

Objetivo:

Permitir que o usuário integre o envio de RPS do SEND ERP com a Prefeitura de Vinhedo via Web Service, de forma prática e rastreável, garantindo que seja possível:

  • Transmitir RPS para a prefeitura e obter retorno do processamento (mensagens e XML de resposta).

  • Consultar a existência da chave do RPS no ambiente da prefeitura quando houver chave associada.

  • Cancelar RPS quando necessário, informando o motivo e registrando o XML gerado.

  • Verificar a disponibilidade do serviço (status do Web Service) antes e durante as rotinas, reduzindo falhas por indisponibilidade externa.

Além disso, o processo passa a respeitar regras importantes definidas na implementação:

  • A transmissão poderá ocorrer em dois modos, conforme a configuração da opção
    Integração via Web Service Vinhedo habilitada ou desabilitada:

    • Quando a integração estiver desabilitada, o sistema mantém o comportamento anterior, apenas gerando os arquivos XML para download e importação manual no portal da prefeitura.

    • Quando a integração estiver habilitada e o serviço estiver disponível, o sistema realiza a transmissão diretamente via Web Service, seguindo o padrão atualizado do fornecedor Prescon.

  • Os XMLs de transmissão e de resposta ficam disponíveis no Dashboard
    (Relatórios > Em Processamento) para evidência e auditoria.

Em resumo: o usuário passa a ter rotinas completas de integração (transmissão, consulta, cancelamento e disponibilidade) para Vinhedo, com evidência de processamento e funcionamento conforme o novo modelo do Web Service.

Premissas:

  • Necessário o ambiente estar atualizado com a versão do módulo Documento Eletrônico de número xxxxx132634 Genexus 17 ou superior;
  • A funcionalidade Habilita o uso de WebService Vinhedo deve estar ativa no banco de dados para a empresa/UOP em contexto. Caso necessário entre em contato com a Send.

Teste realizado após a atualização

Cenário 01 – Parametrização (Cadastro de Parâmetros + Importação + Token)

Passo a passo:

  1. Acessar o módulo Documento Eletrônico.

    image.png

  2. Acessar o menu Configuração > Cadastro de Parâmetros.

    image.png

  3. Clicar em Inserir e informar os dados necessários para parametrização.

    image.png

  4. Localizar e editar o parâmetro RPS Vinhedo.

  5. Clicar em Importar os parâmetros.

    image.png

  6. Validar que, para ambiente de HOMOLOGAÇÃO, o serviço emitir_nfe esteja definido com o Nome do Recurso: simula_nfe.

  7. Clicar para informar o Token RPS – Vinhedo.

  8. Na tela de token, preencher o token fornecido pela Prefeitura de Vinhedo, obtido no portal da prefeitura, no menu Dados Cadastrais, com possibilidade de geração de novo token quando necessário.

  9. Confirmar a gravação do token.

    image.png

Resultado esperado:

  • Parâmetros do RPS Vinhedo ficam cadastrados e/ou importados corretamente.

  • Em homologação, o serviço “emitir_nfe” utiliza o recurso “simula_nfe”.

  • Token do RPS Vinhedo fica gravado e disponível para uso nas rotinas.

  • Sem token/parametrização, as rotinas não devem permitir transmissão efetiva (erro controlado ou bloqueio conforme regra).

Cenário 02 – Geração da Nota Fiscal via Contratos (pré-requisito para transmissão)

Objetivo do cenário:
Garantir que exista uma Nota Fiscal de Serviço (RPS) válida, gerada a partir do módulo de Contratos, apta para transmissão ao Web Service de Vinhedo.

02.1 – Cadastro do Contrato

Passo a passo:

  1. Acessar o módulo Gestão de Contratos.

    image.png

  2. Acessar o menu Gestão de Contratos > Contratos.

    image.png

  3. Clicar em Inserir.

    image.png

  4. Informar um número para o contrato e confirmar.

    image.png

  5. Informar a data de início da atividade.

  6. Inserir os participantes do contrato:

    • Contratada: empresa/unidade de Vinhedo

    • Contratante: cliente do contrato

      image.png

  7. Informar o responsável pelo contrato.

  8. Informar os dados de reajuste (quando aplicável).

  9. Inserir o objeto do contrato, garantindo que:

    • o Código de Serviço Federal esteja parametrizado,

    • a classificação fiscal (CFOP/CIO) esteja válida,

    • o NBS esteja disponível e selecionável conforme a parametrização tributária.

      image.png

  10. Informar a condição de pagamento.

    image.png

  11. Clicar em Confirmar e depois em Finalizar.

    image.png

    image.png

Resultado esperado:

  • Contrato gravado com sucesso.

  • Contrato apto para geração de medições e apontamentos.

  • Dados fiscais compatíveis com exigências do Web Service de Vinhedo.

02.2 – Lançamento de Medição do Contrato

Passo a passo:

  1. Acessar o menu Lançamentos > Medição.

    image.png

  2. Clicar em Inserir Medição.

    image.png

  3. Informar o número do contrato e confirmar.

    image.png

  4. Informar os períodos de início e fim da medição.

  5. Clicar em Inserir Item.

    image.png

  6. Selecionar o item do contrato, informar a quantidade e confirmar.

    image.png

  7. Após inserir os itens, clicar em Confirmar e em seguida em Finalizar.

    image.png

Resultado esperado:

  • Medição gravada com status Finaliz. Digitação.

  • Medição disponível para apontamento.

02.3 – Apontamento e Geração da Nota Fiscal

Passo a passo:

  1. Acessar o menu Lançamentos > Apontamento.

    image.png

  2. Clicar em Inserir Apontamento.

    image.png

  3. Informar o número do contrato e confirmar.

    image.png

  4. Informar a discriminação dos serviços.

    image.png

  5. Inserir o item do apontamento, informando a quantidade.

    image.png

  6. Clicar em Confirmar.

  7. Selecionar a opção Gerar Nota Fiscal.

  8. Confirmar a geração da nota.

    image.png

    image.png

Resultado esperado:

  • Nota Fiscal de Serviço (RPS) gerada e faturada.

  • Nota passa a ficar disponível no menu NFS-e > Transmissão Vinhedo.

  • Nota apta para os cenários de transmissão, consulta e cancelamento.

Cenário 02 – Transmitir RPS com integração Web Service habilitada e serviço disponível

Passo a passo:

  1. Acessar o menu NFS-e > Transmissão Vinhedo.

    image.png

    image.png

  2. Confirmar que a opção Habilita o uso de WebService Vinhedo está habilitada.

  3. Validar que o serviço apresenta status ativo/disponível na tela.

  4. Selecionar uma ou mais notas para transmissão.

  5. Clicar em Gerar XML para Transmissão.

    image.png

  6. Aguardar processamento.
  7. O XML de transmissão e o XML de resposta ficam disponíveis no Dashboard:
    Relatórios > Em Processamento.
  8. Não ocorre download automático após o processamento. Ao clicar para baixar o XML de transmissão:

    image.png

Resultado esperado:

  • O sistema transmite as notas via Web Service conforme padrão atualizado.

  • O status da nota só é alterado após retorno de êxito.

  • Mensagens e erros do Web Service são exibidos na tela.

  • O XML de transmissão e o XML de resposta ficam disponíveis no Dashboard:
    Relatórios > Em Processamento.

  • Não ocorre download automático após o processamento.

Cenário 03 – TransmissãNota com status “XML Validado” após transmissão bloqueadavia porWeb nota inválida ou erro de validaçãoService

Após a transmissão bem-sucedida via Web Service, a nota deixa de estar como “A SER TRANSMITIDA” e passa para o status:

XML Validado

Conforme evidenciado na tela apresentada.

Passo a passo:

  1. SelecionarRealizar uma RPS com inconsistência (campo obrigatório ausente ou código de serviçtransmissão inválido)da nota via Web Service.

  2. Acessar novamente o menu NFS-e > Transmissão Vinhedo.

  3. ExecutarFiltrar Gerarpelo número da nota transmitida.

  4. Verificar o campo Status XML.

    para Transmissão.

    image.png

Resultado esperado:

  • OStatus sistemaalterado nãopara concluiXML a transmissão.Validado.

  • ExibeCampo mensagemChave clara indicando a inconsistência ou erro retornado pelo serviço.preenchido.

  • OCampo statusNúmero daRPS nota permanece inalterado.preenchido.

  • ONúmero erroda ficaNota registradoretornado comopela evidênciaprefeitura.

    de
    • auditoria.

  • Registro permanece disponível para consulta e eventual cancelamento.

Cenário 04 – VerificarCancelamento notasem comAmbiente XMLde já gerado/validadoHomologação

Atenção Importante

A Prefeitura de Vinhedo não disponibiliza ambiente de homologação para cancelamento de notas.
Portanto, essa funcionalidade:

Deve ser validada apenas em PRODUÇÃO.

Passo a passo:passo (homologação)

  1. Acessar o menu NFS-e > Transmissão Vinhedo.

  2. Alterar filtro para Status XML.

  3. Localizar nota transmitida.

    image.png

  4. Selecionar notaso queMotivo jáde possuamCancelamento statusno XML Gerado ou Validado.combo.
    image.png

  5. Clicar em Gerar XML para Transmissão.o.

Resultado esperado:observado em Homologação:

  • OSistema sistemagera nãoXML gera/transmitede novamente essas notas.cancelamento.

  • Exibe a mensagem atualizada:
    “O XML das seguintes notas não foram gerados/transmitidos por já estarem com statusRelatório de XML Gerado/Validado”Inconsistências.

Cenário 05 – Consulta RPS com chave associada

Passo a passo:

  1. Atualizar o grid selecionando status TODAS.

  2. SelecionarMensagem uma nota que possua Chave da Nota Fiscal associada.

  3. Clicar no botão Consulta RPS.

Resultado esperado:

  • O sistema executa a consulta via Web Service.

  • Retorna XML confirmando se a chave existe na prefeitura.

  • Atenção: o serviço não retorna o status atual da nota (transmitida/cancelada), apenas a existência.

  • O XML de retorno é exibido e registrado.apresentada:

Cenário 06 – Consulta indisponível para notas sem chave ou cliente modo consulta

Passo a passo:

  1. Selecionar uma nota sem chave associada ou cliente com licença apenas consulta.

  2. Verificar se o botão Consulta RPS está disponível.

Resultado esperado:

  • O botão Consulta RPS“Vinhedo não é exibido ou a funcionalidade é bloqueada conforme regra.

Cenário 07 – Transmissão simultânea de notas ativas e canceladas (ordem de execução)

Passo a passo:

  1. Selecionar notas com status normal e notas com status Cancelada.

  2. Clicar em Gerar XML para Transmissão.

Resultado esperado:

  • O sistema executa em duas etapas:

    1. Gera e transmite XML das notas não canceladas.

    2. Após intervalo de 3 segundos, gera e transmite XML das notas canceladas.

  • São gerados arquivos separados para transmissão e cancelamento.

  • Ambos ficam disponíveis no Dashboard > Em Processamento.

Cenário 08 – Cancelamento com motivo obrigatório

Passo a passo:

  1. Selecionar uma nota cancelada para transmissão.

  2. Selecionar o Motivo de Cancelamento no combo.

  3. Clicar em Transmitir.

Resultado esperado:

  • O sistema exige o motivo antes de prosseguir.

  • Gera o XML de cancelamento separado.

  • Executa a transmissão do cancelamento conforme novo padrão.

Cenário 09 – Cancelamento em homologação (ambiente inexistente)

Passo a passo:

  1. Executar cancelamento em ambiente de homologação.

  2. Confirmar a transmissão.

Resultado esperado:

  • O sistema exibe relatório de inconsistência informando que não existepossui ambiente de homologação para cancelamento.cancelamento de notas!”

image.png

  • No entanto o XML para cancelamento é gerado;

image.png

Sugestões e Recomendações

Recomenda-se que os primeiros testes de transmissão do Web Service da Prefeitura de Vinhedo em ambiente de produção sejam realizados com acompanhamento, a fim de garantir que o processo ocorra conforme o esperado.

Essa recomendação se deve aos seguintes fatores:

  • Alterações recentes na estrutura do Web Service da prefeitura;

  • AindaInexistência assim,de ambiente de homologação para o XMLcancelamento de cancelamento é gerado como evidência.notas;

  • CancelamentoNecessidade realde deve ser validado somente em produçvalidação comprática acompanhamento.

    da
    • integração
diretamente
no

Cenárioambiente 10 – Verificar disponibilidadeoficial do serviço Web Service

Passo a passo:

  1. Acessar a rotina de Transmissão Vinhedo.

  2. Observar o status do serviço exibido.

Resultado esperado:

  • O sistema apresenta:

    • validade do certificado SEFAZ,

    • mensagens de erro do servidor,

    • status ativo/inativo do serviço.

  • A transmissão só pode ocorrer se o serviço estiver disponível.

Cenário 11 – Evidência e rastreabilidade no Dashboard

Passo a passo:

  1. Executar uma transmissão via Web Service com a opção
    Integração via Web Service Vinhedo habilitada.

  2. Acessar Relatórios > Em Processamento.

  3. Localizar o processo gerado.

  4. Baixar:

    • XML Transmissão

    • XML Resposta Vinhedo

Resultado esperado:

  • Os arquivos ficam disponíveis para auditoria e validação.

  • Não existe mais relatório de transmissão, apenas XMLs separados.

  • Evidência completa do envio e retorno fica registrada no sistema.município.

Após a transmissão, orienta-se conferir se as notas foram corretamente integradas ao sistema da Prefeitura de Vinhedo, incluindo a validação do número da nota e da chave de verificação.

Da mesma forma, o processo de cancelamento deve ser acompanhado em produção, uma vez que não é possível validá-lo previamente em ambiente de homologação.

4.png

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

Voltar ao topo