Histórico da Página

ÍNDICE

Visão Geral
Leiaute e exemplo de requisição
Exemplo de requisição
Leiaute de resposta
Exemplo de resposta
utilização

01. VISÃO GERAL

Leiaute de requisição para informação de empresa para uso do aplicativo.

Requisição
Resposta
Empresa
Configuração NFC-e / NF-e
Configuração S@T
Impressora

02. LEIAUTE

...

Outras Ações / Ações relacionadas

03. EXEMPLO DE REQUISIÇÃO

Outras Ações / Ações relacionadas

04. LEIAUTE DE RESPOSTA

Outras Ações / Ações relacionadas

05. EXEMPLO DE RESPOSTA

...

E EXEMPLO DE UTILIZAÇÃO

Totvs custom tabs box

tabs	Requisição,Resposta,Empresa,Configuração NFC-e / NF-e,Configuração S@T,Impressora
ids	requisicao,resposta,empresa,config_dfe,config_sat,impressora

Totvs custom tabs box items

default	yes
referencia	requisicao

Bloco de código

language	xml
title	Leiaute de requisição

<!-- requisicao -->
<requisicao>
    <!-- 
    campo: tipo
    funcao: informar o tipo de requisicao
    valores: dfe / sat / printer / browse 
    -->
    <tipo>{informar_o_tipo_da_requisicao}</tipo>
    
    <!--
    campo: acao
    funcao: informar a acao da requisicao que será executada
    valores:
    - dfe: consultarStatusOperacional / enviarDadosVenda / enviarDadosCancelamento / imprimirDanfe / inutilizarDocumento / consultarDocumento
    - sat: consultarStatusOperacional / enviarDadosVenda / enviarDadosCancelamento / imprimirDanfe / imprimirDanfeCancelamento
    - printer: imprimirConteudo
    - browse: abrirLocal
    -->
    <acao>{informar_a_acao_da_requisicao}</acao>
    
    <!--
    campo: parametros
    funcao: informar os parametros para uso da requisicao
    -->
    <parametros>
    <![CDATA[
                    incluir conteudo xml dos parametros
    ]]>
    </parametros>
    
    <!--
    campo: arquivoResposta
    funcao: informar o arquido de resposta para retorno de requisicao
    -->
    <arquivoResposta>{informar_o_arquivo_da_resposta}</arquivoResposta>
</requisicao>

Bloco de código

language	xml
title	Exemplo de requisição

<requisicao>
<tipo>dfe</tipo>
<acao>consultarDocumento</acao>
<parametros>
<![CDATA[
    <empresa>
        <CNPJ>11146466000116</CNPJ>
        <IE>111222333444</IE>
        <razaoSocial>Nome Razao Teste</razaoSocial>
        <fantasia>Nome Fantasia</fantasia>
        <cep>27460000</cep>
        <tipoLogradouro>Avenida</tipoLogradouro>
        <logradouro>Brasil</logradouro>
        <nro>S/N</nro>
        <bairro>Centro</bairro>
        <complemento>Sala 1</complemento>
        <cMunicipio>3304557</cMunicipio>
        <xMunicipio>Rio de Janeiro</xMunicipio>
        <cUF>33</cUF>
        <xUF>RJ</xUF>
        <cPais>1058</cPais>
        <xPais>Brasil</xPais>
        <telefone>44555667788</telefone>
        <email>[email protected]</email>
        <tipoRegimeTributario>1</tipoRegimeTributario>
    </empresa>
    <configuracao>
        <tipoAmbiente>2</tipoAmbiente>
        <tipoEmissao>1</tipoEmissao>
        <imagemLogotipo></imagemLogotipo>
        <modeloDocumento>65</modeloDocumento>
        <idCSC>000002</idCSC>
        <CSC>83E444DDEFB5B39B2AB6EF35A354797DRMSX</CSC>
        <versaoServico>400</versaoServico>
        <arquivoCertificado>certificado.pfx</arquivoCertificado>
        <senhaCertificado>1234</senhaCertificado>
        <protocoloDeSeguranca>Tls12</protocoloDeSeguranca>
        <utilizaCertificadoPorSerial>false</utilizaCertificadoPorSerial>
        <indicadorSincronizacao>1</indicadorSincronizacao>
    </configuracao>
    <impressora>
        <impressaoTipo></impressaoTipo>
        <nome></nome>
        <porta></porta>
        <fila>1</fila>
        <arquivo></arquivo>
        <email></email>
    </impressora>
]]>
</parametros>
<arquivoResposta>resposta_dfe_consultarDocumento.xml</arquivoResposta>
</requisicao>

