Ir para o conteúdo principal

OS 105677 - MELHORIA - DOC. ELETRÔNICO - INCLUSÃO DA TAG CODOBRA NO LAYOUT DO WEB SERVICE VINHEDO

Objetivo

Disponibilizar o vínculo da obra nos objetos do contrato e garantir que o código informado seja propagado para o pedido e para a nota fiscal gerada pelo faturamento do contrato, permitindo sua utilização na TAG <codObra> do XML do Web Service de Vinhedo.

Premissas

  • Necessário o ambiente estar atualizado com as versões:
    • Módulo Contratos de número 150671 / 150815 ou superior;
    • Módulo Doc. Eletrônico de número 150664 / 150674 ou superior;
    • Módulo Scripts de número SQL: 149319 / Postgres: 149320 ou superior;
  • Funcionalidade HABILITA_WEBSERVICE_VINHEDO precisa estar ativa via banco de dados, caso necessário entre em contato com a Send Solutions.
  • O participante utilizado no contrato deve possuir obra cadastrada em Fiscal > EFD-REINF > Parametrização de parceiros.
  • Para os testes de homologação, utilizar o código de obra 000000000106, cadastrado no sistema da Prefeitura de Vinhedo.
  • O cadastro de séries para notas de serviço deve estar devidamente parametrizado.
  • Antes do teste, deve ser verificado o último número de nota gerado no sistema da Prefeitura de Vinhedo e atualizado o cadastro de séries.
  • No módulo Documento Eletrônico, acesse Configuração > Cadastro de Parâmetros, atualize as Notas Técnicas e confirme que a Nota Técnica 2026 - TAGS CODOBRA está disponível para o tipo de documento RPS_Vinhedo.

codex-clipboard-6cffc939-1c87-4db8-9c19-34739c970715.png

ATENÇÃO: Não houve alteração nas telas ou processos utilizados exclusivamente para as parametrizações iniciais.

Cenário 01: Validar disponibilização dos campos de obra no objeto do contrato

Objetivo: Validar a inclusão dos campos Indicativo de Obra e Código de Obra na guia Objetos do cadastro de contratos.

Pré-condição:

  • Funcionalidade HABILITA_WEBSERVICE_VINHEDO habilitada.
  • Tipos de participantes do contrato devidamente cadastrados.
  • Participante com obra cadastrada no módulo Fiscal.
  • Utilizar preferencialmente a obra 000000000106 para homologação.

Resultado Esperado: Ao inserir ou editar um objeto do contrato, o sistema deve disponibilizar os campos Indicativo de Obra e Código de Obra.

Na pesquisa do Código de Obra, devem ser apresentadas as obras cadastradas no módulo Fiscal correspondentes ao primeiro participante ativo que possua o tipo de documento parametrizado diferente de “NENHUM”.

A obrigatoriedade dos campos Inscrição do Imóvel e Cadastro Imobiliário deve ser apresentada conforme a configuração do Indicador de Operação, sem exibir “SIM” indevidamente quando não houver obrigatoriedade definida.

Passo a passo:

  1. Acesse o módulo Fiscal.

    image.png


  2. Acesse EFD-REINF > Parametrização de parceiros.

    image.png


  3. Localize o participante que será utilizado no contrato.

    image.png


  4. Consulte as obras cadastradas para o participante.
  5. Certifique-se de que a obra 000000000106 esteja disponível para utilização no teste.

    image.png


  6. Acesse o módulo Gestão de Contratos.

    image.png


  7. Acesse Gestão de Contratos > Contratos.

    image.png


  8. Insira um novo contrato.

    image.png


  9. Selecione o tipo de contrato.
  10. Informe o número e confirme.

    image.png


  11. Preencha as informações do contrato.
  12. Insira os participantes.

    image.png


  13. Informe os dados do responsável.

    image.png


  14. Acesse a guia Objetos.
  15. Clique para inserir um objeto.
  16. Verifique a apresentação dos campos Indicativo de Obra e Código de Obra.
  17. Acione a pesquisa do Código de Obra.
  18. Verifique as obras apresentadas.
  19. Selecione a obra 000000000106.

    image.png


  20. Confirme o objeto.
  21. Verifique se o objeto foi incluído corretamente no contrato.

    image.png


Cenário 02: Validar propagação do Código de Obra no faturamento do contrato

Objetivo: Validar que o Código de Obra informado no objeto do contrato seja propagado para o pedido e para a nota fiscal gerada durante o faturamento.

Pré-condição:

  • Contrato cadastrado conforme o Cenário 01.
  • Objeto do contrato contendo o Código de Obra 000000000106.
  • Dados necessários ao faturamento devidamente preenchidos.
  • Série da nota de serviço corretamente parametrizada.

Resultado Esperado: Ao gerar a nota fiscal a partir da medição do contrato, o sistema deve considerar o Código de Obra informado no objeto e aplicá-lo ao pedido e à nota fiscal gerada.

Quando existirem diferentes códigos de obra nos objetos do contrato, deve ser considerado somente o primeiro código de obra localizado.

Para faturamentos relacionados a obras distintas, as emissões das notas devem ser realizadas separadamente.

