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

Informações Gerais

Especificação
Produto	TSS	Módulo	NF-e
Segmento Executor	Serviços
Chamado/ISSUE	DSERTSS1-15465
País	( X ) Brasil ( ) Argentina ( ) México ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colômbia ( ) Outro _____________.

Índice

Objetivo
Regras de Negócio
Web Services e Métodos do TSS

Objetivo

Realizar o envio do Evento de Excesso de Bagagem do BP-e, assim atendendo a NT 2020.001.

Link: https://dfe-portal.svrs.rs.gov.br/Bpe

Regras de Negócio

Função: evento destinado informação da cobrança do excesso de bagagem no BP-e.

Autor do Evento: O autor do evento é o emissor do BP-e. A mensagem XML do evento será assinada com o certificado digital que tenha o CNPJ base do Emissor do BP-e.

Código do Tipo de Evento: 110117

Web Services e Métodos do TSS

Para o envio do evento deverá seguir o seguinte processo:

Detalhes sobres os métodos abaixo:

Através do método AdmEmpresas do serviço SPEDADM, será realizado a criação da empresa, onde é representada por um código de entidade no TSS.

Segue os links com detalhes:

Link do Serviço: WebService - SPEDADM

Link Método: Método - AdmEmpresas

Exemplo de Envio

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ADMEMPRESAS xmlns="http://webservices.totvs.com.br/spedadm.apw">
			<USERTOKEN>TOTVS</USERTOKEN>
			<EMPRESA>
				<BAIRRO>BAIRRO</BAIRRO>
				<CEP>00000000</CEP>
				<CNPJ>00000000000000</CNPJ>
				<COD_MUN>0000000</COD_MUN>
				<COD_PAIS>0000</COD_PAIS>
				<COMPL/>
				<CPF/>
				<DDD>00</DDD>
				<ENDERECO>ENDERECO</ENDERECO>
				<FANTASIA>NOME FANTASIA</FANTASIA>
				<FAX>0000000</FAX>
				<FONE>0000000</FONE>
				<IE>000000000000</IE>
				<IM>00000000</IM>
				<MUN>MUNICIPIO</MUN>
				<NIRE/>
				<NOME>NOME EMPRESA</NOME>
				<NUM>NUMERO ENDERECO</NUM>
				<UF>XX</UF>
			</EMPRESA>
		</ADMEMPRESAS>
	</soap:Body>
</soap:Envelope>

Exemplo de Retorno

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ADMEMPRESASRESPONSE xmlns="http://webservices.totvs.com.br/spedadm.apw">
			<ADMEMPRESASRESULT>000001</ADMEMPRESASRESULT>
		</ADMEMPRESASRESPONSE>
	</soap:Body>
</soap:Envelope>

Através do método CfgBPe do serviço SPEDCFGNFE, será realizado a configuração dos parâmetros da empresa, ou seja, parâmetros necessários da entidade no TSS para envio do evento.

Segue os links com detalhes:

Link do Serviço: WebService - SpedCfgNFe

Link Método: Método - CfgBPe

Exemplo de Envio

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<CFGBPE xmlns="http://webservices.totvs.com.br/spedcfgnfe.apw">
		    <USERTOKEN>TOTVS</USERTOKEN>
	         <ID_ENT>000001</ID_ENT>
	         <AMBIENTEBPE>2</AMBIENTEBPE>
	         <VERSAOBPE>1.00</VERSAOBPE>
	         <VERBPELAYOUT>1.00</VERBPELAYOUT>
	         <VERBPELAYEVEN>1.00</VERBPELAYEVEN>
			 <HORAVERAOBPE>2</HORAVERAOBPE>
			 <HORARIOBPE>2</HORARIOBPE>
		</CFGBPE>
	</soap:Body>
</soap:Envelope>

Exemplo de Retorno

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <CFGBPERESPONSE xmlns="http://webservices.totvs.com.br/spedcfgnfe.apw">
         <CFGBPERESULT>
            <AMBIENTEBPE>2-Homologação</AMBIENTEBPE>
            <HORARIOBPE>2-Brasilia</HORARIOBPE>
            <HORAVERAOBPE>2-Nao</HORAVERAOBPE>
            <VERBPELAYEVEN>1.00</VERBPELAYEVEN>
            <VERBPELAYOUT>1.00</VERBPELAYOUT>
            <VERSAOBPE>1.00</VERSAOBPE>
         </CFGBPERESULT>
      </CFGBPERESPONSE>
   </soap:Body>
</soap:Envelope>

Através do método CfgCertificatePFX do serviço SPEDCFGNFE, será realizado a configuração do certificado digital da empresa para assinatura do envio do evento de Excesso de Bagagem.

Segue os links com detalhes:

Link do Serviço: WebService - SpedCfgNFe

Link Método: Método - CFGCertificatePFX

Exemplo de Envio

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<CFGCERTIFICATEPFX xmlns="http://webservices.totvs.com.br/spedcfgnfe.apw">
			<USERTOKEN>TOTVS</USERTOKEN>
			<ID_ENT>000001</ID_ENT>
			<CERTIFICATE>Y2VydGlmaWNhZG8gZW5jb2RhZG8gZW0gYmFzZTY0</CERTIFICATE>
			<PASSWORD>c2VuaGEgZW5jb2RhZG8gZW0gYmFzZTY0</PASSWORD>
		</CFGCERTIFICATEPFX>
	</soap:Body>
</soap:Envelope>