Totvs custom tabs box items

default	no
referencia	resposta

Bloco de código

language	xml
title	Leiaute de resposta

<resposta>
    <!-- 
    campo: tipo
    funcao: retornar o tipo de requisicao de entrada
    valores: dfe / sat / printer / browse 
    -->
    <tipo>{tipo_da_requisicao_informado_na_requisicao}</tipo>
    
    <!-- 
    campo: acao
    funcao: retornar a acao da requisicao de entrada
    valores
    - dfe: consultarStatusOperacional / enviarDadosVenda / enviarDadosCancelamento / imprimirDanfe / inutilizarDocumento / consultarDocumento
    - sat: consultarStatusOperacional / enviarDadosVenda / enviarDadosCancelamento / imprimirDanfe / imprimirDanfeCancelamento
    - printer: imprimirConteudo
    - browse: abrirLocal
    -->
    <acao>{acao_da_requisicao_informado_na_requisicao}</acao>
    
    <!-- 
    campo: tipoMensagem
    funcao: retornar o tipo de mensagem gerado pela requisicao erro / executado
    valores: erro / executado
    -->
    <tipoMensagem>{tipo_mensagem_erro_ou_sucesso}</tipoMensagem>
    
    <!-- 
    campo: mensagem
    funcao: retornar a mensagem gerado pela requisicao
    -->
    <mensagem>{mensagem_de_resposta}</mensagem>
    
    <!-- 
    campo: retorno
    funcao: retornar o conteudo gerado pela requisicao
    -->
    <retorno>
    <![CDATA[
                    conteudo de retorno da requisicao
    ]]>
    </retorno>
</resposta>

Bloco de código

language	xml
title	Exemplo de resposta

<?xml version="1.0" encoding="utf-16"?>
<resposta xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<tipo>dfe</tipo>
<acao>consultarDocumento</acao>
<tipoMensagem>executado</tipoMensagem>
<retorno>
    <![CDATA[
<retConsSitNFe versao="4.00" xmlns="http://www.portalfiscal.inf.br/nfe">
<tpAmb>2</tpAmb>
<verAplic>SVRSnfce201809061124</verAplic>
<cStat>100</cStat>
<xMotivo>Autorizado o uso da NF-e</xMotivo>
<cUF>33</cUF>
<dhRecbto>2019-08-21T10:49:58-03:00</dhRecbto>
<chNFe>33190511146466000116654440000008011823959936</chNFe>
<protNFe versao="4.00">
<infProt Id="ID333190000467874">
<tpAmb>2</tpAmb>
<verAplic>SVRSnfce201807191353</verAplic>
<chNFe>33190511146466000116654440000008011823959936</chNFe>
<dhRecbto>2019-05-15T09:20:59-03:00</dhRecbto>
<nProt>333190000467874</nProt>
<digVal>I7+giKo7YWys5YAWbXRXxl/tyUA=</digVal>
<cStat>100</cStat>
<xMotivo>Autorizado o uso da NF-e</xMotivo>
</infProt>
</protNFe>
</retConsSitNFe>
    ]]>
</retorno>
</resposta>

Totvs custom tabs box items

default	no
referencia	empresa

Bloco de código

