Este conteúdo não recebe atualizações, pois é referente a uma versão do sistema que foi descontinuada. Acesse a documentação da versão 5.8.15.
Manual do usuário - eDocs > Integrações > Roteiros de integração > Roteiro de integração eDocs

Roteiro de integração do eDocs

Esta documentação tem como objetivo fornecer um roteiro para o desenvolvimento de integração com o eDocs.

Saiba mais:

  1. Requisitos e parametrizações
  2. Tipos de integração
  3. Leiautes e web services
  4. Perguntas frequentes - FAQ

1. Requisitos e parametrizações

Cadastro de filial

Para que a integração ocorra corretamente, é necessário atender aos seguintes requisitos:

Por exemplo, se existir uma empresa com o CNPJ XX. XXX. XXX/0001-XX e uma filial desta empresa com o CNPJ YY. YYY. YYY/0001-YY, onde a responsável pelas emissões das NF-es é a filial, então o CNPJ da filial deve estar cadastrado no banco de dados do eDocs para que a integração ocorra corretamente. Para cadastrar essas informações, verifique a documentação sobre Configurações de Empresas e Configurações de Filiais.

Parametrizações

Para que seja possível realizar a integração com o eDocs, as configurações abaixo devem ser realizadas:

Observações

Para que o processo de integração ocorra corretamente, é necessário atentar para os seguintes pontos de validação:

2. Tipos de integração

O eDocs permite a integração através de web services síncronos ou assíncronos. Alguns documentos não possuem suporte para integração assíncrona. Segue abaixo uma tabela demonstrativa que apresenta as formas de integração disponibilizadas para cada tipo de documento eletrônico:

 

Documentos

Web service
AutorizarDocumentos (síncrono) IntegrarDocumento (assíncrono)
Federais / Estaduais NF-e
CT-e
CT-e OS
MDF-e
eSocial
NFC-e
EFD Reinf
PAF-ECF
GNRE
GRFGTS
CF-e
Recintos Aduaneiros
Receituário Agronômico
SISDEV
IDAF
Municipais NFS-e

Importante

  • Antes de ser iniciada a parametrização da integração entre o qualquer sistema com o eDocs, deve-se definir a forma adequada de comunicação entre os dois sistemas. Isso porque a parametrização inadequada da integração poderá acarretar problemas de integração e consumo desnecessário de recursos do Servidor
  • Caso seja utilizado eDocs Embarcado, poderão haver limitações de funcionalidades que necessitam de web service do eDocs. Para maiores informações, consulte a documentação do eDocs sobre as funcionalidade liberadas

3. Leiautes e web services

Ao realizar as etapas apresentadas acima e configurar a integração de emissões e recebimentos de NF-e, os web services do eDocs estarão ativos e operacionais. Abaixo, segue o detalhamento dos web services e leiautes que devem ser utilizados para realizar a integração:

Documentos Leiaute Operação Tipo de integração Web service utilizado
Federais/Estaduais (NF-e, CT-e, MDF-e, eSocial, etc) XML padrão do governo Emissão, Inutilização e Eventos (cancelamento, etc.) Síncrona AutorizarDocumento
Assíncrona IntegrarDocumentos (envio)
ConsultarSituacaoDocumentos (retorno)
Recebimento Síncrona ConsultarRetornoRecebimento
Síncrona ConsultarSituacaoDocumentos
Municipais (NFS-e) XML padrão ABRASF 1.0 (com complemento InfSenior ) Emissão e Cancelamento Síncrona AutorizarDocumento
Assíncrona IntegrarDocumentos (envio)
ConsultarSituacaoDocumentos (retorno)
Todos documentos - Download XML (Emissão) Síncrona BaixarXml
- Download XML (Recebimento) Síncrona BaixarXmlv2
- Download PDF Síncrona BaixarPdf
- Consultar críticas de integração por tipo de documento Síncrona ObterCriticasIntegracao
- Consultar críticas de integração por identificador Síncrona ObterCriticasPorIdentificador

4. Perguntas frequentes - FAQ

Este artigo ajudou você?