Exemplo de Retorno

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<CFGCERTIFICATEPFXRESPONSE xmlns="http://webservices.totvs.com.br/spedcfgnfe.apw">
			<CFGCERTIFICATEPFXRESULT>Certificado (PFX)- Ok
				Autoridades certificadoras convertidas para formato apache - Ok
				Certificado convertido para formato apache - Ok
				PrivateKey convertida para formato apache - Ok
				Password - Ok

				Registrado para: EMPRESA TESTE
				Validade de 01/01/2020 ate 31/12/9999
			</CFGCERTIFICATEPFXRESULT>
		</CFGCERTIFICATEPFXRESPONSE>
	</soap:Body>
</soap:Envelope>

Através do método RemessaEvento do serviço NFESBRA, será realizado o envio do evento de excesso de bagagem.

Deverá ser realizado a montagem da tag XML_LOTE, encodado em base64, da seguinte maneira:

Conteúdo LOTE_XML

<envEvento>
	<eventos>
		<detEvento>
			<tpEvento>110117</tpEvento>
			<chNFe>00000000000000000000000000000000000000000000</chNFe>
			<ambiente>2</ambiente>
			<nProt>0000000000</nProt>
			<qBagagem>10</qBagagem>
			<vTotBag>30</vTotBag>
		</detEvento>
	</eventos>
</envEvento>

Tag	Descrição	Tamanho	Tag Pai	Obrigatório	Observação
tpEvento	Tipo do Evento	8	detEvento	Sim
chNFe	Chave do BP-e	44	detEvento	Sim
ambiente	Ambiente de emissão do BP-e	1	detEvento	Opcional	1 - Produção / 2 - Homologação. Caso não seja enviado, será considerado a configuração do parâmetro MV_AMBBPE
nProt	Protocolo de autorização do BP-e	15	detEvento	Sim
qBagagem	Quantidade de volumes de bagagem carregados	20	detEvento	Sim
vTotBag	Valor total do serviço	13,2	detEvento	Sim

Segue os links com detalhes:

Link do Serviço: WebService - NFESBra

Link Método: Método - RemessaEvento

Exemplo de Envio

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<REMESSAEVENTO xmlns="http://webservices.totvs.com.br/nfsebra.apw">
			<USERTOKEN>TOTVS</USERTOKEN>
			<ID_ENT>000001</ID_ENT>
			<XML_LOTE>PGVudkV2ZW50bz48ZXZlbnRvcz48ZGV0RXZlbnRvPjx0cEV2ZW50bz4xMTAxMTc8L3RwRXZlbnRvPjxjaE5GZT4wMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDwvY2hORmU+PGFtYmllbnRlPjI8L2FtYmllbnRlPjxuUHJvdD4wMDAwMDAwMDAwPC9uUHJvdD48cUJhZ2FnZW0+MTA8L3FCYWdhZ2VtPjx2VG90QmFnPjMwPC92VG90QmFnPjwvZGV0RXZlbnRvPjwvZXZlbnRvcz48L2VudkV2ZW50bz4=</XML_LOTE>
		</REMESSAEVENTO>
	</soap:Body>
</soap:Envelope>

Exemplo de Retorno

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<REMESSAEVENTORESPONSE xmlns="http://webservices.totvs.com.br/nfsebra.apw">
			<REMESSAEVENTORESULT>
				<STRING>ID1101170000000000000000000000000000000000000000000001</STRING>
			</REMESSAEVENTORESULT>
		</REMESSAEVENTORESPONSE>
	</soap:Body>
</soap:Envelope>

Através do método NFeMonitorLoteEvento do serviço NFESBRA, será realizado o monitoramento do envio do evento de excesso de bagagem.

Segue os links com detalhes:

Link do Serviço: WebService - NFESBra

Link Método: Método - NfeMonitorLoteEvento

Exemplo de Envio

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<NFEMONITORLOTEEVENTO xmlns="http://webservices.totvs.com.br/nfsebra.apw">
			<USERTOKEN>TOTVS</USERTOKEN>
			<ID_ENT>000001</ID_ENT>
			<EVENTO>110117</EVENTO>
			<CHVINICIAL/>
			<CHVFINAL/>
			<CHAVES>00000000000000000000000000000000000000000000</CHAVES>
		</NFEMONITORLOTEEVENTO>
	</soap:Body>
</soap:Envelope>

Exemplo de Retorno

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <NFEMONITORLOTEEVENTORESPONSE xmlns="http://webservices.totvs.com.br/nfsebra.apw">
         <NFEMONITORLOTEEVENTORESULT>
            <NFEMONITOREVENTO>
               <AMBIENTE>2</AMBIENTE>
               <CMOTENV>Lote de evento processado</CMOTENV>
               <CMOTEVEN>Evento registrado</CMOTEVEN>
               <CORGAO>35</CORGAO>
               <CSTATENV>128</CSTATENV>
               <CSTATEVEN>135</CSTATEVEN>
               <DHREGEVEN>0000-00-00T00:00:00-00:00</DHREGEVEN>
               <ID_EVENTO>ID1101170000000000000000000000000000000000000000000001</ID_EVENTO>
               <LOTE>0</LOTE>
               <MENSAGEM>Evento Autorizado</MENSAGEM>
               <PROTOCOLO>000000000000000</PROTOCOLO>
               <STATUS>6</STATUS>
               <TIPOEVENTO>110117</TIPOEVENTO>
            </NFEMONITOREVENTO>
         </NFEMONITORLOTEEVENTORESULT>
      </NFEMONITORLOTEEVENTORESPONSE>
   </soap:Body>
</soap:Envelope>

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

Páginas filhas

ER_Evento de BPe - Excesso de bagagem

Informações Gerais

Regras de Negócio

Web Services e Métodos do TSS