language	xml
title	Leiaute de empresa

    <empresa>
        <!--
        campo: CNPJ
        funcao: informar o CNPJ da empresa emitente
        -->
        <CNPJ>11146466000116</CNPJ>

        <!--
        campo: IE
        funcao: informar a incrição estadual da empresa emitente
        -->
        <IE>111222333444</IE>

        <!--
        campo: razaoSocial
        funcao: informar o nome razão social da empresa emitente
        -->
        <razaoSocial>Nome Razao Teste</razaoSocial>

        <!--
        campo: fantasia
        funcao: informar o nome fantasia da empresa emitente
        -->
        <fantasia>Nome Fantasia</fantasia>

        <!--
        campo: cep
        funcao: informar o nome fantasia da empresa emitente
        -->
        <cep>27460000</cep>

        <!--
        campo: tipoLogradouro
        funcao: informar o tipo de logradouro da empresa emitente
        -->
        <tipoLogradouro>Avenida</tipoLogradouro>

        <!--
        campo: logradouro
        funcao: informar o logradouro da empresa emitente
        -->
        <logradouro>Brasil</logradouro>

        <!--
        campo: nro
        funcao: informar o numero do logradouro da empresa emitente
        -->
        <nro>S/N</nro>

        <!--
        campo: bairro
        funcao: informar o bairro da empresa emitente
        -->
        <bairro>Centro</bairro>

        <!--
        campo: complemento
        funcao: informar o complemento da empresa emitente
        -->
        <complemento>Sala 1</complemento>

        <!--
        campo: cMunicipio
        funcao: informar o codigo do municipio da empresa emitente
        -->
        <cMunicipio>3304557</cMunicipio>

        <!--
        campo: xMunicipio
        funcao: informar o nome do municipio da empresa emitente
        -->
        <xMunicipio>Rio de Janeiro</xMunicipio>

        <!--
        campo: cUF
        funcao: informar o codigo da UF da empresa emitente
        -->
        <cUF>33</cUF>

        <!--
        campo: xUF
        funcao: informar o nome da UF da empresa emitente
        -->
        <xUF>RJ</xUF>

        <!--
        campo: cPais
        funcao: informar o codigo do pais da empresa emitente
        -->
        <cPais>1058</cPais>

        <!--
        campo: xPais
        funcao: informar o nome do pais da empresa emitente
        -->
        <xPais>Brasil</xPais>

        <!--
        campo: telefone
        funcao: informar o telefone da empresa emitente
        -->
        <telefone>44555667788</telefone>
        
        <!--
        campo: email
        funcao: informar o email da empresa emitente
        -->
        <email>[email protected]</email>

        <!--
        campo: tipoRegimeTributario
        funcao: informar o tipo de regime tributario da empresa emitente
        valores: 1: SimplesNacional / 3: RegimeNormal
        -->
        <tipoRegimeTributario>1</tipoRegimeTributario>
    </empresa>

Totvs custom tabs box items

default	no
referencia	config_dfe

Bloco de código

language	xml
title	Leiaute de configuração de NFC-e / NF-e

    <configuracao>
        <!-- 
        campo: tipoAmbiente
        funcao: informar o tipo de ambiente
        valores: 1: Producao / 2: Homologacao 
        -->
        <tipoAmbiente>2</tipoAmbiente>
        
        <!-- 
        campo: tipoEmissao
        funcao: informar o tipo de emissao
        valores: 1: Normal / 9: OffLine 
        -->
        <tipoEmissao>1</tipoEmissao> 
        
        <!-- 
        campo: imagemLogotipo
        funcao: conteudo base64 da imagem do logotipo
        -->
        <imagemLogotipo></imagemLogotipo>
        
        <!-- 
        campo: modeloDocumento
        funcao: informar o modelo de documento fiscal
        valores: 55: NFe / 65: NFCe 
        -->
        <modeloDocumento>65</modeloDocumento> 
        
        <!-- 
        campo: idCSC
        funcao: informar o código da sequencia do codigo de seguranca do contribuinte
        -->
        <idCSC>000002</idCSC>
        
        <!-- 
        campo: CSC
        funcao: informar o codigo de seguranca do contribuinte
        -->
        <CSC>83E444DDEFB5B39B2AB6EF35A354797DRMSX</CSC>
        
        <!-- 
        campo: versaoServico
        funcao: informar a versao do servico do sefaz (400 = 4.00, ...)
        -->
        <versaoServico>400</versaoServico>
        
        <!-- 
        campo: arquivoCertificado
        funcao: informar o novo do arquivo do certificado digital, contido na sub pasta Certificados
        -->
        <arquivoCertificado>certificado.pfx</arquivoCertificado>
        
        <!-- 
        campo: senhaCertificado
        funcao: informar a senha do certificado digital
        -->
        <senhaCertificado>1234</senhaCertificado>
        
        <!-- 
        campo: protocoloDeSeguranca
        funcao: informar o protocolo de seguranca
        valores: Ssl3, Tls, Tls11, Tls12
        -->
        <protocoloDeSeguranca>Tls12</protocoloDeSeguranca>
        
        <!-- 
        campo: utilizaCertificadoPorSerial
        funcao: informar se utiliza certifical por serial
        -->
        <utilizaCertificadoPorSerial>false</utilizaCertificadoPorSerial>
        
        <!-- 
        campo: indicadorSincronizacao
        funcao: informar o indicador de sincronizacao
        valores: 0: Assincrono / 1: Sincrono 
        -->
        <indicadorSincronizacao>1</indicadorSincronizacao> 
    </configuracao>

