MODO
A rota modo será utilizada para verificarmos as configurações de um CNPJ ou realizar a alteração de alguma das informações do mesmo.
Podemos executar comandos para consultar as configurações, informações sobre os certificados e alterar propriedades de configuração.
A maioria dos comandos e propriedades também se aplicam aos clientes que utilizam o Manager SaaS.
Os comandos que podem ser realizados são:
Campo | Valor | Descrição | Exemplo |
GetConfig | 1 | Retorna o arquivo de configurações do CNPJ | GetConfig=1 ou GetConfig |
GetVencimentoCertificado |
1
|
Retorna a data e hora do vencimento do certificado configurado no CNPJ | GetVencimentoCertificado=1 ou GetVencimentoCertificado |
GetValidadeInicialCertificado |
1 |
Retorna a data e hora da validade inicial do certificado configurado no CNPJ | GetValidadeInicialCertificado=1 ou GetValidadeInicialCertificado |
GetCertificados | 1 |
Retorna o nome de todos os certificados instalados na máquina onde o Manager EDoc está sendo executado. Atenção!: Somente para Manager EDoc |
GetCertificados=1 ou GetCertificados |
Os campos disponíveis para configuração estão divididos em seções para melhor organização (MANAGEREDOC, MDFE, DAMDFE, MAIL), seguem abaixo:
MANAGEREDOC
Abaixo seguem as propriedades da seção MANAGEREDOC que podem ser alteradas:
Campo | Descrição | Valor |
FieldDelimiter | Delimitador de campos | Por padrão | |
LineDelimiter | Delimitador de linha | Por padrão delimitador de quebra de linha do Windows ("Enter"). |
AutoEmail | Envio de e-mail automático ao final da autorização da MDF-e. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
AutoImprimir | Impressão do Damdfe ao final da autorização da MDF-e. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
AutoXmlDestinatario | Geração do XML da MDF-e. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
RemoveCaracterXml | Remove caracteres especiais do XML da MDF-e antes da assinatura. | 1 - Habilita ou 0 - Desabilita |
Modo | Modo de envio da MDF-e. |
NORMAL, CONTINGENCIA |
NumeroAutomatico | Numeração automática da MDF-e. |
Por padrão 1 1 - Habilita ou 0 - Desabilita |
ServerDelay | Tempo de espera antes de executar a comunicação com o servidor da SEFAZ. | Por padrão 5000 (em milissegundos) |
TimeOut |
Tempo máximo de espera da resposta de uma requisição feita a SEFAZ. Atenção! Para alterar a propriedade TimeOut, é obrigatório enviar na requisição o parâmetro secao=MANAGEREDOC antes do parâmetro TimeOut. Exemplo: http://localhost:8081/ManagerAPIWeb/mdfe/modo?grupo=edoc&cnpj=29062609000177& |
Por padrão 180000 (em milissegundos)
|
LoteAutomatico | Envio de MDF-e em lote automático. |
Por padrão 1 1 - Habilita ou 0 - Desabilita |
LoteAutomaticoTimer | Tempo máximo de espera para montagem do lote. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
LoteAutomaticoQtdeNotas | Quantidade de notas para montagem do lote. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
QtdeTentativas | Quantidade máxima de tentativas do envio da MDF-e. | Por padrão 10 |
ToleranciaStandBy | Tolerância do número de requisições para o WebService que resultaram em falha de alguma natureza. | Por padrão 10 |
TempoStandBy | Tempo em que o Manager SaaS permanecerá em StandBy. |
Por padrão 300 (em segundos) Valor mínimo 60 |
NumeracaoDescartada | Reutilização da numeração das notas descartadas. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
DelayConsulta | Tempo máximo de espera antes de executar a consulta de recibo do envio da MDF-e. | Por padrão 0 (em milissegundos) |
TimerResolvePendencias | Tempo em segundos para inicio do resolve automático. | Por padrão 0 |
EnviarEmailEvento | Envia o e-mail dos eventos vinculados a MDF-e. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
UsaLineDelimiter | Habilita ou desabilita o uso de delimitador de linha. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
UtilizarPluginA3 |
Permite o uso de certificado A3. Atenção!: Necessário pré-requisitos para iniciar utilização. Veja com nossa consultória técnica. |
Por padrão 0 1 - Habilita ou 0 - Desabilita
|
serie |
Série de numeração cadastrada no CNPJ do Emitente. |
Valor da série (Inteiro). |
numeroinicial |
Número inicial da série. |
Valor do número inicial (Inteiro).
Atenção! Para alterar o número inicial de uma determinada série, deve ser utilizada na rota os campos serie e numeroinicial em conjunto. |
DiretorioDamdfe |
Diretório onde está localizado o layout de impressão da MDF-e. Observação: O caminho depende da versão do esquema configurada. |
Por padrão na pasta de instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerMdfe\Files\Templates\vm60\damdfe |
ImpressoraPadrao | Indica a impressora padrão para a impressão do DAMDFE da MDF-e. | Por padrão a impressora definida como padrão do windows. |
ModoImpressao | Indica a forma de impressão do DAMDFE da MDF-e. |
Por padrão "PDF". Impressora: Imprime na impressora configurada. PDF: Gera o DAMDFE em arquivo .pdf. Ambos: Imprime na impressora configurada e gera o arquivo .pdf. |
ValidarEsquemaAntesEnvio | Propriedade que permite ativar ou desativar a validação de esquema antes do envio |
1 - Habilita ou 0 - Desabilita |
FusoHorario | Indica o fuso horário que será utilizado no envio de MDF-e. | Por padrão -03:00 |
RespTecCNPJ | propriedade que permite informar o CNPJ do responsável técnico | |
RespTecNome | propriedade que permite informar o NOME do responsável técnico | |
RespTecEmail | propriedade que permite informar o EMAIL do responsável técnico | |
RespTecFone | propriedade que permite informar o Telefone do responsável técnico | |
IdCSRT | Identificador do Responsável Técnico |
Exemplo: 01 |
CSRT | Código do Responsável Técnico |
Exemplo: G8063VRTNDMO886SFNK5LDUDEI24XJ22YIPO |
MDFE
Abaixo seguem as propriedades da seção MDFE que podem ser alteradas:
Campo | Descrição | Valor |
UF |
Unidade Federativa (Estado) do Emitente. |
|
NomeCertificado | Nome do Emitente para qual foi emitido o certificado | |
ArquivoServidoresHom | Configurar onde encontra-se o arquivo mdfeServidoresHom.ini que contém os endereços dos webservices de Homologação. | mdfeServidoresHom.ini |
ArquivoServidoresProd | Configurar onde encontra-se o arquivo mdfeServidoresProd.ini que contém os endereços dos webservices de Produção. | mdfeServidoresProd.ini |
DiretorioLog | Diretório onde serão criados os arquivos de log | "Plugins\ManagerMDFE\Files\Log" |
ModoOperacao | Modo de envio da MDF-e | NORMAL, CONTINGENCIA |
Ambiente | Ambiente onde será realizado o envio |
1 - Produção |
VersaoManual | Versão dos schemas da Sefaz | 3.00, 3.00a ou 3.00b |
MaxSizeLoteEnvio | Limite para o tamanho de arquivo que será enviado. | 500 |
DiretorioXmlDestinatario | Diretório onde os XMLs autorizados serão gerados | "Plugins\ManagerMDFe\Files\XmlDestinatario\" |
DiretorioEsquemas | Diretório dos Esquemas XML | "Plugins\ManagerMDFe\Files\Esquemas" |
DiretorioTemplates | Diretório dos Templates que serão utilizados na geração dos arquivos XML | "Plugins\ManagerMDFe\Files\Templates" |
Proxy | Propriedade que permite colocar o endereço do Proxy para conectar a internet. | IP do proxy |
UsuarioProxy | Nome do usuário do proxy | |
SenhaProxy | Senha do usuário do proxy | |
ValidarAntesDoEnvio | Propriedade que permite ativar ou desativar a validação de esquema antes do envio |
1 - Habilita ou 0 - Desabilita |
TimeOut |
Tempo de espera de resposta do WebService (valor em milisegundos). Atenção! Para alterar a propriedade TimeOut, é obrigatório enviar na requisição o parâmetro secao=MDFE antes do parâmetro TimeOut. Exemplo: http://localhost:8081/ManagerAPIWeb/mdfe/modo?grupo=edoc&cnpj=29062609000177& |
60000 |
HttpLibs |
Indica se o componente irá utilizar os recursos do Windows ou recursos internos para efetuar a comunicação com a Sefaz |
wininet: a comunicação é feita com recursos do Windows sbb: a comunicação é feita com recursos do próprio componente Padrão: wininet,sbb |
DAMDFE
Abaixo seguem as propriedades do seção DAMDFE que podem ser alteradas:
Campo | Descrição | Valor |
FraseContingencia | Indica a frase que será impressa no DAMDFE quando a MDF-e for emitida em modo de Contingência. | Exemplo: "DAMDFE em contingência - Impresso em decorrência de problemas técnicos." |
FraseHomologacao | Indica a frase que será impressa no DAMDFE quando a MDF-e for emitida em Ambiente de Homologação. | Exemplo: "SEM VALOR FISCAL" |
ModeloRetrato | Aponta para o diretório onde está o arquivo RTM com Layout de impressão em Retrato. | Exemplo: "Templates\damdfe\retrato.rtm" |
ModeloPaisagem | Aponta para o diretório onde está o arquivo RTM com Layout de impressão em Paisagem. | Exemplo: "Templates\damdfe\paisagem.rtm" |
ImprimirComposicaoCarga | Desabilita a impressão composição de carga quando o envio não for em contingência | 1 - Habilita ou 0 - Desabilita |
LogotipoEmitente | Nome do arquivo contendo o caminho completo que deve ser passado para a impressão do logo no DAMDFE | C:\Logo\tecnospeed.jpg |
QtdeCopias | Quantidade de cópias an impressão | 2 |
ImprimirUFsPercurso | Impressão das UFs de percurso | 1 - Habilita ou 0 - Desabilita |
Abaixo seguem as propriedades do envio de e-mail que pode ser alteradas:
Campo | Descrição | Valor |
Servidor | Endereço do servidor de envio de email (SMTP/SMTPS). | smtp.gmail.com |
EmailRemetente | Email para o qual será enviada a MDF-e | teste@tecnospeed.com.br |
Assunto | Assunto do e-mail | Assunto exemplo |
Mensagem | Corpo da mensagem que será enviada por e-mail. | Olá, em anexo está sua MDF-e e seu respectivo DAMDFE. |
AssuntoCancelamento | Assunto do e-mail do evento de cancelamento | Olá, em anexo está o XML do cancelamento da sua MDF-e. |
MensagemCancelamento | Corpo da mensagem do evento de cancelamento que será enviada por e-mail. | Olá, em anexo XML do evento de cancelamento da sua MDF-e. |
Usuario | Usuário de autenticação do servidor de e-mail | usuario@exemplo.com |
Senha | Senha do E-mail. | 123mudar |
TimeOut |
Tempo de espera de envio de E-mail (Milissegundos). Atenção! Para alterar a propriedade TimeOut, é obrigatório enviar na requisição o parâmetro secao=MAIL antes do parâmetro TimeOut. Exemplo: http://localhost:8081/ManagerAPIWeb/mdfe/modo?grupo=edoc&cnpj=29062609000177& |
60000 |
EmailDestinatario | Email para o qual será enviada a MDF-e. | destinatario@exemplo.com |
CCo | Email para o qual a mensagem será enviada em cópia oculta. | cco@exemplo.com |
CC | Email para o qual a mensagem será enviada em cópia. | cc@exemplo.com |
Autenticacao | Propriedade booleana que deve ser ativada quando o servidor de e-mail exigir autenticação. | True ou False |
Porta | Porta de conexão com o servidor de SMTP/SMTPS necessária para envio de e-mail. | 587 |
ConteudoHtml | Define o formato do texto do corpo do e-mail. |
0 - Indica que o corpo da mensagem não contém um conteúdo HTML 1 - Indica que o corpo da mensagem contém um conteúdo HTML |
QtdeTentativasEmail | Quantidade máxima de tentativas de envio do e-mail em caso de falha. | 3 |
TipoTLS | Tipo de protocolo TLS utilizado no envio de e-mail. |
Por padrão REQUIRETLS Valores possíveis: REQUIRETLS IMPLICITTLS EXPLICITTLS |
AnexarDamdfePDF | Anexar o PDF da DAMDFe no Email |
1 - Habilita ou 0 - Desabilita |
UseSecureBlackBox |
Envio de e-mail com SecureBlackBox
|
1 - Habilita ou 0 - Desabilita Atenção! Por padrão Desabilitado, habilitar somente quando o cliente tiver problemas de autenticação de email. |
GET
http://localhost:8081/ManagerAPIWeb/mdfe/modo
Headers
Nome | Descrição | Exemplo |
Authorization | Este usuário e senha são os seus dados para logar como administrador em um grupo do EDoc | Basic dGVzdGU6MTIzbXVkYXI= |
Querystring
Nome | Descrição |
Grupo | Nome do grupo |
CNPJ | CNPJ do emitente do MDF-e cadastrado no Manager EDoc, apenas números |
Secao |
MDFE ou MANAGEREDOC ou DAMDFE ou MAIL Opcional - Informar a seção caso a propriedade exista com mesmo nome em seções diferentes |
Comando ou Campo |
Valor do comando desejado, exemplo: GetVencimentoCertificado=1 |
Retorno
Será de acordo com o comando ou campo informado.
Exemplo de retorno com os campos (ValidarEsquema=1) :
OK, Operação realizada com sucesso
Exemplo de retorno (GetVencimentoCertificado=1) :
03/05/2022 13:34:00
Comentários
0 comentário
Por favor, entre para comentar.