Páginas filhas
  • ER_CTe_v3.00

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

 Este documento é material de especificação dos requisitos de manutenção, trata-se de conteúdo extremamente técnico.                                                             

  

Informações Gerais

 

Especificação

Produto

TSS

Módulo

MDFCT-e

Segmento Executor

Serviços

Chamado

TSTNOS 

País

( X ) Brasil  (  ) Argentina  (  ) Mexico  (  ) Chile  (  ) Paraguai  (  ) Equador

(  ) USA  (  ) Colombia   (  ) Outro _____________.

Objetivo

Demonstrar as implementações necessárias para atender a NT2015/002 do MDF-e. o Manual de Orientações do Contribuinte versão 3.00 

Este ManualEsta nota técnica tem comopor objetivo a apresentaçãodefinição dedas umespecificações novoe Webcritérios Servicetécnicos danecessários SEFAZpara denominadoa MDFeDistribuicaoDFeintegração queentre disponibilizaráos paraPortais osdas atoresSecretarias dode MDF-eFazendas informaçõesdos Estados e documentosos fiscais eletrônicossistemas de seu interesse.  
A distribuição será realizada para terceiros informados no conteúdo do MDF-e no grupo de pessoas autorizadas a acessar o XML (tag:autXML). 
Prazos para entrada em vigência da Nota Técnica: 
  • Ambiente de Homologação: 01/10/2015;
  • informações das empresas emissoras de Conhecimento de Transportes Eletrônicos - CT-e.

    A versão 3.00 introduz novas possibilidades de emissão do Conhecimento de Transporte para outros serviços, visando substituir a Nota Fiscal de Serviço de Transporte modelo 7 no que se refere aos serviços que não envolvem o transporte de cargas, a saber:

    • Transporte de Pessoas;
    • Transporte de Valores;
    • Excesso de Bagagem

    Na primeira versão, o modelo 67 será desenvolvido para atender exclusivamente as prestações de serviço de Transporte de Pessoas, com a possibilidade de ser expandido futuramente para os outros serviços através de revisão do Manual ou Notas Técnicas.

    Ambiente de Produção: 15/10/2015;

    Definição da Regra de Negócio

    Serão utilizados os métodos do Web Service MANIFESTACAODESTINATARIO.

    Através do método SINCRONIZARDOCUMENTOS será possível sincronizar os seguintes documentos fiscais eletrônicos emitidos para a entidade solicitada, desde que esteja autorizado a acessar o XML (tag autXML MDFe): 

    • MDF-e;
    • Evento de Cancelamento do MDF-e;
    • Evento de Encerramento do MDF-e;
    • Evento de Inclusão de Condutor do MDF-e.

     

    Para identificar que a sincronização se refere ao MDF-e (modelo 58), foi criado o parâmetro MODELO neste método.

    O parâmetro MODELO será disponibilizado também através do método CONFIGURARPARAMETROS, a fim de diferenciar as configurações de ambiente e versão para a Manifestação do Destinatário (MD-e, modelo 55) e Manifesto Eletrônico de Documentos Fiscais (MDF-e, modelo 58).

    Através dos métodos MONITORARDOCUMENTOS e RETORNARDOCUMENTO serão disponibilizadas informações relacionadas ao MDF-e e seus eventos já sincronizados.

     

    Web Service MANIFESTACAODESTINATARIO

    • Método CONFIGURARPARAMETROS

    Configura e retorna os parâmetros para a manifestação do destinatário.

     

    Os parâmetros de entrada do método são:

    <soap:Body>

      <USERTOKEN>STRING</USERTOKEN>

      <ID_ENT>STRING</ID_ENT>

      <AMBIENTE>STRING</AMBIENTE>

      <VERSAO>STRING</VERSAO>

      <ULTNSU>STRING</ULTNSU>

      <MODELO>STRING</MODELO>

    </soap:Body>

     

    NomePaiTipoTam.Ocor.Observações
    CONFIGURARPARAMETROS
    ---1-1Tag raiz.
    USERTOKENCONFIGURARPARAMETROSA51-1Deverá ser preenchido com o valor “TOTVS”.
    ID_ENTCONFIGURARPARAMETROSA61-1ID da entidade a ser utilizada.
    AMBIENTECONFIGURARPARAMETROSA10-1

    Ambiente utilizado na sincronização de documentos.

     Os valores possíveis são:

    1 – Produção;

    2 –Homologação.

    VERSAOCONFIGURARPARAMETROSA40-1

    Versão utilizada na sincronização de documentos.

     Os valores possíveis são:

    1.00 - NF-e / MDF-e

    ULTNSUCONFIGURARPARAMETROSA150-1

    Ultimo NSU da sincronização de documentos.

    MODELOCONFIGURARPARAMETROSA20-1

    Modelo de documento utilizado na sincronização do documento.

    Os valores possíveis são:

    55- NF-e;

    58 – MDF-e.
     

    Caso não seja informado, será utilizado o valor “55” como padrão, realizando assim a configuração da Manifestação do Destinatário – MD-e.

     

    Os parâmetros de saída do método são:

     

    <soap:Body>

      <USERTOKEN>STRING</USERTOKEN>

      <ID_ENT>STRING</ID_ENT>

      <AMBIENTE>STRING</AMBIENTE>

      <VERSAO>STRING</VERSAO>

      <ULTNSU>STRING</ULTNSU>

      <MODELO>STRING</MODELO>

    </soap:Body>

     

    NomePaiTipoTam.Ocor.Observações
    CONFIGURARPARAMETROSRESULT---1-1Tag raiz.
    AMBIENTECONFIGURARPARAMETROSRESULTA11-1

    Ambiente utilizado na sincronização de documentos.

     Os valores possíveis são:

    1 – Produção;

    2 – Homologação.
    ID_ENTCONFIGURARPARAMETROSRESULTA61-1ID da entidade a ser utilizada.
    VERSAOCONFIGURARPARAMETROSRESULTA41-1Versão utilizada na sincronização de documentos.
    ULTNSUCONFIGURARPARAMETROSRESULTA150-1Ultimo NSU da sincronização de documentos
    MODELOCONFIGURARPARAMETROSRESULTA20-1

    Modelo de documento configurado utilizado na sincronização do documento

    58 – MDF-e.

    55 - NF-e.

     

    Soap Fault

    FaultObservações
    Invalid TokenO parâmetro USERTOKEN foi passado incorretamente.
    001Código de entidade inválido.
    002Código de entidade em branco.
    003Falha no processamento do método.

     

    • Método SINCRONIZARDOCUMENTOS

    Sincroniza junto com a Sefaz a base de dados do TSSS através de documentos que tenham como destinatário a entidade solicitada.

     

    Os parâmetros de entrada do método são:

     

    <soap:Body>
     <USERTOKEN>STRING</USERTOKEN>
     <ID_ENT>STRING</ID_ENT>
     <INDNFE>STRING</INDNFE>
     <INDEMI>STRING</INDEMI>
     <MODELO>STRING</MODELO> 
    </soap:Body>

     

    Nome
    Pai
    Tipo
    Tam.
    Ocor.
    Observações
    SINCRONIZARDOCUMENTOS---1-1Tag raiz.
    USERTOKENSINCRONIZARDOCUMENTOSA51-1Deverá ser preenchido com o valor “TOTVS”.
    ID_ENTSINCRONIZARDOCUMENTOSA61-1ID da entidade a ser utilizada.
    INDNFESINCRONIZARDOCUMENTOSA10-1

    Indicação para quais NF-e sincronizar.

    Os valores possíveis são:

    0 – Todas as NF-e;

    1 – Somente as NF-e que ainda não tiveram manifestação do destinatário;

    2 – Idem opção 1 incluindo também as NF-e que não tiveram Ciência da Operação declarada.

    Caso não seja informado, será utilizado o valor “0” como padrão.

    Para modelo 58, parâmetro será desconsiderado.
    INDEMISINCRONIZARDOCUMENTOSA10-1

    Indicação para quais emitentes buscar as NF-e para sincronizar.

    Os valores possíveis são:

    0 – Todos os emitentes;

    1 – Apenas emitentes aonde a raiz do CNPJ seja diferente do destinatário (evitando transferências entre filiais).

    Caso não seja informado, será utilizado o valor “0” como padrão.

    Para modelo 58, parâmetro será desconsiderado
    MODELOSINCRONIZARDOCUMENTOSA20-1

    Modelo de documento a ser sincronizado.

    58 – MDF-e.

    55- NF-e.

    Caso não seja informado, será utilizado o valor “55” como padrão, realizando assim a sincronização da Manifestação do Destinatário – MD-e.

     

    Os parâmetros de saída do método são:

     

    <SINCRONIZARDOCUMENTOSRESULT>

     <AMBIENTE>STRING</AMBIENTE>

     <DOCUMENTOS>

          <SINCDOCUMENTOSINFO>

                <CANCNSU>STRING</CANCNSU>

                <CHAVE>STRING</CHAVE>

                </SITCONF>STRING</SITCONF>

           </SINCDOCUMENTOSINFO>

          <SINCDOCUMENTOSINFO>

                <CANCNSU>STRING</CANCNSU>

                <CHAVE>STRING</CHAVE>

                </SITCONF>STRING</SITCONF>

           </SINCDOCUMENTOSINFO>

      </DOCUMENTOS>

     <IDENT>STRING</IDENT>

     <INDCONT>STRING</INDCONT>

    </SINCRONIZARDOCUMENTOSRESULT>

     

    Nome
    Pai
    Tipo
    Tam.
    Ocor.
    Observações
    SINCRONIZARDOCUMENTOSRESULT---1-1Tag raiz
    AMBIENTESINCRONIZARDOCUMENTOSRESULTA21-1

    Identificação do Ambiente consultado:

    1 - Produção;

    2 - Homologação
    DOCUMENTOSSINCRONIZARDOCUMENTOSRESULT--0-1Tag raiz para os documentos sincronizados.
    SINCDOCUMENTOSINFODOCUMENTOS--0-NTag raíz para as informações de um documento sincronizado
    CANCNSUSINCDOCUMENTOSINFOA150-1NSU de cancelamento.
    CHAVESINCDOCUMENTOSINFOA441-1Chave de acesso do documento sincronizado.
    SITCONFSINCDOCUMENTOSINFOA11-1

    Código da situação da confirmação da manifestação do documento.

    Os valores possíveis são:

    0 – Sem manifestação do destinatário;

    1 – Confirmada operação;

    2 – Desconhecida;

     3 – Operação não realizada;

    4 – Ciência.

    Para modelo 58, parâmetro sempre retornará 0
    CODEVENTOSINCDOCUMENTOSINFOA61-1Tipo do Evento.
    IDENTSINCRONIZARDOCUMENTOSRESULTA61-1ID da Entidade utilizada.
    INDCONTSINCRONIZARDOCUMENTOSRESULTA1-40-1

    Indicador de continuação:

    0 - SEFAZ não possui mais documentos para o CNPJ informado;

    1 - SEFAZ possui mais documentos para o CNPJ informado, ou ainda não avaliou a totalidade da sua base de dados.

     

    Soap Fault

    FaultObservações
    Invalid TokenO parâmetro USERTOKEN foi passado incorretamente.
    001Código de entidade inválido.
    002Código de entidade em branco.
    003Falha no processamento do método.

     

    • Método RETORNARDOCUMENTO

    Retorna todas as informações sobre um documento sincronizado anteriormente.

     

    Os parâmetros de entrada do método são:

     

    <soap:Body>

     <USERTOKEN>STRING</USERTOKEN>

     <IDENT>STRING</IDENT>

     <AMBIENTE>STRING</AMBIENTE>

     <CHAVE>STRING</CHAVE>

    </soap:Body>

     

    NomePaiTipoTam.Ocor.Observações
    RETORNARDOCUMENTO---1-1Tag raiz.
    USERTOKENRETORNARDOCUMENTOA51-1Deverá ser preenchido com o valor “TOTVS”.
    ID_ENTRETORNARDOCUMENTOA61-1ID da entidade a ser utilizada.
    AMBIENTERETORNARDOCUMENTOA10-1

    Ambiente a ser pesquisado.

    Os valores possíveis são:

    1 – Produção;

    2 – Homologação.
    CHAVERETORNARDOCUMENTOA441-1Chave do Documento a ser retornado.

     

    Os parâmetros de saída do método são:

     

    <soap:Body>

     <ID_ENT>STRING</ID_ENT>

     <AMBIENTE>STRING</AMBIENTE>

      <DOCUMENTO>

          <CANCELAMENTO>

             <CANCNSU>STRING</CANCNSU>

             <CANCXMLRET>BASE64BINARY</CANCXMLRET>

             <DATAAUTORIZACAO>STRING</DATAAUTORIZACAO>

             <DATAEMISSAO>STRING</DATAEMISSAO>

          </CANCELAMENTO>

          <CCE>

             <CCENSU>STRING</CCENSU>

             <CCEXMLRET>BASE64BINARY</CCEXMLRET>

             <CORRECAO>STRING</CORRECAO>

             <DATAAUTORIZACAO>STRING</DATAAUTORIZACAO>

             <DATAEMISSAO>STRING</DATAEMISSAO>

             <HORAEMISSAO>STRING</HORAEMISSAO>

             <TZD>STRING</TZD>

          </CCE>

          <CHAVE>STRING</CHAVE>

          <CONDUTOR>

              <CONDNSU>STRING</CONDNSU>

              <CONDXMLRET>BASE64BINARY</CONDXMLRET>

              <CPF>STRING</CPF>

              <DTHRAUTORIZACAO>STRING</DTHRAUTORIZACAO>

              <DTHREMISSAO>STRING</DTHREMISSAO>

              <NOME>STRING</NOME>

          </CONDUTOR>

           <DATAAUTORIZACAO>STRING</DATAAUTORIZACAO>

           <DATAEMISSAO>STRING</DATAEMISSAO>

           <EMITENTE>

               <CNPJ>STRING</CNPJ>

               <CPF>STRING</CPF>

               <IE>STRING</IE>

               <NOME>STRING</NOME>

            </EMITENTE>

            <ENCERRAMENTO>

               <ENCNSU>STRING</ENCNSU>

               <ENCXMLRET>BASE64BINARY</ENCXMLRET>

               <CODIGOIBGE>STRING</CODIGOIBGE>

               <DTHRAUTORIZACAO>STRING</DTHRAUTORIZACAO>

               <DTHREMISSAO>STRING</DTHREMISSAO>

               <ENCDTENC>STRING</ENCDTENC>

            </ENCERRAMENTO>

            <NSU>STRING</NSU>

            <RESPOSTA>

                <DESCRICAO>STRING</DESCRICAO>

                <STATUS>STRING</STATUS>

            </RESPOSTA>

            <SITUACAO>STRING</SITUACAO>

            <SITUACAOCONFIRMACAO>STRING</SITUACAOCONFIRMACAO>

            <TIPOOPERACAO>STRING</TIPOOPERACAO>

            <VALORTOTAL>FLOAT</VALORTOTAL>

            <XMLSEFAZ>BASE64BINARY</XMLSEFAZ>

      </DOCUMENTO>

    </soap:Body>

     

    NomePaiTipoTam.Ocor.Observações
    RETORNARDOCUMENTORESULT---1-1Tag raiz.
    USERTOKENRETORNARDOCUMENTORESULTA51-1Deverá ser preenchido com o valor “TOTVS”.
    ID_ENTRETORNARDOCUMENTORESULTA61-1ID da entidade a ser utilizada.
    AMBIENTERETORNARDOCUMENTORESULTA10-1

    Ambiente a ser pesquisado.

    Os valores possíveis são:

    1 – Produção;

    2 – Homologação.
    DOCUMENTORETORNARDOCUMENTORESULT--0-1Tag raiz para as informações do documento pesquisado.
    CANCELAMENTODOCUMENTO--0-1Tag raiz para as informações de cancelamento do documento.
    CANCNSUCANCELAMENTOA150-1NSU do cancelamento.
    CANCXMLRETCANCELAMENTOBASE64BINARY-0-1XML de retorno da SEFAZ apenas para o cancelamento.
    DATAUTORIZACAOCANCELAMENTOA100-1

    Data de autorização do cancelamento.

    Formato – AAAA-MM-DD

    DATAEMISSAOCANCELAMENTOA100-1

    Data de emissão do cancelamento.

    Formato – AAAA-MM-DD

    CCEDOCUMENTO--0-1Tag raiz para as informações da carta de correção eletrônica do documento.
    CCENSUCCEA150-1NSU da carta de correção eletrônica.
    CCEXMLRETCCEBASE64BINARY-0-1XML de retorno da SEFAZ apenas para a CC-e.
    CORRECAOCCEA10000-1Correção da CC-e.
    DATAAUTORIZACAOCCEA100-1

    Data da autorização da CC-e.

    Formato – AAAA-MM-DD

    DATAEMISSAOCCEA100-1

    Data de emissão da CC-e.

    Formato – AAAA-MM-DD

    HORAEMISSAOCCEA80-1

    Horário de emissão da CC-e.

    Formato – HH:MM:SS

    TZDCCEA60-1TZD do horário de emissão da CC-e.
    CHAVEDOCUMENTOA440-1Chave do documento.
    CONDUTORDOCUMENTO--0-1

    Tag raiz para as informações do último evento de inclusão de condutor (MDF-e).

    IMPORTANTE:

    As informações serão retornadas com base no último evento de inclusão de condutor autorizado.
    CONDNSUCONDUTORA150-1NSU do evento de inclusão de condutor.
    CONDXMLRETCONDUTORBASE64BINARY-0-1XML de retorno da SEFAZ apenas para a Inclusão de Condutor
    CPFCONDUTORA110-1CPF do condutor do veículo.
    DTHRAUTORIZACAOCONDUTORA190-1

    Data e hora da autorização do evento de Inclusão de Condutor.

     Formato – AAAA-MM-DDTHH:MM:SS

    DTHREMISSAOCONDUTORA190-1

    Data e hora da emissão do evento de Inclusão de Condutor.

     Formato – AAAA-MM-DDTHH:MM:SS

    NOMECONDUTORA600-1Nome do condutor do veículo.
    DATAAUTORIZACAODOCUMENTOA100-1

    Data de autorização do documento.

    Formato – AAAA-MM-DD

    DATAEMISSAODOCUMENTOA100-1

    Data de emissão do documento.

    Formato – AAAA-MM-DD

    EMITENTEDOCUMENTO--0-1Tag raiz para as informações do emitente do documento.
    CNPJEMITENTEA140-1CNPJ do emitente do documento.
    CPFEMITENTEA110-1CPF do emitente do documento.
    IEEMITENTEA140-1Inscrição Estadual do emitente do documento.
    NOMEEMITENTEA600-1Nome / Razão Social do emitente do documento.
    ENCERRAMENTODOCUMENTO--0-1Tag raiz para as informações do evento de encerramento (MDF-e).
    ENCNSUENCERRAMENTOA150-1NSU do evento de encerramento.
    ENCXMLRETENCERRAMENTOBASE64BINARY-0-1XML de retorno da SEFAZ apenas para o encerramento.
    CODIGOIBGEENCERRAMENTOA70-1Código do município onde ocorreu o encerramento.
    DTHRAUTORIZACAOENCERRAMENTOA190-1

    Data e hora da autorização do evento de encerramento.

    Formato – AAAA-MM-DDTHH:MM:SS

    DTHREMISSAOENCERRAMENTOA190-1

    Data e hora da emissão do evento de encerramento.

     Formato – AAAA-MM-DDTHH:MM:SS

    ENCDTENCENCERRAMENTOA100-1

    Data em que o MDF-e foi encerrado.

     Formato – AAAA-MM-DD

    NSUDOCUMENTOA150-1NSU do documento.
    RESPOSTADOCUMENTO--0-1Tag raiz para as informações de resposta da SEFAZ no momento da sincronização do documento.
    DESCRICAORESPOSTAA2550-1Descrição do status de resposta da SEFAZ.
    STATUSRESPOSTAA30-1Código de status de resposta da SEFAZ.
    SITUACAODOCUMENTOA10-1

    Código de situação do documento.

    Os valores possíveis são:

    1 – Uso autorizado no momento da consulta;

     2 – Uso denegado (Para NF-e);

     3 – NF-e/MDF-e cancelada;

    4- MDF-e Encerrado.

    SITUACAOCONFIRMACAODOCUMENTOA10-1

    Código da situação da confirmação da manifestação do destinatário.

    Os valores possíveis são:

     0 – Sem manifestação do destinatário;

    1 – Confirmada operação;

    2 – Desconhecida;

    3 – Operação não realizada;

    4 – Ciência.

     

    Para modelo 58, parâmetro sempre retornará 0.
    TIPOOPERACAODOCUMENTOA10-1

    Tipo da operação do documento.

     Os valores possíveis são:

    0 – Entrada;

    1 – Saída.

    Para modelo 58, parâmetro sempre retornará 1.

    VALORTOTALDOCUMENTON15,20-1Valor total do documento.
    XMLSEFAZDOCUMENTOBASE64BINARY-0-1XML de retorno da SEFAZ apenas para o documento.

    Dicionário de Dados


    TABELA SPED156 - MANIFESTAÇÃO DO DESTINATÁRIO.

      

    Campo

    ENCDTHREMI

    Tipo

    C

    Tamanho

    25

    Descrição

    Data e hora de emissão do evento de encerramento.

    Campo

    ENCDTHRAUT

    Tipo

    C

    Tamanho

    25

    Descrição

    Data e hora de autorização do evento de encerramento.

    Campo

    ENCNSU

    Tipo

    C

    Tamanho

    15

    Descrição

    NSU do encerramento.

    Campo

    ENCXMLRET

    Tipo

    M

    Tamanho

    10

    Descrição

    XML do encerramento.

    Campo

    ENCCODMUN

    Tipo

    C

    Tamanho

    7

    Descrição

    Código do município do IBGE onde ocorreu o encerramento.

    Campo

    ENCDTENC

    Tipo

    C

    Tamanho

    10

    Descrição

    Data em que o MDF-e foi encerrado.

    Campo

    CONDTHREMI

    Tipo

    C

    Tamanho

    25

    Descrição

    Data e hora de emissão do evento de inclusão de condutor.

    Campo

    CONDTHRAUT

    Tipo

    C

    Tamanho

    25

    Descrição

    Data e hora de autorização do evento de inclusão de condutor.

    Campo

    CONDNSU

    Tipo

    C

    Tamanho

    15

    Descrição

    NSU da inclusão de condutor.

    Campo

    CONDCPF

    Tipo

    C

    Tamanho

    11

    Descrição

    CPF do condutor do veículo.

    Campo

    CONDNOME

    Tipo

    C

    Tamanho

    60

    Descrição

    Nome do condutor do veículo.

    Campo

    CONDXMLRET

    Tipo

    M

    Tamanho

    10

    Descrição

    XML da inclusão de condutor.

    Campo

    MODELO

    Tipo

    C

    Tamanho

    2

    Descrição

    Modelo do documento sincronizado.

     Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.