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, versão do Manager SaaS/EDoc e alterar propriedades de configuração.
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 |
| GetVersion | 1 | Retorna o número da versão do Manager SaaS e EDoc | GetVersion=1 ou GetVersion |
| NomeCidade | 1 | Retorna o nome da cidade do prestador | NomeCidade=SAOPAULO |
Os campos disponíveis para configuração estão divididos em seções para melhor organização, seguem abaixo:
Manager SaaS
| 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 NFS-e. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| AnexaPDF | Anexa a impressão da NFS-e em formato PDF no envio de e-mail. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| AnexaXML | Anexa o XML da NFS-e no envio de e-mail. |
Por padrão 1 1 - Habilita ou 0 - Desabilita |
| RemoveCaracterXml | Remove caracteres especiais do XML da NFS-e antes da assinatura. | 1 - Habilita ou 0 - Desabilita |
| NumeroAutomatico | Numeração automática da NFS-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. | Por padrão 180000 (em milissegundos) |
| LoteAutomatico | Envio de NFS-e em lote automático para padrões que suportam esse tipo de envio. |
Por padrão 1 1 - Habilita ou 0 - Desabilita |
| QtdeTentativas | Quantidade máxima de tentativas do envio da NFS-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 |
| NumeroLoteAutomatico | Gera e controla o número de Lote automaticamente. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| TentativasConversaoTX2 | Número de tentativas da conversão do padrão TX2 para XML. |
Por Padrão 0
|
| UsaLineDelimiter | Habilita ou desabilita o uso de delimitador de linha. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| EnvioSincrono | Tipo do método de envio da NFS-e. |
1 - Habilita ou 0 - Desabilita |
| LoginServidor | Login do usuário no WebService da prefeitura, quando o padrão exigir esse dado na comunicação. |
Por padrão vazio. |
| SenhaServidor | Senha do usuário no WebService da prefeitura, quando o padrão exigir esse dado na comunicação. |
Por padrão vazio. (deve ser realizado o URL Encode) |
| substituiInfoPrestadorImpressao |
Utiliza os dados do prestador do RPS na impressão da NFS-e. Observação: Utilizado normalmente quando a consulta de NFS-e do WebService não retorna os dados do prestador. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
Manager EDoc
As propriedades da tabela do Manager SaaS também são validas para o Manager EDoc. Abaixo seguem propriedades especificas para uso no EDoc:
| Campo | Descrição | Valor |
| AutoImprimir | Impressão da NFS-e logo após autorização. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| Titulo | Título a ser exibido na interface Desktop do Manager EDoc. | Por padrão "Manager EDoc". |
| DiretorioImpressao |
Diretório onde está localizado o layout de impressão da NFS-e. Observação: O caminho depende do padrão do Município. |
Por padrão na pasta de instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerNFSe\Files\Templates\Impressao\BETHA20 |
| ImpressoraPadrao | Indica a impressora padrão para a impressão da NFS-e. | Por padrão a impressora definida como padrão do windows. |
| ModoImpressao | Indica a forma de impressão da NFS-e. |
Por padrão "PDF". Impressora: Imprime na impressora configurada. PDF: Gera impressão em arquivo .pdf. Ambos: Imprime na impressora configurada e gera o arquivo .pdf. |
| QtdeCopias | Quantidade de cópias da impressão da NFS-e. |
Por padrão 1. |
| LogotipoEmitente | Propriedade onde permite-se configurar o Logo do Emitente no layout de impressão da NFS-e. |
Por padrão vazio. Exemplos: C:\logo.png ou C:\logo.jpeg. |
| ControleStandBy | Indica a forma como o Manger EDoc vai controlar a entrada em StandBy. | Por padrão "CNPJ". (Atualmente só existe essa forma de controle de standby). |
| NomeSecaoManager | Indica o nome da seção no arquivo .ini onde estão as configurações do EDoc. | Por padrão nome da seção é MANAGEREDOC |
| AbrirJanelaImpressao | Indica que deve ser aberta a janela de escolha de impressora do Windows, quando não informado uma impressora na requisição. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| ArquivoServidoresHom |
Diretório onde está localizado o arquivo .ini com os servidores de homologação da NFS-e. |
Por padrão na pasta de instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerNFSe\Files\nfseServidoresHom.ini |
| ArquivoServidoresProd |
Diretório onde está localizado o arquivo .ini com os servidores de produção da NFS-e. |
Por padrão na pasta de instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerNFSe\Files\nfseServidoresProd.ini |
| DiretorioTemplates |
Diretório onde está localizado os templates de comunicação dos padrões da NFS-e. Observação: O caminho depende do padrão do Município. |
Por padrão na pasta de instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerNFSe\Files\Templates\BETHA |
| DiretorioEsquemas |
Diretório onde está localizado os esquemas dos padrões da NFS-e. Observação: O caminho depende do padrão do Município. |
Por padrão na pasta de instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerNFSe\Files\Esquemas\BETHA |
| Ambiente |
Indica em qual ambiente (produção ou homologação) o Manager EDoc está operando. |
Por padrão ambiente 2.
1 - Produção 2 - Homologação |
| MappingFileName |
Diretório onde está localizado o arquivo de mapping que realiza a conversão dos campos do TX2 para os campos do XML do padrão NFS-e. Observação: O caminho depende do padrão do Município. |
Por padrão na pasta de instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerNFSe\Files\Esquemas\BETHA\Mapping.txt |
| ArquivoLocais |
Diretório onde está localizado o arquivo .ini com as configurações de cada município da NFS-e. |
Por padrão na pasta de instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerNFSe\Files\nfseLocais.ini |
| NomeCertificado |
Propriedade que contém o nome do certificado utilizado para assinatura das NFS-e. |
Por padrão vazio. |
| UF |
Estado no qual está cadastrado o emitente da NFS-e. |
Sigla do estado do emitente. Exemplo: PR |
| DiretorioLog |
Permite ao desenvolvedor configurar o diretório (parcial ou completo) onde estão contidos os arquivos logs (arquivos .xml) das interações com os webservices. |
Por padrão na pasta de instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerNFSe\Files\nfseLocais.ini |
| InscricaoMunicipal |
Inscrição Municipal do emitente. |
Por padrão vazio. |
| TipoCertificado |
Tipo do certificado digital. |
ckActiveDiretory, ckFile (CurrentUserStore), LocalMachine, ckMemory ou Smart Card. |
| PINCODE |
PinCode do Certificado A3 |
Quando se estiver utilizando TipoCertificado igual a SmartCard, pode-se configurar o PinCode do certificado digital. |
| Proxy |
Endereço do Servidor de Proxy. |
IP do Servidor de Proxy |
| Usuario |
Usuário do Servidor de Proxy. |
Usuário do Proxy, Ex: admin |
| Senha |
Senha do usuário do Servidor de Proxy. |
Senha do usuário, Ex: 12345 |
| RemoveCaracterXml |
Remove os acentos do XML ao assinar ou escapa os mesmos. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| DadosImpressaoDelimiter |
Delimitador dos campos customizados da impressão. |
O padrão é o caractere "|". |
| ProcessamentoAgendado |
Define o horário ao qual irá ocorrer o envio do lote de RPS ao WebService da Prefeitura. |
Por padrão vazio. Exemplo: 17:30 |
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 NF-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 NF-e e seu respectivo DANFE. |
| AssuntoCancelamento | Assunto do e-mail do evento de cancelamento | Olá, em anexo está o XML do cancelamento da sua NF-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 NF-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). | 60000 |
| EmailDestinatario | Email para o qual será enviada a NF-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 |
GET
https://managersaas.tecnospeed.com.br:8081/ManagerAPIWeb/nfse/modo
Headers
| Nome | Descrição | Exemplo |
| Authorization |
Este usuário e senha são os seus dados para acessar a interface Web do grupo desejado do SaaS, localizado em https://managersaas.tecnospeed.com.br:8081 Este parâmetro deve ser gerado a partir de um Base64 da seguinte informação: usuario:senha |
Para o exemplo de usuario:senha = admin:1234, o valor gerado é: Basic YWRtaW46MTIzNA== |
Querystring
| Nome | Descrição |
| Grupo | Nome do grupo |
| CNPJ | CNPJ do emitente da NFS-e cadastrado no Manager SaaS, apenas números |
| Comando ou Campo |
Valor do comando desejado, exemplo: GetVencimentoCertificado=1 |
Exemplo requisição: https://www.getpostman.com/collections/d0b1d1b60abaed2bf9a9
Retorno
Será de acordo com o comando ou campo informado.
Exemplo de retorno com os campos (UtilizaEnvioSincrono=1) :
OK, Operação realizada com sucesso
Exemplo de retorno (GetVencimentoCertificado=1) :
03/05/2019 13:34:00
Configuração de RPS, Serie ou de Lote
POST
https://managersaas.tecnospeed.com.br:8081/ManagerAPIWeb/nfse/modo
Headers
| Nome | Descrição | Exemplo |
| Authorization |
Este usuário e senha são os seus dados para acessar a interface Web do grupo desejado do SaaS, localizado em https://managersaas.tecnospeed.com.br:8081 Este parâmetro deve ser gerado a partir de um Base64 da seguinte informação: usuario:senha |
Para o exemplo de usuario:senha = admin:1234, o valor gerado é: Basic YWRtaW46MTIzNA== |
Querystring
| Nome | Descrição |
| Grupo | Nome do grupo |
| CNPJ |
CNPJ do emitente da NFS-e cadastrado no Manager SaaS, apenas números
|
| NomeCidade | Nome da Cidade do CNPJ |
| SerieRps | Serie do RPS a ser alterada, para configuração de numeração de lote, utilizar o mesmo campo com a informação SerieRps=LOTE_AUTOM |
| NumeroInicial | Numero do RPS ou do lote que vai ser utilizado |
| TipoRps | TipoRps=1, para configuração de lote, informar TipoRps=Numeracao_Automatica_do_Lote |
Retorno
OK, Operação realizada com sucesso
Comentários
0 comentário
Por favor, entre para comentar.