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 |
| 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, NFCE, DANFCE, MAIL e NOTASEGURA), 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"). Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| AutoEmail | Envio de e-mail automático ao final da autorização da NFC-e. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| AutoImprimir | Impressão do DANFCE ao final da autorização da NFC-e. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| AutoXmlDestinatario | Geração do XML da NFC-e. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| RemoveCaracterXml | Remove caracteres especiais do XML da NFC-e antes da assinatura. | 1 - Habilita ou 0 - Desabilita |
| Modo | Modo de envio da NFC-e. |
NORMAL, CONTINGENCIA OFFLINE |
| NumeroAutomatico | Numeração automática da NFC-e. |
Por padrão 1 1 - Habilita ou 0 - Desabilita |
| LoteAutomaticoQtdeNotas | Quantidade de cópias do DANFCE a serem impressas. | Por padrão 0 |
| 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. |
Por padrão 60000 (em milissegundos) Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| QtdeTentativas | Quantidade máxima de tentativas do envio da NFC-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 EDoc 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 |
| TimerResolvePendencias | Tempo em segundos para inicio do resolve automático. | Por padrão 0 |
| EnviarNotaAutomaticamente | Envia automaticamente a NFC-e para o Plug Storage logo após a autorização. |
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 |
| Serie |
Série de numeração cadastrada no CNPJ do Emitente. |
Valor da série (Inteiro). |
| NumeroInicial ou NumInicialNF |
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. |
| DiretorioDanfce |
Diretório onde está localizado o layout de impressão do DANFCE. Observação: O caminho depende da versão do manual configurado. |
Por padrão na pasta de instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerNFCe\Files\Templates\vm60\Danfce |
| ImpressoraPadrao | Indica a impressora padrão para a impressão do DANFCE da NFC-e. | Por padrão a impressora definida como padrão do windows. |
| ModoImpressao | Indica a forma de impressão do DANFCE da NFC-e. |
Por padrão "PDF". Impressora: Imprime na impressora configurada. PDF: Gera o Danfce em arquivo .pdf. Ambos: Imprime na impressora configurada e gera o arquivo .pdf. |
| ControleStandBy | Indica a forma como o Manager EDoc vai controlar a entrada em StandBy. | Por padrão "CNPJ". (Atualmente só existe essa forma de controle de standby). |
| LoteAutomatico | Envio de NFC-e em lote automático. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| LoteAutomaticoTimer | Tempo máximo de espera para montagem do lote. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| RespTecCNPJ | propriedade que permite informar o CNPJ do responsável técnico. |
apenas números |
| RespTecNome | propriedade que permite informar o NOME do responsável técnico. |
|
| RespTecEmail |
propriedade que permite informar o e-mail do responsável técnico. |
teste@tecnospeed.com.br |
| RespTecFone |
propriedade que permite informar o Telefone do responsável técnico. |
|
| RespTecAtivo | Ativa ou Desativa o responsável técnico. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
|
XmlDicionario |
Indica o caminho para o arquivo NFCeDataSets.xml responsável pela conversão dos campos da NFC-e. Observação: O caminho depende da versão do esquema configurada. |
Por padrão na pasta da instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerNFCe\Files\Templates\vm60\Conversor |
|
VersaoEsquema |
Indica a Versão do Esquema utilizada na conversão das notas para Envio. |
pl_006n,pl_006p, pl_006q, pl_006r, pl_007a, pl_008a, pl_008b, |
|
VersaoManual |
Versão dos schemas da Sefaz. |
5.0 ou 5.0a ou 5.0b ou 6.0 |
|
LogotipoEmitente |
Propriedade onde permite-se configurar o Logo do Emitente no DANFCE. |
Por padrão vazio. Exemplos: C:\logo.png ou C:\logo.jpeg. |
|
EmailCC |
Permite o envio de uma cópia do e-mail. |
contador@email.com |
|
UtilizaEnvioSincrono |
Tipo do método de envio da NFC-e. |
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 |
|
FusoHorario |
Indica o fuso horário que será utilizado no envio da NFC-e. |
Por padrão -03:00 -02:00 ou -03:00 |
|
DelayConsulta |
Tempo máximo de espera antes de executar a consulta de recibo do envio da NFC-e. |
Por padrão 0 (em milissegundos) |
NFCE
Abaixo seguem as propriedades da seção NFCE que podem ser alteradas:
| Campo | Descrição | Valor |
| UF |
Unidade Federativa (Estado) do Emitente. |
|
| Repositorio | Define o tipo do certificado que será utilizado. | MEMORY_STORE, LOCAL_MACHINE_STORE, CURRENT_USER_STORE, ACTIVE_DIRECTORY_USER_STORE ou SMART_CARD_USER_STORE |
| NomeCertificado | Nome do Emitente para qual foi emitido o certificado. | |
| PinCode | Senha do Certificado A3. | Ex:Senha123 |
| ArquivoServidoresHom | Configurar onde encontra-se o arquivo nfceServidoresHom.ini que contém os endereços dos webservices de Homologação. | nfceServidoresHom.ini |
| ArquivoServidoresProd | Configurar onde encontra-se o arquivo nfceServidoresProd.ini que contém os endereços dos webservices de Produção. | nfceServidoresProd.ini |
| DiretorioLog | Diretório onde serão criados os arquivos de log. | "Plugins\ManagerNFCe\Files\Log" |
| Ambiente | Ambiente onde será realizado o envio. |
1 - Produção |
| VersaoManual | Versão dos schemas da Sefaz. | 5.0b ou 6.0 |
| MaxSizeLoteEnvio | Limite para o tamanho de arquivo que será enviado. | 500 |
| DiretorioXmlDestinatario | Diretório onde os XMLs autorizados serão gerados. | "Plugins\ManagerNFCe\Files\XmlDestinatario" |
| DiretorioEsquemas | Diretório dos Esquemas XML. | "Plugins\ManagerNFCe\Files\Esquemas" |
| DiretorioTemplates | Diretório dos Templates que serão utilizados na geração dos arquivos XML. | "Plugins\ManagerNFCe\Files\Templates" |
| AnexarDanfcePDF | Ao enviar o XML da NFC-e para o Destinatário. |
Por padrão 1 1 - Habilita ou 0 - Desabilita |
| Proxy | Propriedade que permite colocar o endereço do Proxy para conectar a internet. | IP do proxy |
| Usuario |
Nome do usuário do proxy. |
Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| Senha |
Senha do usuário do proxy. |
Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| ValidarEsquema ou ValidarAntesDoEnvio | Propriedade que permite ativar ou desativar a validação de esquema antes do envio. |
1 - Habilita ou 0 - Desabilita |
| ConexaoSegura | Para quando o servidor utilizar conexão segura onde é exigido o certificado digital. |
|
| TimeOut |
Tempo de espera de resposta do WebService (valor em milisegundos). |
60000 Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| CSRT |
Código do Responsável Técnico. |
Código do Responsável Técnico |
| IdCSRT |
Identificador do Responsável Técnico. |
Identificador do Responsável Técnico |
| ModeloQRCode |
Modelo do QRCode utilizado. |
100 ou 200 |
|
CaracteresRemoverAcentos |
Remove caracteres especiais ao assinar a NFC-e. |
Padrão: |
| 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 |
DANFCE
Abaixo seguem as propriedades da seção DANFCE que podem ser alteradas:
| Campo | Descrição | Valor |
| FraseContingencia | Indica a frase que será impressa no DANFCE quando a NFC-e for emitida em modo de Contingência. | Exemplo: "Danfce em contingência - Impresso em decorrência de problemas técnicos." |
| FraseHomologacao | Indica a frase que será impressa no DANFCE quando a NFC-e for emitida em Ambiente de Homologação. | Exemplo: "SEM VALOR FISCAL" |
| LogotipoEmitente | Propriedade onde permite-se configurar o Logo do Emitente no DANFCE. |
Por padrão vazio. Exemplos: C:\logo.png ou C:\logo.jpeg. |
| ModeloDanfce | Aponta para o diretório onde está o arquivo RTM com Layout de impressão do DANFCE. |
Exemplo modelo padrão 80mm: "\Templates\Vm60\Danfce\retrato.rtm"
Exemplo modelo A4: "\Templates\vm60\Danfce\retratoa4.rtm" |
| ModeloDanfceMensagemEletronica | Aponta para o diretório onde está o arquivo RTM com Layout de impressão do DANFCE no modelo Mensagem Eletrônica. | Exemplo: "\Templates\Vm60\Danfce\retrato.rtm" |
| LineDelimiter | Delimitador de linha. |
Por padrão | (pipe), mas pode ser alterado. Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| QtdeCopias | Quantidade de cópias do DANFCE a serem impressas. | Por padrão 1 |
| ExibirDetalhamento | É utilizada para ativar a exibição do detalhamento de itens no DANFCE. |
Por padrão 1 1 - Habilita ou 0 - Desabilita |
| ExibirAcrescimoEDesconto | Permite exibir o valor de desconto e de acréscimo de cada item da nota. |
Exemplo: 0 - Não exibe, 1 - Exibe somente quando possuir valor. |
| InfCplMaxCol | Quantidade Máxima de Caracteres (Tag InfCpl) no espaço Dados Adicionais da primeira página do DANFCE. |
Por padrão 68 |
| InfCplMaxRow | Quantidade Máxima de Caracteres por Linha nas Observações (Tag InfCpl) utilizado no espaço Dados Adicionais da primeira página do DANFCE. |
Por padrão 7 |
Abaixo seguem as propriedades da seção MAIL que podem 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 NFC-e. | teste@tecnospeed.com.br |
| Assunto | Assunto do e-mail. | Você recebeu uma NFC-e. |
| Mensagem | Corpo da mensagem que será enviada por e-mail. | Os arquivos referentes a NFC-e foram anexados a este e-mail. |
| AssuntoCancelamento | Assunto do e-mail do evento de cancelamento. | Olá, em anexo está o XML do cancelamento da sua NFC-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 NFC-e. |
| Usuario |
Usuário de autenticação do servidor de e-mail. |
Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| Senha |
Senha do E-mail. |
123mudar Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| TimeOut |
Tempo de espera de envio de E-mail (Milissegundos). |
60000 Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| EmailDestinatario | Email para o qual será enviada a NFC-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. | 5 |
| TipoTLS | Tipo de protocolo TLS utilizado no envio de e-mail. |
Por padrão REQUIRETLS Valores possíveis: REQUIRETLS IMPLICITTLS EXPLICITTLS |
| AssuntoDestinatario | Assunto do e-mail destinatário |
|
| MensagemDestinatario | Corpo da mensagem que será enviada por e-mail. |
|
| UseSecureBlackBox |
Envio de email pelo UseSecureBlackBox
|
TRUE ou FALSE Atenção! Por padrão FALSE, habilitar para TRUE somente quando o cliente tiver problemas de autenticação de email. |
NOTASEGURA
Abaixo seguem as propriedades da seção NOTASEGURA que podem ser alteradas:
| Campo | Descrição | Valor |
| NotaSeguraServidor | Endereço do servidor PlugStorage | |
| NotaSeguraLogin | Login do usuário no PlugStorage. | |
| NotaSeguraSenha | Senha do usuário no PlugStorage. | |
| NotaSeguraToken | Token do usuário no PlugStorage |
GET
http://localhost:8081/ManagerAPIWeb/nfce/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 YWRtaW46MTIzbXVkYXI= |
Querystring
| Nome | Descrição |
| Grupo | Nome do grupo |
| CNPJ | CNPJ do emitente da NFC-e cadastrado no Manager EDoc, apenas números |
| Secao |
MANAGEREDOC ou NFCE ou DANFCE ou MAIL Opcional - Informar a seção principalmente ao alterar campos com mesmo nome em seções diferentes, por exemplo Usuario, Senha e Timeout. Para alterar campos únicos não é necessário informar a seção. |
| 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 (QRCodeLateral=1) :
OK, Operação realizada com sucesso
Exemplo de retorno (GetVencimentoCertificado=1) :
03/05/2019 13:34:00
Exemplo de retorno (GetConfig=1):
[NFCE]
UF=PR
NomeCertificado=CN=TECNOSPEED ...
CNPJ=08187168000160
TipoCertificado=CurrentUser
Repositorio=CURRENT_USER_STORE
Ambiente=2
VersaoManual=6.0
SalvarLogsEmDisco=0
VersaoEsquema=pl_008h
DiretorioTemplates=Plugins\ManagerNFCe\Files\Templates\
DiretorioEsquemas=Plugins\ManagerNFCe\Files\Esquemas\
DiretorioLog=Plugins\ManagerNFCe\Files\Logs\
ArquivoServidoresHom=Plugins\ManagerNFCe\Files\nfceServidoresHom.ini
fceServidoresHom.ini=true
ArquivoServidoresProd=Plugins\ManagerNFCe\Files\nfceServidoresProd.ini
fceServidoresProd.ini=true
ValidarEsquema=0
DiretorioXmlDestinatario=XMLDestinatario\NFCe\
Cidade=MARINGAPR
InscricaoMunicipal=111643
IgnoreInvalidCertificates=1
PinCode=
ConexaoSegura=1
Proxy=
Senha=
Usuario=
TimeOut=10000
CaracteresRemoverAcentos=áéíóúàèìòùâêîôûäëïöüãõñçÁÉÍÓÚÀÈÌÒÙÂÊÎÔÛÄËÏÖÜÃÕÑǺª
MaxSizeLoteEnvio=500
DiretorioLogErro=C:\Program Files (x86)\Manager eDoc - 3\LogErro\
DiretorioTemporario=C:\Program Files (x86)\Manager eDoc - 3\Temp\
AnexarDanfcePDF=1
DiretorioDownloads=P:\eDoc\Downloads\NFCe
IE=9044016688
HashCertificado=8b86eef6ac2282c7dd4c2dc0ab09af3e
CaminhoCertificado=...
SenhaCertificado=...
[MANAGEREDOC]
ServerDelay=3000
FieldDelimiter=,
LineDelimiter=|
TimeOut=10000
XmlDicionario=Plugins\ManagerNFCe\Files\Templates\Conversor\NFCeDataSets.xml
Modo=1
Titulo=Manager e-Doc NFCe
FSAutomatico=1
DiretorioDanfce=P:\eDoc\Imprime\NFCe\
ImpressoraPadrao=
ModoImpressao=PDF
AutoXmlDestinatario=1
NumeroAutomatico=1
FusoHorario=-03:00
UtilizaEnvioSincrono=1
AutoImprimir=0
AutoEmail=0
RemoveCaracterXml=1
VersaoEsquema=pl_009
DiretorioTemplates=Plugins\ManagerNFCe\Files\Templates\
DiretorioEsquemas=Plugins\ManagerNFCe\Files\Esquemas\
QtdeTentativas=1
ControleStandBy=CNPJ
ValidarXML=0
NumeracaoDescartada=0
DelayConsulta=0
ToleranciaStandBy=2
TempoStandBy=300
NomeSecaoManager=MANAGEREDOC
LoteAutomatico=1
LoteAutomaticoTimer=0
LoteAutomaticoQtdeNotas=0
AbrirJanelaImpressao=0
BloquearConsultaResolver=0
TentativasConversaoTX2=0
TimerResolvePendencias=0
UsaLineDelimiter=1
EmailCC=
LogotipoEmitente=
ValidarXMLJuntoAoSefaz=0
EnviarNotaAutomaticamente=0
AtualizaHoraEnvio=1
MarginTop=0
MarginLeft=0
InteligenciaErroNaoCatalogado=1
ThreadedByFolder=1
UtilizarPluginA3=0
[QRCODE]
QrCodeComCdata=1
[DANFCE]
LogotipoEmitente=C:\Program Files (x86)\Manager eDoc\logotipos\logotipoNFCe08187168000160.png
FraseContingencia=Danfce em contingência - Impresso em decorrência de problemas técnicos
FraseHomologacao=SEM VALOR FISCAL
ModeloDanfce=Plugins\ManagerNFCe\Files\Templates\Vm50b\Danfce\retrato.rtm
ModeloDanfceMensagemEletronica=Plugins\ManagerNFCe\Files\Templates\Vm50\Danfce\retrato.rtm
FormatoDanfce=NORMAL
ExibirDetalhamento=1
LineDelimiter=|
QtdeCopias=1
InfCplMaxCol=68
InfCplMaxRow=7
TokenNFCe=....
IdTokenNFCe=000001
ParamsAvancados=
[LICENSE]
Codigo=438
FileName=
[MAIL]
Servidor=smtp.gmail.com
EmailRemetente=testexml2011@gmail.com
Assunto=Você recebeu uma nota fiscal do consumidor eletrônico
Mensagem=Os arquivos referentes à nota fiscal do consumidor eletrônica foram anexados a este email.
Usuario=testexml2011@gmail.com
Senha=...;
TimeOut=10000
EmailDestinatario=
CCo=
CC=
Autenticacao=1
Porta=587
MensagemCancelamento=
AssuntoCancelamento=
MensagemDestinatario=Seu cadastro no portal do destinatário acabou de ser efetuado.
AssuntoDestinatario=
ConteudoHtml=0
QtdeTentativasEmail=3
TipoTLS=REQUIRETLS
[NOTASEGURA]
NotaSeguraServidor=
NotaSeguraLogin=
NotaSeguraSenha=
NotaSeguraToken=
[INTEGRADOR]
Ativar=0
DiretorioEntrada=C:\Integrador\Input
DiretorioSaida=C:\Integrador\Output
TimeOut=30
NumeroSessao=111111
Utilização da rota no POSTMAN
Colocamos um exemplo de como funciona a rota de CONFIGURAÇÕES VIA MODO NO MANAGER SaaS/eDoc utilizando requisição HTTPS via POSTMAN.
Basta baixar nosso exemplo se encontra no final desta documentação e importar para seu postman ou para outro software de requisição de rota.
Comentários
0 comentário
Por favor, entre para comentar.