Passo a passo:

  1. No contrato criado anteriormente, informe os dados necessários para faturamento.

    image.png


  2. Confirme e finalize a digitação.

    image.png


  3. Confirme a criação do contrato.

    image.png


  4. Acesse Lançamentos > Medição.

    image.png


  5. Insira uma nova medição.

    image.png


  6. Informe o contrato criado.
  7. Confirme.

    image.png


  8. Insira o item da medição.
  9. Informe a quantidade.

    image.png


  10. Preencha as demais informações necessárias.
  11. Confirme e finalize a medição.image.png
  12. Envie a medição para aprovação.

    image.png


  13. Acesse Lançamentos > Aprovação de Medição.

    image.png


  14. Aprove a medição.

    image.png


  15. Confirme o retorno da medição.

    image.png


  16. Na tela de apontamento, informe a data de competência.
  17. Confirme os dados.
  18. Gere a nota fiscal.
  19. Confirme a geração.

    image.png

    image.png


  20. Consulte o contrato faturado.

    image.png


  21. Identifique o número da NF gerada.

    image.png


  22. Consulte o pedido e a nota fiscal.
    Evidência da validação do Código de Obra na nota fiscal
  23. Verifique se o Código de Obra 000000000106 foi aplicado corretamente.

ATENÇÃO: O sistema Send considera somente um item para transmissão de notas de serviço.

Cenário 03: Validar geração da TAG <codObra> no XML de Vinhedo

Objetivo: Validar a geração da TAG <codObra> no XML de transmissão de NFS-e de Vinhedo quando a nota fiscal possuir Código de Obra.

Pré-condição:

  • Nota fiscal gerada pelo faturamento do contrato.
  • Código de Obra 000000000106 presente na nota.
  • Nota Técnica 2026 - TAGS CODOBRA devidamente parametrizada para RPS_Vinhedo.
  • Demais Notas Técnicas aplicáveis ao período do teste devidamente vigentes.

Resultado Esperado: Ao gerar o XML para transmissão de uma nota contendo Código de Obra, o layout do Web Service de Vinhedo deve considerar a TAG <codObra> com o código da obra. A transmissão deve ser validada e a nota fiscal deve apresentar o mesmo Código de Obra.

<codObra>000000000106</codObra>

Passo a passo:

  1. Acesse o módulo Documentos Eletrônicos.
  2. Acesse NFS-e > Transmissão Vinhedo.

    image.png


  3. Localize a nota fiscal gerada no cenário anterior.
  4. Selecione a nota.
  5. Clique em Gerar XML para Transmissão.

    image.png


  6. Acompanhe o processamento da transmissão.
  7. Verifique se a nota apresenta o status XML Validado.
  8. Consulte a nota fiscal gerada.
  9. Verifique o campo Cód. Obra.
  10. Confirme que o valor corresponde ao Código de Obra selecionado no contrato.

Evidência: A nota fiscal apresenta o Código de Obra informado no contrato após a validação do XML de transmissão.

image.png

Observação: Antes de gerar o XML, certifique-se de que todas as Notas Técnicas aplicáveis à data da emissão estejam vigentes, incluindo as relacionadas às TAGs de IBS.

Cenário 04: Validar comportamento sem Código de Obra cadastrado

Objetivo: Validar o tratamento realizado pelo Web Service de Vinhedo quando a transmissão for realizada sem o Código de Obra necessário.

Pré-condição:

  • Nota fiscal disponível para transmissão.
  • Cenário preparado sem o Código de Obra esperado para a operação.

Resultado Esperado: Ao realizar a simulação/transmissão sem a obra devidamente cadastrada, o processo não deve ser concluído como uma transmissão válida e deve ser apresentada a respectiva mensagem de erro, permitindo identificar a ausência/inconsistência da obra.

Passo a passo:

  1. Prepare uma nota para o cenário sem a obra devidamente cadastrada.
  2. Acesse Documentos Eletrônicos > NFS-e > Transmissão Vinhedo.
  3. Selecione a nota.
  4. Clique em Gerar XML para Transmissão.
  5. Execute o processo.
  6. Verifique a mensagem apresentada pelo sistema.
  7. Confirme que a inconsistência relacionada à obra impede a conclusão normal do processo.

Observações / Atenções

ATENÇÃO – Ambiente de homologação de Vinhedo

O Web Service de Vinhedo no ambiente de homologação (simulaNFE) não está retornando o Código de Verificação, informação utilizada como Chave da NFS-e.

Na liberação para o cliente, as primeiras transmissões em produção devem ser acompanhadas para confirmar o retorno dessa informação.

ATENÇÃO – Homologação x Produção

Podem existir diferenças entre os ambientes de homologação e produção do Web Service de Vinhedo.

Dessa forma, as primeiras emissões em produção devem ser acompanhadas para confirmar que:

  • a transmissão foi concluída com êxito;
  • o Código de Verificação foi retornado;
  • a NFS-e foi devidamente registrada no sistema da Prefeitura de Vinhedo;
  • o Código de Obra foi enviado conforme esperado.

ATENÇÃO – Nota Técnica

A Nota Técnica referente ao Código de Obra possui vigência em produção a partir de 14/09. Antes das primeiras emissões, confirme se o Web Service de Vinhedo está configurado para receber a TAG <codObra>.

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

Ficou com alguma dúvida?