Totvs custom tabs box items

default	no
referencia	config_sat

Bloco de código

language	xml
title	Leiaute de configuração de S@T

    <configuracao>
        <!-- 
        campo: codigoAtivacao
        funcao: informar o codigo de ativacao
        -->
        <codigoAtivacao>bema1234</codigoAtivacao>

        <!-- 
        campo: codigoAssinaturaAplicativoComercial
        funcao: informar o codigo de assinatura do aplicativo comercial
        -->
        <codigoAssinaturaAplicativoComercial>SGR-SAT SISTEMA DE GESTAO E RETAGUARDA DO SAT</codigoAssinaturaAplicativoComercial>

        <!-- 
        campo: satModelo
        funcao: informar o modelo do sat
        -->
        <satModelo>Bematech_RB2000</satModelo>

        <!-- 
        campo: cnpjSoftwareHouse
        funcao: informar o CNPJ da software house
        -->
        <cnpjSoftwareHouse>16716114000172</cnpjSoftwareHouse>

        <!-- 
        campo: numeroCaixa
        funcao: informar o numero do caixa
        -->
        <numeroCaixa>1</numeroCaixa>

        <!-- 
        campo: tipoAmbiente
        funcao: informar o tipo de ambiente
        valores: 1: Producao / 2: Homologacao
        -->
        <tipoAmbiente>2</tipoAmbiente>

        <!-- 
        campo: versaoDadosEnt
        funcao: informar a versao do xml do cfe
        -->
        <versaoDadosEnt>0.07</versaoDadosEnt>

        <!-- 
        campo: chaveAcessoValidador
        funcao: informar a chave de acesso do validar do mfe
        -->
        <chaveAcessoValidador>25CFE38D-3B92-46C0-91CA-CFF751A82D3D</chaveAcessoValidador>

        <!-- 
        campo: pastaInput
        funcao: informar a pasta de input para uso do integrador do mfe
        -->
        <pastaInput>C:\Integrador\Input</pastaInput>

        <!-- 
        campo: pastaOutput
        funcao: informar a pasta de output para uso do integrador de mfe
        -->
        <pastaOutput>C:\Integrador\Output</pastaOutput>

        <!-- 
        campo: imagemLogotipo
        funcao: informar o conteudo da imagem para logotipo no formato base64
        -->
        <imagemLogotipo></imagemLogotipo>
    </configuracao>

Totvs custom tabs box items

default	no
referencia	impressora

Bloco de código

language	xml
title	Leiaute de impressora

    <impressora>
        <!-- 
        campo: impressaoTipo
        funcao: informar o tipo de impressao
        valores: dispositivo, portaserial, portanetuse, portaprint
        -->
        <impressaoTipo></impressaoTipo>

        <!-- 
        campo: nome
        funcao: informar o nome da impressora
        -->
        <impressora></impressora>

        <!-- 
        campo: porta
        funcao: informar a porta da impressora
        -->
        <porta></porta>

        <!-- 
        campo: fila
        funcao: informar a sequencia da fila de impressao
        -->
        <fila>1</fila>

        <!-- 
        campo: arquivo
        funcao: informar o nome do arquivo de saida
        -->
        <arquivo></arquivo>

        <!-- 
        campo: email
        funcao: informar o email para envio
        -->
        <email></email>
    </impressora>

HTML

<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

ÍNDICE

01. VISÃO GERAL

02. LEIAUTE

03. EXEMPLO DE REQUISIÇÃO

04. LEIAUTE DE RESPOSTA

05. EXEMPLO DE RESPOSTA

E EXEMPLO DE UTILIZAÇÃO