Você está na página 1de 25

DetalheseespecificaesdoWebServiceNotaFiscalEletrnica

1.

Introduo
Este manual tem como objetivo apresentar a definio das especificaes ecritrios tcnicosnecessrios para
utilizaodoWebServiceparaasempresasautorizadasaemitirnotafiscaleletrnica.
Por meio do Web Serviceasempresaspodero integrar seusprpriossistemas deinformaes com o Sistema
de Notas Fiscais de Servios Eletrnicas. Desta forma, consegue automatizar o processo de emisso e
consultadeNFSe.

2. Interfacesdisponveis
Atravs do Web Service, disponibiliza uma srie de interfaces que podero ser acessadas pelos sistemas dos
contribuintes.Aseguir,estoresumidasasinterfacesdisponveisesuasrespectivasfuncionalidadesbsicas.

2.1. EnviodelotedeRPS
Atravs desta interface, os prestadores de servios podero enviar lotes de RPS emitidos por seus sistemas
paraquesejamsubstitudosporNotasFiscaisEletrnicas.

2.2. ConsultadelotedeRPS
Aps o envio bem sucedido de um Lote de RPS, informando o nmero do Protocolo gerado o Web Service
retornatodasasNFegeradasnestelote.

2.3. ConsultadeProtocolodeRPS
Aps o envio bem sucedido de um Lote de RPS, informando o nmero do Protocolo gerado o Web Service
retornaasinformaesrelativasaoprocessamentodoprotocolo.

2.4. ValidaodelotedeRPS
Atravs destainterface, os prestadoresde serviospodero enviarlotes deRPSemitidos porseus sistemas em
ambientesdetesteparaquesejamfeitasasvalidaesdoRPS

2.5. CancelamentodeNFSe

Permite ao contribuinte cancelar uma Nota Eletrnica de Servios Prestados, seja de origem RPS ou lanada
diretamentenosistema.

3.

Especificaes
3.1. EndereodoWebService
3.1.1. Homologao:
https://nfehomologacao.etransparencia.com.br/<prefeitura>/webservice/aws_nfe.aspx?wsdl
Onde<prefeitura>=igualaprefeituraemquesto,exemplo.mg.varginha,sp.limeira,rj.petropolis,etc
3.2. Detalhamentodasmensagensderetornosdelogin:

Usurio/ContribuinteNoIdentificado(Erro1)
Significaqueocdigodeusurioinformadonofoiencontradonosistema.
Usurio/ContribuinteNoIdentificado(Erro2)
Significaqueousurioestcomacessobloqueadopelaprefeitura
Usurio/ContribuinteNoIdentificado(Erro3)
Aguardandoaprovaodaprefeitura
Usurio/ContribuinteNoIdentificado(Erro4)
Usuriorejeitadopelaprefeitura
Usurio/ContribuinteNoIdentificado(Erro5)
Cadastrodousurioirregular
Usurio/ContribuinteNoIdentificado(Erro6)
Usuriointernodaprefeitura.Owebservicedeusoexclusivodoscontribuintes

Usurio/ContribuinteNoIdentificado(Erro7)
Contribuintenoemissordenota.
Usurio/ContribuinteNoIdentificado(Erro8)
Situaodocontribuintenopermiteemissodenota
Usurio/ContribuinteNoIdentificado(Erro11)
Noencontradocontribuintecomocdigoinformado.
Usurio/ContribuinteNoIdentificado(Erro13)
Usurionotempermissoparaemissodenotaparaocontribuinteinformado.
3.3. Mtodos
3.3.1. PROCESSARPS(EnviodelotedeRPS)

<**Method**>
Sdt_ProcessarpsOutPROCESSARPS(

inSdt_ProcessarpsInSdt_processarpsin
)

<**Operationinfo**>

Address=https://nfehomologacao.etransparencia.com.br/<prefeitura>/webservice/aws_nfe.aspx

Action=NFeaction/AWS_NFE.PROCESSARPS

Binding=ws_nfeSoapBinding

Protocol=SOAP

Style=Document

Use=Literal

Requestelement=ws_nfe.PROCESSARPS

Requestnamespace=NFe

Responseelement=ws_nfe.PROCESSARPSResponse

Responsenamespace=NFe

<**Schematypesreferenced**>

NFe:Sdt_ProcessarpsOut

NFe:Sdt_ProcessarpsOut.Message

NFe:Sdt_ProcessarpsIn

NFe:Sdt_ProcessarpsIn.Login

NFe:Sdt_ProcessarpsIn.SDTRPS

NFe:Sdt_ProcessarpsIn.SDTRPS.Reg20Item

NFe:Sdt_ProcessarpsIn.SDTRPS.Reg20Item.Reg30Item

NFe:Sdt_ProcessarpsIn.SDTRPS.Reg90

ns0=NFe

<**INMessage**>
<ns0:ws_nfe.PROCESSARPS>

<ns0:Sdt_processarpsin>

<ns0:Login>

<ns0:CodigoUsuario>string</ns0:CodigoUsuario>

<ns0:CodigoContribuinte>string</ns0:CodigoContribuinte>

</ns0:Login>

<ns0:SDTRPS>

<ns0:Ano>string</ns0:Ano>

<ns0:Mes>string</ns0:Mes>

<ns0:CPFCNPJ>string</ns0:CPFCNPJ>

<ns0:DTIni>string</ns0:DTIni>

<ns0:DTFin>string</ns0:DTFin>

<ns0:TipoTrib>string</ns0:TipoTrib>

<ns0:DtAdeSN>string</ns0:DtAdeSN>

<ns0:AlqIssSN_IP>string</ns0:AlqIssSN_IP>

<ns0:Versao>string</ns0:Versao>

<ns0:Reg20>

<ns0:Reg20Item>

<ns0:TipoNFS>string</ns0:TipoNFS>

<ns0:NumRps>string</ns0:NumRps>

<ns0:SerRps>string</ns0:SerRps>

<ns0:DtEmi>string</ns0:DtEmi>

<ns0:RetFonte>string</ns0:RetFonte>

<ns0:CodSrv>string</ns0:CodSrv>

<ns0:DiscrSrv>string</ns0:DiscrSrv>

<ns0:VlNFS>string</ns0:VlNFS>


<ns0:VlDed>string</ns0:VlDed>

<ns0:DiscrDed>string</ns0:DiscrDed>

<ns0:VlBasCalc>string</ns0:VlBasCalc>

<ns0:AlqIss>string</ns0:AlqIss>

<ns0:VlIss>string</ns0:VlIss>

<ns0:VlIssRet>string</ns0:VlIssRet>

<ns0:CpfCnpTom>string</ns0:CpfCnpTom>

<ns0:RazSocTom>string</ns0:RazSocTom>

<ns0:TipoLogtom>string</ns0:TipoLogtom>

<ns0:LogTom>string</ns0:LogTom>

<ns0:NumEndTom>string</ns0:NumEndTom>

<ns0:ComplEndTom>string</ns0:ComplEndTom>

<ns0:BairroTom>string</ns0:BairroTom>

<ns0:MunTom>string</ns0:MunTom>

<ns0:SiglaUFTom>string</ns0:SiglaUFTom>

<ns0:CepTom>string</ns0:CepTom>

<ns0:Telefone>string</ns0:Telefone>

<ns0:InscricaoMunicipal>string</ns0:InscricaoMunicipal>

<ns0:TipoLogLocPre>string</ns0:TipoLogLocPre>

<ns0:LogLocPre>string</ns0:LogLocPre>

<ns0:NumEndLocPre>string</ns0:NumEndLocPre>

<ns0:ComplEndLocPre>string</ns0:ComplEndLocPre>

<ns0:BairroLocPre>string</ns0:BairroLocPre>

<ns0:MunLocPre>string</ns0:MunLocPre>

<ns0:SiglaUFLocpre>string</ns0:SiglaUFLocpre>

<ns0:CepLocPre>string</ns0:CepLocPre>

<ns0:Email1>string</ns0:Email1>

<ns0:Email2>string</ns0:Email2>

<ns0:Email3>string</ns0:Email3>

<ns0:Reg30>

<ns0:Reg30Item>

<ns0:TributoSigla>string</ns0:TributoSigla>

<ns0:TributoAliquota>string</ns0:TributoAliquota>

<ns0:TributoValor>string</ns0:TributoValor>

</ns0:Reg30Item>

<ns0:Reg30Item>

<ns0:TributoSigla>string</ns0:TributoSigla>

<ns0:TributoAliquota>string</ns0:TributoAliquota>

<ns0:TributoValor>string</ns0:TributoValor>

</ns0:Reg30Item>

</ns0:Reg30>

</ns0:Reg20Item>

<ns0:Reg20Item>

<ns0:TipoNFS>string</ns0:TipoNFS>

<ns0:NumRps>string</ns0:NumRps>

<ns0:SerRps>string</ns0:SerRps>

<ns0:DtEmi>string</ns0:DtEmi>

<ns0:RetFonte>string</ns0:RetFonte>

<ns0:CodSrv>string</ns0:CodSrv>

<ns0:DiscrSrv>string</ns0:DiscrSrv>

<ns0:VlNFS>string</ns0:VlNFS>

<ns0:VlDed>string</ns0:VlDed>

<ns0:DiscrDed>string</ns0:DiscrDed>

<ns0:VlBasCalc>string</ns0:VlBasCalc>

<ns0:AlqIss>string</ns0:AlqIss>

<ns0:VlIss>string</ns0:VlIss>

<ns0:VlIssRet>string</ns0:VlIssRet>

<ns0:CpfCnpTom>string</ns0:CpfCnpTom>

<ns0:RazSocTom>string</ns0:RazSocTom>

<ns0:TipoLogtom>string</ns0:TipoLogtom>

<ns0:LogTom>string</ns0:LogTom>

<ns0:NumEndTom>string</ns0:NumEndTom>

<ns0:ComplEndTom>string</ns0:ComplEndTom>

<ns0:BairroTom>string</ns0:BairroTom>

<ns0:MunTom>string</ns0:MunTom>

<ns0:SiglaUFTom>string</ns0:SiglaUFTom>

<ns0:CepTom>string</ns0:CepTom>

<ns0:Telefone>string</ns0:Telefone>

<ns0:InscricaoMunicipal>string</ns0:InscricaoMunicipal>

<ns0:TipoLogLocPre>string</ns0:TipoLogLocPre>

<ns0:LogLocPre>string</ns0:LogLocPre>


<ns0:NumEndLocPre>string</ns0:NumEndLocPre>

<ns0:ComplEndLocPre>string</ns0:ComplEndLocPre>

<ns0:BairroLocPre>string</ns0:BairroLocPre>

<ns0:MunLocPre>string</ns0:MunLocPre>

<ns0:SiglaUFLocpre>string</ns0:SiglaUFLocpre>

<ns0:CepLocPre>string</ns0:CepLocPre>

<ns0:Email1>string</ns0:Email1>

<ns0:Email2>string</ns0:Email2>

<ns0:Email3>string</ns0:Email3>

<ns0:Reg30>

<ns0:Reg30Item>

<ns0:TributoSigla>string</ns0:TributoSigla>

<ns0:TributoAliquota>string</ns0:TributoAliquota>

<ns0:TributoValor>string</ns0:TributoValor>

</ns0:Reg30Item>

<ns0:Reg30Item>

<ns0:TributoSigla>string</ns0:TributoSigla>

<ns0:TributoAliquota>string</ns0:TributoAliquota>

<ns0:TributoValor>string</ns0:TributoValor>

</ns0:Reg30Item>

</ns0:Reg30>

</ns0:Reg20Item>

</ns0:Reg20>

<ns0:Reg90>

<ns0:QtdRegNormal>string</ns0:QtdRegNormal>

<ns0:ValorNFS>string</ns0:ValorNFS>

<ns0:ValorISS>string</ns0:ValorISS>

<ns0:ValorDed>string</ns0:ValorDed>

<ns0:ValorIssRetTom>string</ns0:ValorIssRetTom>

<ns0:QtdReg30>string</ns0:QtdReg30>

<ns0:ValorTributos>string</ns0:ValorTributos>

</ns0:Reg90>

</ns0:SDTRPS>

</ns0:Sdt_processarpsin>
</ns0:ws_nfe.PROCESSARPS>
<**OUTMessage**>
<ns0:ws_nfe.PROCESSARPSResponse>

<ns0:Sdt_processarpsout>

<ns0:Retorno>boolean</ns0:Retorno>

<ns0:Protocolo>string</ns0:Protocolo>

<ns0:Messages>

<ns0:Message>

<ns0:Id>string</ns0:Id>

<ns0:Type>byte</ns0:Type>

<ns0:Description>string</ns0:Description>

<ns0:LinErr>int</ns0:LinErr>

</ns0:Message>

<ns0:Message>

<ns0:Id>string</ns0:Id>

<ns0:Type>byte</ns0:Type>

<ns0:Description>string</ns0:Description>

<ns0:LinErr>int</ns0:LinErr>

</ns0:Message>

</ns0:Messages>

</ns0:Sdt_processarpsout>
</ns0:ws_nfe.PROCESSARPSResponse>

3.3.1.1. Detalhamentodosparmetrosdeentrada
3.3.1.1.1.
<Login>
TagquereceberasinformaesdelogindoWebService
3.3.1.1.1.1. <CodigoUsuario>XXX...</CodigoUsuario>(Caracter64)
CdigodoUsurioquetemapermissoparaemisso/ConsultadeNFSe
Paraobterocdigo,ousuriodeveconsutarocampocdigonaopodeediodoseuperfil
3.3.1.1.1.2. <CodigoContribuinte>XXX...</CodigoContribuinte>(Caracter64)
CdigodoContribuintedoRPS

3.3.1.1.2.
LayoutdoRPS
Oarquivoapresentaumaestruturaderegistrosquedeveserenviadaconformeapresentaoabaixo:
1. Declaraodenamespace

2.

<Sdt_processarpsinxmlns="NFe">

Todasasestruturasdeveternocabealhoessexmlns="NFe"
Cabealho
<Ano>NNNN</Ano>(Numrico4,0)
Anodasnotasenviadas
<Mes>NN</Mes>(Numrico2,0)
Msdasnotasenviadas
<CPFCNPJ>NNNNNNNNNNNNNN</CPFCNPJ>(Numrico14,0)
CPF/CNPJdoPrestador
Regras:
Preencher o CPF do prestador ou o CNPJ com zeros a esquerda. No caso de
CPF, informar um campo de 11 dgitos. No caso de Pessoa Jurdica informar um
campode14dgitos.
<DTIni>dd/mm/aaaa</DTIni>(Data)
MenordatadeemissodasNFSetransmitidas.
Regras:
DeveserMenorouigualaDatadeInciodoPerodotransferido.
<DTFin>dd/mm/aaaa</DTFin>(Data)
MaiordatadeemissodasNFstransmitidas.
Regras:
DeveserMaiorouigualaDatadeInciodoPeriodotransferido.
<TipoTrib>N</TipoTrib>(Numrico1,0)
Tipodetributaodoprestador
Regras:
Podeterosseguintescontedos:
1 Tributado. O Servio tributado deacordo com a alquotado servio da
listadaprefeitura
2Iseno/Imunidade.Nestecasoaalquotaigualazero.
3 Suspenso. Se a tributao est em deciso judicial, ser acatada a
alquotainformadanoRPS,podendoestaserigualazero.
4 Simples Nacional. O servio tributado de acordo com a alquota do
contribuintenoSimplesNacional
5ISSFixo
6 Iseno parcial. O servio tributado de acordo com a Alquota no
Cadastrodocontribuinte.Estanoaalquotadosimplesnacional.
<DtAdeSN>dd/mm/aaaa</DtAdeSN>(Data)
DatadeAdesoaosimplesnacional.
Regras:
Deverterosseguintescontedos:
CampoobrigatrioseTipoTrib=4
Caso contrrio o campo no deve ser informado ou enviada a TAG vazia
<DtAdeSN/>
<AlqIssSN_IP>NNN,NN</AlqIssSN_IP>(Numrico5,2)
AlquotadeISS(SimplesNacional,IsenoParcial).
Regras:
Deverterosseguintescontedos:
Se o campo TipoTrib informado for igual a 4 (Simples Nacional) deve ser
informadaaalquotadeISSparaoPrestadordoSimplesNacional.
Se o Porte do contribuinte Micro Empreendedor Individual a
alquotadeISSdoSimplesNacionalnoobrigatria.
Se o campo TipoTrib informado for igual a 6 (Iseno Parcial) , deve ser
informadaaAlquotadeISSdocontribuinte.
Caso contrrio o campo no deve ser informado ou enviada a TAG vazia

<AlqIssSN_IP/>.
<Versao>2.00</Versao>(Caracter4)
VersodoLayout
Regras:
Preenchercom2.00

3.

Registro<Reg20>
ondedeveroserenviadosos<Reg20Item>comasnotasdoRPS
Regras:
Obrigatrio
Composio:
<Reg20Item>soositenscontendoasnotas
Composio:
<TipoNFS>XXX</TipoNFS>(Caracter3)
TipodeNFS
Regras:
Preenchercom'RPS'/'RPC'.
RPC indica que o RPS informado foi cancelado. No gerar uma
nota eletrnica cancelada e sim somente informar que esse
nmerofoicancelado
Obs: Para o tipo RPC s devem ser informados os seguintes
campos: nmero, srie e data. Os demais dados so
ignorados. Para fins de totalizao do registro 90 s devem
serconsideradososvaloresdotipoRPS
<NumRps>NNNNNNNNN</NumRps>
(Numrico9,0)
NmerodoReciboprovisriodeservios
Regras:
Campo sequencial queno pode ser repetido edeveserinformado
nasequnciaporsrie.Indicadordodocumentoprovisrio.
<SerRps>XXX</SerRps>(Caracter3)
SriedoRPS
<DtEmi>dd/mm/aaaa</DtEmi>
(Data)
Datadeemissodorecibo
Regras:
DataInformadadevepertenceraoperodoinformado

<RetFonte>XXX</RetFonte>(Caracter3)
Indica se o imposto foi retido no municpio do tomador de
servios,ounomunicpiodoprestador.
Regras:
InformarocontedofixoigualaSIMouNAO.
<CodSrv>NN.NN</CodSrv>(Caracter10)
CdigodoServio
Regras:
Conforme lista de servios do municpio. Incluir formatao de
acordo com o cadastro da prefeitura. O cdigo do servio deve
fazerpartedalistadeserviosdeclaradospeloprestador.
<DiscrSrv>XXX.....</DiscrSrv>(Caracter4000)
Discriminaodanaturezadoservioprestado
Regras:
Alm da discriminao dos servios, os dados de frete,caso
tenha, devero ser digitados neste campo. O \\ representa
quebra de linha e assim ser considerado na impresso da nota
gerada
<VlNFS>NNNNNNNNNNNNN,NN</VlNFS>(Numrico16,2)
ValordaNotaFiscal
Regras:
Usaravrgulacomoseparadordecimal.

<VlDed>NNNNNNNNNNNNN,NN</VlDed>(Numrico16,2)
Valor a ser deduzido do valor da nota para obteno da base
declculodoimposto.
Regras:
NopodeserMaiorqueovalordaNotaFiscal
Usaravrgulacomoseparadordecimal.
<DiscrDed>XXXXX......</DiscrDed>(Caracter4000)
Discriminaoderetenoe/oudeduo.
Regras:
Obrigatrio se Valor da deduo > 0. Ele poder tambm poder
ser utilizado caso o operador necessite informar retenes
obrigatrias como IRPJ, PIS, COFINS, CSLL, INSS etc., sem
necessariamente ter um valor no campo valor da deduo. O \\
representa quebra de linha e assim ser considerado na
impressodanotagerada.
<VlBasCalc>NNNNNNNNNNNNN,NN</VlBasCalc>(Numrico16,2)
Basedeclculo
Regras:
Deve ser igual ao informado no campo valor da nota menos o
informadonocampodevalordededuo.
Usaravrgulacomoseparadordecimal.
<AlqIss>NNN,NN</AlqIss>(Numrico5,2)
PercentualdealquotadeISS
Regras:
Deve estar de acordo com Tabela de servios ou adeso do
simplesnacionaldoPrestadordeservios.
Usaravrgulacomoseparadordecimal.
<VlIss>NNNNNNNNNNNNN,NN</VlIss>(Numrico16,2)
ValordoImpostoCalculado
Regras:
Obrigatriose<RetFonte>='NAO'
Valoriguala0(zero)se<RetFonte>='SIM
Usaravrgulacomoseparadordecimal.
<VlIssRet>NNN,NN</VlIssRet>(Numrico16,2)
ValordoISSRetidopeloTomador
Regras:
Obrigatriose<RetFonte>='SIM'
Valoriguala0(zero)se<RetFonte>='NAO'
Usaravrgulacomoseparadordecimal.
<CpfCnpTom>NNNNNNNNNNNNNN</CpfCnpTom>(Numrico14,0)
CPF/CNPJdoTomadordeservio
Regras:
Preencher o CPF ou CNPJ do tomador de servio com zeros
esquerda.
NocasodeCPF,informarumcampode11dgitos.
NocasodeCNPJinformarumcampode14dgitos.
Para Tomador Consumidor Final informar no campo o Texto:
CONSUMIDOR.
ParatomadordoExteriorinformarnocampootexto:EXTERIOR.
<RazSocTom>XXXX....</RazSocTom>(Caracter60)
RazoSocialouNomedotomador
Regras:
ObrigatrioseTomadorPessoaFsicaoujurdica.
Permiteinformarrazosocialparatomadordoexterior.
<TipoLogtom>XXXX...</TipoLogtom>(Caracter10)
TipodoLogradouroTomador
Regras:
Informarsegundoatabelaquesegue:

RUA
AVENIDA
PRAA
ALAMEDA.
ObrigatrioseTomadorPessoafsicaoujurdica.
<LogTom>XXXX...</LogTom>(Caracter60)
LogradourodoTomador
Regras:
ObrigatriosomenteseTomadorPessoafsicaoujurdica.
Poder ser informado um endereo para tomador do exterior. Se
for informado, os demais dados do endereo sero obrigatrios,
comobairro,numero,etc...
<NumEndTom>XXXX...</NumEndTom>(Caracter10)
NmerodoEndereodoLogradourodoTomador
Regras:
ObrigatrioseTomadorPessoafsicaoujurdica.
Obrigatriose<LogTom>foiinformadoparatomadordoexterior.
<ComplEndTom>XXX...</ComplEndTom>(Caracter60)
ComplementodoEndereodoTomador
<BairroTom>XXXX....</BairroTom>(Caracter60)
BairrodoTomador
Regras:
ObrigatrioseTomadorPessoafsicaoujurdica.
Obrigatriose<LogTom>foiinformadoparatomadordoexterior.
<MunTom>XXXXX...</MunTom>(Caracter60)
NomedoMunicpiodoTomador
Regras:
InformarEXTERIORparaoperaescomoexterior.
Informar o municpio do prestador quando tomador Consumidor
Final
<SiglaUFTom>XX</SiglaUFTom>(Caracter2)
SigladoestadodoTomador
Regras:
InformarEXparaoperaescomoexterior.
InformaraUFdoPrestadorquandootomadorConsumidorFinal.
<CepTom>NNNNNNNN</CepTom>(Numrico8,0)
CEPdoTomador
Regras:
Se <SiglaUFTom> = 'EX' ou se o Tomador Consumidor Final,
campodoCEPdevevirzerado
<Telefone>NNNNNNNNNN</Telefone>(Numrico10,0)
TelefonedoTomador
Regras:
Informaroszerosnosignificativos.
Preencherapenascomnmeros,semseparadores.
NoinformarquandoTomadorConsumidorFinal
<InscricaoMunicipal>XXXXX....</InscricaoMunicipal>(Caracter20)
InscrioMunicipal
Regras:
No Informar quando Tomador Consumidor Final ou Pessoa do
Exterior.
<TipoLogLocPre>XXX...</TipoLogLocPre>(Caracter10)
TipodoLogradourodolocaldePrestaodeServios
Regras:
Informar somente se Local de Prestao de Servios diferente do
EndereodoTomador.
Informarsegundoatabelaquesegue:
RUA
AVENIDA

PRAA
ALAMEDA
Tomador Consumidor Final no pode ter local de
prestaodeservios.
<LogLocPre>XXXXX...</LogLocPre>(Caracter60)
LogradourodoLocaldePrestaodeServios
Regras:
Obrigatrio Somente se o campo <TipoLogLocPre> foi informado.
Poder ser informado endereo de prestao no exterior tambm.
NestecasoaUFdeveserigualaEXeomunicpio=EXTERIOR.
<NumEndLocPre>XXXXX....</NumEndLocPre>(Caracter10)
NmerodoEndereodoLocaldePrestaodeServios
Regras:
ObrigatrioSomenteseocampo<TipoLogLocPre>foiinformado
<ComplEndLocPre>XXXXX.....</ComplEndLocPre>(Caracter60)
ComplementodoEndereodoLocaldePrestaodeServios
<BairroLocPre>XXXXX.....</BairroLocPre>(Caracter60)
BairrodoLocaldePrestaodeServios
Regras:
ObrigatrioSomenteseocampo<TipoLogLocPre>foiinformado
<MunLocPre>XXXXX.....</MunLocPre>(Caracter60)
NomedoMunicpiodoLocaldePrestaodeServios
Regras:
Obrigatrio Somente se o campo <TipoLogLocPre> foi informado.
InformarEXTERIORparaserviosprestadosnoExterior.
<SiglaUFLocpre>XX</SiglaUFLocpre>(Caracter2)
SigladoEstadodoLocaldePrestaodeServios
Regras:
Obrigatrio Somente se o campo <TipoLogLocPre> foi informado.
InformarEXparaoperaescomoexterior
<CepLocPre>NNNNNNNN</CepLocPre>(Numrico8,0)
CdigodoCEPdoLocaldePrestaodeServios
Regras:
Obrigatriosomenteseocampo<TipoLogLocPre>foiinformado.
Se<SiglaUFLocpre>='EX'campodoCEPdevevirzerado.
<Email1>email1@email1.com.br</Email1>(Caracter120)
EmaildoTomadorparaEnviodaNFE
Regras:
Quando o Tomador pessoa Externa ou consumidor final, o
campo poder ser usado como um endereo de Email para envio
daNFE.
<Email2>email2@email2.com.br</Email2>(Caracter120)
EmailparaEnviodaNFE
Regras:
Deve ser diferente do campo <Email1> es deve ser informado se
anotadeveserenviadaparamaisdeumendereodeemail
<Email3>email3@email3.com.br</Email3>(Caracter120)
EmailparaEnviodaNFE
Regras:
Deve ser diferentedoscampos <Email1> e<Email2>es deveser
informado se a nota deve ser enviada para mais de um endereo
deemail
<Reg30>
Contm os tributos municipais, Estaduais e Federais que devem ser
destacadosnanotafiscaleletrnicaimpressa.
Regras:
NoObrigatrio
Para cadaregistro<Reg20Item>que constano arquivoXML, o

4.

contribuinte pode enviar dezeroaNregistros do tipo


<Reg30Item>
No so aceitos registros <Reg30> sem os registros do tipo
<Reg20Item>correspondentes.

<Reg30Item>
Soostributosdeclaradosdo<Reg30>
Regras:
Siglasdetributospermitidas:
COFINS
CSLL
INSS
IR
ISS Informar apenas o ISS quando retido para obter
ovalorlquidodanota.
PIS
Caso tenha algum que no esteja a lista deve verificar com a
prefeitura.
Composio:
<TributoSigla>XXXXXXXXXX</TributoSigla>(Caracter10)
SigladoTributo
<TributoAliquota>NNN,NN</TributoAliquota>(Numrico5,2)
PercentualdoTributo
Regras:
Estarnalistadetributosdomuncipio
<TributoValor>NNNNNNNNNN,NN</TributoValor>(Numrico
10,2)
ValordoTributo

<Reg90>
Representa uma linha de rodap de validao de valoresenviadosnasnotas dotipoRPS. Para
otipoRPCsconsideradaaquantidade.ValoresdoregistroRPCsoignorados.
Regras:
Obrigatrio
Composio
<QtdRegNormal>NNNNN</QtdRegNormal>(Numrico5,0)
Qtd.Deregistrostipo<Reg20Item>
<ValorNFS>NNNNNNNNNNNNN,NN</ValorNFS>(Numrico16,2)
Valortotaldanotasinformadasnoregistrotipo<Reg20Item>
Regras:
Usaravrgulacomoseparadordecimal.
<ValorISS>NNNNNNNNNNNNN,NN</ValorISS>(Numrico16,2)
ValortotaldoISSdeNotasinformadasnoregistrotipo<Reg20Item>
Regras:
Usaravrgulacomoseparadordecimal.
<ValorDed>NNNNNNNNNNNNN,NN</ValorDed>(Numrico16,2)
ValortotaldocampoDeduoinformadasnoregistrotipo<Reg20Item>
Regras:
Usaravrgulacomoseparadordecimal.
<ValorIssRetTom>NNNNNNNNNNNNN,NN</ValorIssRetTom>
(Numrico16,2)
ValorTotaldoISSRetidopeloTomadorinformadasnoregistrotipo
<Reg20Item>
Regras:
Usaravrgulacomoseparadordecimal.
<QtdReg30>NNNNN</QtdReg30>(Numrico5,0)
QuantidadedeRegistrostipo<Reg30Item>
<ValorTributos>NNNNNNNNNNNNN,NN</ValorTributos>(Numrico16,2)
Valortotaldostributosenviadosnoregistro<Reg30Item>
Regras:

Usaravrgulacomoseparadordecimal..

3.3.1.1.3.
ExemplodeXML(utilizandodadosfictcios):
<Sdt_ProcessarpsInxmlns="NFe">
<Login>
<CodigoUsuario>xxxxx</CodigoUsuario>
<CodigoContribuinte>xxxxx</CodigoContribuinte>
</Login>
<SDTRPS>
<Ano>2014</Ano>
<Mes>01</Mes>
<CPFCNPJ>12345678912345</CPFCNPJ>
<DTIni>01/01/2014</DTIni>
<DTFin>20/01/2014</DTFin>
<TipoTrib>N</TipoTrib>
<DtAdeSN>20/10/2001</DtAdeSN>
<AlqIssSN_IP>1,02</AlqIssSN_IP>
<Versao>2.00</Versao>
<Reg20>

<Reg20Item>
<TipoNFS>NFS</TipoNFS>
<NumRps>999999999</NumRps>

<SerRps>XXX</SerRps>

<DtEmi>20/01/2014</DtEmi>

<RetFonte>NAO</RetFonte>

<CodSrv>NN.NN</CodSrv>

<DiscrSrv>DESCRICAO</DiscrSrv>

<VlNFS>1000,00</VlNFS>

<VlDed>0,00</VlDed>

<DiscrDed>DESCRICAO</DiscrDed>
<VlBasCalc>1000,00</VlBasCalc>

<AlqIss>1,00</AlqIss>

<VlIss>10,00</VlIss>

<VlIssRet>0,00</VlIssRet>

<CpfCnpTom>12332165498</CpfCnpTom>
<RazSocTom>TOMADORTESTE</RazSocTom>
<TipoLogtom>RUA</TipoLogtom>

<LogTom>JOSEFONSECA</LogTom>
<NumEndTom>111</NumEndTom>

<ComplEndTom>COMPLEMENTODOENDERECO.</ComplEndTom>
<BairroTom>CENTRO</BairroTom>

<MunTom>CIDADE</MunTom>

<SiglaUFTom>SP</SiglaUFTom>

<CepTom>12345563</CepTom>

<Telefone>16789463521</Telefone>

<InscricaoMunicipal>XXXXXXXXXXXXXXXXXXXX</InscricaoMunicipal>
<TipoLogLocPre>XXX</TipoLogLocPre>
<LogLocPre>XXXX...</LogLocPre>
<NumEndLocPre>XXXXX..</NumEndLocPre>
<ComplEndLocPre>XXXXX...</ComplEndLocPre>
<BairroLocPre>XXXXX...</BairroLocPre>
<MunLocPre>XXXXX...</MunLocPre>
<SiglaUFLocpre>XX</SiglaUFLocpre>
<CepLocPre>NNNNNNNN</CepLocPre>
<Email1>email1@email1.com</Email1>
<Email2/>
<Email3/>
<Reg30>
<Reg30Item>
<TributoSigla>INSS</TributoSigla>
<TributoAliquota>1,00</TributoAliquota>
<TributoValor>0,10</TributoValor>
</Reg30Item>
</Reg30>

</Reg20Item>
</Reg20>
<Reg90>

<QtdRegNormal>1</QtdRegNormal>

<ValorNFS>1000,00</ValorNFS>

<ValorISS>10,00</ValorISS>

<ValorDed>0,00</ValorDed>

<ValorIssRetTom>0,00</ValorIssRetTom>
<QtdReg30>1</QtdReg30>

<ValorTributos>0,10</ValorTributos>
</Reg90>
</SDTRPS>
</Sdt_ProcessarpsIn>

3.3.1.2. Detalhamentodosparmetrosdesada
3.3.1.2.1.
Retorno(Boolean)
3.3.1.2.1.1.
True
Estruturafoienviadacorretamenteefoigeradoumprotocolodeprocessamento.
3.3.1.2.1.2.
False
Estruturanofoienviadacorretamenteenogeradoprotocolo.

3.3.1.2.2.
<Protocolo>XXX...</Protocolo>(Caracter20)
CdigodoprotocolodeenviodoRPS

3.3.1.2.3.
Messages(Collection)
ColeocomasmensagensdoprocessamentodoRPS
3.3.1.2.3.1.
ID(Varchar128)
Identificadordoerro
3.3.1.2.3.2.
Type(Numrico2,0)
Tipodeerro
3.3.1.2.3.3.
Description(Varchar300)
Descritivodoerro
3.3.1.2.3.4.
LinErr(Numrico5,0)
LinhaqueocorreuoerronoXML

3.3.2. CONSULTANOTASPROTOCOLO(ConsultadelotedeRPS)

<**Method**>
SDT_ConsultaNotasProtocoloOutCONSULTANOTASPROTOCOLO(
inSDT_ConsultaNotasProtocoloInSdt_consultanotasprotocoloin
)

<**Operationinfo**>
Address=https://nfehomologacao.etransparencia.com.br/<prefeitura>/webservice/aws_nfe.aspx
Action=NFeaction/AWS_NFE.CONSULTANOTASPROTOCOLO
Binding=ws_nfeSoapBinding
Protocol=SOAP
Style=Document
Use=Literal
Requestelement=ws_nfe.CONSULTANOTASPROTOCOLO
Requestnamespace=NFe
Responseelement=ws_nfe.CONSULTANOTASPROTOCOLOResponse
Responsenamespace=NFe

<**Schematypesreferenced**>
NFe:SDT_ConsultaNotasProtocoloOut
NFe:SDT_ConsultaNotasProtocoloOut.Message
NFe:SDT_ConsultaNotasProtocoloOut.XML_Notas
NFe:SDT_ConsultaNotasProtocoloOut.XML_Notas.Reg20Item
NFe:SDT_ConsultaNotasProtocoloOut.XML_Notas.Reg20Item.Reg30Item
NFe:SDT_ConsultaNotasProtocoloOut.XML_Notas.Reg90
NFe:SDT_ConsultaNotasProtocoloIn
NFe:SDT_ConsultaNotasProtocoloIn.Login

<**INMessage**>
Mtodo:ws_nfe.CONSULTANOTASPROTOCOLO
<Sdt_consultanotasprotocoloinxmlns="NFe">
<Protocolo>string</Protocolo>
<Login>
<CodigoUsuario>string</CodigoUsuario>
<CodigoContribuinte>string</CodigoContribuinte>
</Login>
</Sdt_consultanotasprotocoloin>
<**OUTMessage**>
Mtodo:ws_nfe.CONSULTANOTASPROTOCOLOResponse
<Sdt_consultanotasprotocolooutxmlns="NFe">
<Retorno>boolean</Retorno>
<Messages>
<Message>
<Id>string</Id>
<Type>byte</Type>
<Description>string</Description>
<LinErr>int</LinErr>
</Message>
<Message>
<Id>string</Id>
<Type>byte</Type>
<Description>string</Description>
<LinErr>int</LinErr>
</Message>
</Messages>
<XML_Notas>
<CpfCnpj>string</CpfCnpj>
<DtIni>date</DtIni>
<DtFin>date</DtFin>
<TipoArq>short</TipoArq>
<Versao>string</Versao>
<Reg20>
<Reg20Item>
<TipoNf>string</TipoNf>
<NumNf>int</NumNf>
<SerNf>string</SerNf>
<DtEmiNf>string</DtEmiNf>
<DtHrGerNf>string</DtHrGerNf>
<CodVernf>string</CodVernf>
<NumRps>int</NumRps>
<SerRps>string</SerRps>
<DtEmiRps>string</DtEmiRps>
<TipoCpfCnpjPre>string</TipoCpfCnpjPre>
<CpfCnpjPre>string</CpfCnpjPre>
<RazSocPre>string</RazSocPre>
<LogPre>string</LogPre>
<NumEndPre>string</NumEndPre>
<ComplEndPre>string</ComplEndPre>
<BairroPre>string</BairroPre>
<MunPre>string</MunPre>
<SiglaUFPre>string</SiglaUFPre>
<CepPre>int</CepPre>
<EmailPre>string</EmailPre>
<TipoTribPre>string</TipoTribPre>
<DtAdeSN>string</DtAdeSN>
<AlqIssSN>double</AlqIssSN>
<SitNf>byte</SitNf>
<DataCncNf>string</DataCncNf>
<MotivoCncNf>string</MotivoCncNf>
<TipoCpfCnpjTom>string</TipoCpfCnpjTom>
<CpfCnpjTom>string</CpfCnpjTom>
<RazSocTom>string</RazSocTom>
<LogTom>string</LogTom>
<NumEndTom>string</NumEndTom>
<ComplEndTom>string</ComplEndTom>
<BairroTom>string</BairroTom>
<MunTom>string</MunTom>
<SiglaUFTom>string</SiglaUFTom>
<CepTom>int</CepTom>
<EMailTom>string</EMailTom>
<LogLocPre>string</LogLocPre>
<NumEndLocPre>string</NumEndLocPre>
<ComplEndLocPre>string</ComplEndLocPre>
<BairroLocPre>string</BairroLocPre>

<MunLocPre>string</MunLocPre>
<SiglaUFLocpre>string</SiglaUFLocpre>
<CepLocPre>int</CepLocPre>
<CodSrv>string</CodSrv>
<DiscrSrv>string</DiscrSrv>
<VlNFS>double</VlNFS>
<VlDed>double</VlDed>
<DiscrDed>string</DiscrDed>
<VlBasCalc>double</VlBasCalc>
<AlqIss>double</AlqIss>
<VlIss>double</VlIss>
<VlIssRet>double</VlIssRet>
<Reg30>
<Reg30Item>
<TributoSigla>string</TributoSigla>
<TributoAliquota>double</TributoAliquota>
<TributoValor>double</TributoValor>
</Reg30Item>
<Reg30Item>
<TributoSigla>string</TributoSigla>
<TributoAliquota>double</TributoAliquota>
<TributoValor>double</TributoValor>
</Reg30Item>
</Reg30>
</Reg20Item>
<Reg20Item>
<TipoNf>string</TipoNf>
<NumNf>int</NumNf>
<SerNf>string</SerNf>
<DtEmiNf>string</DtEmiNf>
<DtHrGerNf>string</DtHrGerNf>
<CodVernf>string</CodVernf>
<NumRps>int</NumRps>
<SerRps>string</SerRps>
<DtEmiRps>string</DtEmiRps>
<TipoCpfCnpjPre>string</TipoCpfCnpjPre>
<CpfCnpjPre>string</CpfCnpjPre>
<RazSocPre>string</RazSocPre>
<LogPre>string</LogPre>
<NumEndPre>string</NumEndPre>
<ComplEndPre>string</ComplEndPre>
<BairroPre>string</BairroPre>
<MunPre>string</MunPre>
<SiglaUFPre>string</SiglaUFPre>
<CepPre>int</CepPre>
<EmailPre>string</EmailPre>
<TipoTribPre>string</TipoTribPre>
<DtAdeSN>string</DtAdeSN>
<AlqIssSN>double</AlqIssSN>
<SitNf>byte</SitNf>
<DataCncNf>string</DataCncNf>
<MotivoCncNf>string</MotivoCncNf>
<TipoCpfCnpjTom>string</TipoCpfCnpjTom>
<CpfCnpjTom>string</CpfCnpjTom>
<RazSocTom>string</RazSocTom>
<LogTom>string</LogTom>
<NumEndTom>string</NumEndTom>
<ComplEndTom>string</ComplEndTom>
<BairroTom>string</BairroTom>
<MunTom>string</MunTom>
<SiglaUFTom>string</SiglaUFTom>
<CepTom>int</CepTom>
<EMailTom>string</EMailTom>
<LogLocPre>string</LogLocPre>
<NumEndLocPre>string</NumEndLocPre>
<ComplEndLocPre>string</ComplEndLocPre>
<BairroLocPre>string</BairroLocPre>
<MunLocPre>string</MunLocPre>
<SiglaUFLocpre>string</SiglaUFLocpre>
<CepLocPre>int</CepLocPre>
<CodSrv>string</CodSrv>
<DiscrSrv>string</DiscrSrv>
<VlNFS>double</VlNFS>
<VlDed>double</VlDed>
<DiscrDed>string</DiscrDed>
<VlBasCalc>double</VlBasCalc>
<AlqIss>double</AlqIss>
<VlIss>double</VlIss>
<VlIssRet>double</VlIssRet>

<Reg30>
<Reg30Item>
<TributoSigla>string</TributoSigla>
<TributoAliquota>double</TributoAliquota>
<TributoValor>double</TributoValor>
</Reg30Item>
<Reg30Item>
<TributoSigla>string</TributoSigla>
<TributoAliquota>double</TributoAliquota>
<TributoValor>double</TributoValor>
</Reg30Item>
</Reg30>
</Reg20Item>
</Reg20>
<Reg90>
<QtdRegNormal>int</QtdRegNormal>
<ValorNFS>double</ValorNFS>
<ValorISS>double</ValorISS>
<ValorDed>double</ValorDed>
<ValorIssRet>double</ValorIssRet>
<QtdReg30>int</QtdReg30>
<ValorTributos>double</ValorTributos>
</Reg90>
</XML_Notas>
</Sdt_consultanotasprotocoloout>

3.3.2.1. Detalhamentodosparmetrosdeentrada
3.3.2.1.1.
<Protocolo>XXX...</Protocolo>(Caracter20)
CdigodoprotocolodeenviodoRPS
3.3.2.1.2.
<Login>
TagquereceberasinformaesdelogindoWebService
3.3.2.1.2.1.
<CodigoUsuario>XXX...</CodigoUsuario>(Caracter64)
CdigodoUsurioquetemapermissoparaemisso/ConsultadeNFE
Paraobterocdigo,ousuriodeveconsutarocampocdigonaopodeediodoseuperfil
3.3.2.1.2.2.
<CodigoContribuinte>XXX...</CodigoContribuinte>(Caracter64)
CdigodoContribuintedoRPS

3.3.2.2. DetalhamentodosparmetrosdeSada
3.3.2.2.1.
Retorno(Boolean)
3.3.2.2.1.1.
True
Estruturafoienviadacorretamenteefoigeradoumprotocolodeprocessamento.
3.3.2.2.1.2.
False
Estruturanofoienviadacorretamenteenogeradoprotocolo.

3.3.2.2.2.
Messages(Collection)
ColeocomasmensagensdoprocessamentodoRPS
3.3.2.2.2.1.
ID(Varchar128)
Identificadordoerro
3.3.2.2.2.2.
Type(Numrico2,0)
Tipodeerro
3.3.2.2.2.3.
Description(Varchar300)
Descritivodoerro
3.3.2.2.2.4.
LinErr(Numrico5,0)
LinhaqueocorreuoerronoXML

3.3.2.2.3.
<XML_Notas>

<CPFCNPJ>NNNNNNNNNNNNNN</CPFCNPJ>(Numrico14,0)
CPF/CNPJdoPrestador
<DTIni>dd/mm/aaaa</DTIni>(Data)
MenordatadeemissodasNFstransmitidas.
<DTFin>dd/mm/aaaa</DTFin>(Data)
MaiordatadeemissodasNFstransmitidas.
<TipoArq>N</TipoTrib>(Numrico1,0)

Tipodetributaodoprestador
<Versao>2.00</Versao>(Caracter4)
VersodoLayout

<Reg20>
ondedeveroserenviadosos<Reg20Item>comasnotasdoRPS
Composio:
<Reg20Item>soositenscontendoasnotas
Composio:

<TipoNf>X</TipoNf>(Caracter1)
TipodeNFS
<NumNf>XXX</NumNf>(Numrico9)
NmerodaNotaFiscal
<SerNf>XXX</SerNf>(Caracter3)
SriedaNotaFiscal
<DtEmiNf>dd/mm/aaaa</DtEmiNf>(Varchar10)
Datadeemissodanotafiscal
<DtHrGerNf>dd/mm/aaaahh:mm:ss</DtHrGerNf>(Varchar10)
Datadegeraodanotafiscal
<CodVernf>XXX</CodVernf>(Caracter3)
SriedaNotaFiscal
<NumRps>NNNNNNNNN</NumRps>
(Numrico9,0)
NmerodoReciboprovisriodeservios
<SerRps>XXX</SerRps>(Caracter3)
SriedoRPS
<DtEmiRPS>dd/mm/aaaa</DtEmiRPS>
(Varchar10)
Datadeemissodorecibo
<TipoCpfCnpjPre>X</TipoCpfCnpjPre>(Caracter1)
TipodeCpf/Cnpj(Prestadordeservio)
<CpfCnpjPre>XXX...</CpfCnpjPre>(Varchar20)
Cpf/Cnpj(Prestadordeservio)
<RazSocPre>XXX...</RazSocPre>(Varchar60)
RazoSocialouNome(Prestadordeservio)
<LogPre>XXX...</LogPre>(Varchar70)
Logradouro(Prestadordeservio)
<NumEndPre>XXX...</NumEndPre>(Varchar10)
NmerodoEndereodoLogradouro(Prestadordeservio)
<ComplEndPre>XXX...</ComplEndPre>(Varchar60)
ComplementodoEndereco(Prestadordeservio)
<BairroPre>XXX...</BairroPre>(Varchar60)
Bairro(Prestadordeservio)
<MunPre>XXX...</MunPre>(Varchar60)
Municpio(Prestadordeservio)
<SiglaUFPre>XX</SiglaUFPre>(Caracter2)
UF(Prestadordeservio)
<CepPre>NNNNNNNN</CepPre>(Numrico8,0)
CEP(Prestadordeservio)
<EmailPre>XXX...</EmailPre>(Varchar120)
Email(Prestadordeservio)
<TipoTribPre>xx</TipoTribPre>(Caracter2)
Tipodetributao(Prestadordeservio)
<DtAdeSN>dd/mm/aaaa</DtAdeSN>(Varchar10)
DatadeadesoSimplesNAcional
<AlqIssSN>NN,NN</AlqIssSN>(Numrico5,2)
AlquotaSimplesNacional
<SitNf>N</SitNf>(Numrico1,0)
SituaodaNotaFiscal
<DataCncNf>dd/mm/aaaa</DataCncNf>(Varchar10)

DatadocancelamentodaNotafiscal
<MotivoCncNf>XXX...</MotivoCncNf>(Varchar100)
Motivodocancelamento
<TipoCpfCnpjTom>X</TipoCpfCnpjTom>(Caracter1)
TipoCPF/CNPJ(Tomador)
<CpfCnpjTom>XXX....</CpfCnpjTom>(Varchar20)
CPF/CNPJ(Tomador)
<RazSocTom>XXX...</RazSocTom>(Varchar60)
Razosocial(Tomador)
<LogTom>XXX...</LogTom>(Varchar70)
Logradouro(Tomador)
<NumEndTom>XXX...</NumEndTom>(Varchar10)
Nmerologradouro(Tomador)
<ComplEndTom>XXX...</ComplEndTom>(Varchar60)
Complemento(Tomador)
<BairroTom>XXX...</BairroTom>(Varchar60)
Bairro(Tomador)
<MunTom>XXX...</MunTom>(Varchar60)
Municpio(Tomador)
<SiglaUFTom>XX</SiglaUFTom>(Caracter2)
UF(Tomador)
<CepTom>NNNNNNNN</CepTom>(Numrico8,0)
CEP(Tomador)
<EMailTom>XXX...</EMailTom>(Varchar120)
Email(Tomador)
<LogLocPre>XXX...</LogLocPre>(Varchar70)
Logradouro(Localdeprestao)
<NumEndLocPre>XXX...</NumEndLocPre>(Varchar10)
NmerodoLogradouro(Localdeprestao)
<ComplEndLocPre>XXX...</ComplEndLocPre>(Varchar60)
Complemento(Localdeprestao)
<BairroLocPre>XXX...</BairroLocPre>(Varchar60)
Bairro(Localdeprestao)
<MunLocPre>XXX...</MunLocPre>(Varchar60)
Municpio(Localdeprestao)
<SiglaUFLocpre>XX</SiglaUFLocpre>(Caracter2)
UF(Localdeprestao)
<CepLocPre>NNNNNNNJN</CepLocPre>(Numrico8,0)
CEP(Localdeprestao)
<CodSrv>XXXXXXXXXX</CodSrv>(Caracter10)
CdigodoServio
<DiscrSrv>XXX...</DiscrSrv>(Varchar4000)
Discriminaodoservio
<VlNFS>NNNNNNNNNNNNNNN,NN</VlNFS>(Numrico16,2)
ValordaNota
<VlDed>NNNNNNNNNNNNNNN,NN</VlDed>(Numrico16,2)
Valordadeduo
<DiscrDed>XXX...</DiscrDed>(Varchar1000)
Discriminaodadeduo
<VlBasCalc>NN,NN</VlBasCalc>(Numrico16,2)
Valordabasedeclculo
<AlqIss>NNNNNNNNNNNNNNN,NN</AlqIss>(Numrico5,2)
AlquotaISS
<VlIss>NNNNNNNNNNNNNNN,NN</VlIss>(Numrico16,2)
ValordoISS
<VlIssRet>NNNNNNNNNNNNNNN,NN</VlIssRet>(Numrico16,2)
ValordoISSretido

<Reg30>
Contm os tributos municipais, Estaduais e Federais que devem ser
destacadosnanotafiscaleletrnicaimpressa.
<Reg30Item>
Soostributosdo<Reg30>

Composio:
<TributoSigla>XXXXXXXXXX</TributoSigla>(Caracter10)
SigladoTributo
<TributoAliquota>NNN,NN</TributoAliquota>(Numrico5,2)
PercentualdoTributo
<TributoValor>NNNNNNNNNN,NN</TributoValor>(Numrico
10,2)
ValordoTributo

<Reg90>
Representaumalinhaderodapdevalidaodevaloresenviadosnasnotas
Composio
<QtdRegNormal>NNNNN</QtdRegNormal>(Numrico5,0)
Qtd.Deregistrostipo<Reg20Item>
<ValorNFS>NNNNNNNNNNNNN,NN</ValorNFS>(Numrico16,2)
Valortotaldanotasinformadasnoregistrotipo<Reg20Item>
<ValorISS>NNNNNNNNNNNNN,NN</ValorISS>(Numrico16,2)
ValortotaldoISSdeNotasinformadasnoregistrotipo<Reg20Item>
<ValorDed>NNNNNNNNNNNNN,NN</ValorDed>(Numrico16,2)
ValortotaldocampoDeduoinformadasnoregistrotipo<Reg20Item>
<ValorIssRetTom>NNNNNNNNNNNNN,NN</ValorIssRetTom>
(Numrico16,2)
ValorTotaldoISSRetidopeloTomadorinformadasnoregistrotipo
<Reg20Item>
<QtdReg30>NNNNN</QtdReg30>(Numrico5,0)
QuantidadedeRegistrostipo<Reg30Item>
<ValorTributos>NNNNNNNNNNNNN,NN</ValorTributos>(Numrico16,2)
Valortotaldostributosenviadosnoregistro<Reg30Item>

3.3.3. CONSULTAPROTOCOLO(ConsultadeProtocolodeRPS)

<**Method**>
SDT_ConsultaProtocoloOutCONSULTAPROTOCOLO(
inSDT_ConsultaProtocoloInSdt_consultaprotocoloin
)

<**Operationinfo**>
Address=https://nfehomologacao.etransparencia.com.br/<prefeitura>/webservice/aws_nfe.aspx
Action=NFeaction/AWS_NFE.CONSULTAPROTOCOLO
Binding=ws_nfeSoapBinding
Protocol=SOAP
Style=Document
Use=Literal
Requestelement=ws_nfe.CONSULTAPROTOCOLO
Requestnamespace=NFe
Responseelement=ws_nfe.CONSULTAPROTOCOLOResponse
Responsenamespace=NFe

<**Schematypesreferenced**>
NFe:SDT_ConsultaProtocoloOut
NFe:SDT_ConsultaProtocoloOut.Message
NFe:SDT_ConsultaProtocoloIn
NFe:SDT_ConsultaProtocoloIn.Login

ns0=NFe

<**INMessage**>
Mtodo:ws_nfe.CONSULTAPROTOCOLO
<ns0:Sdt_consultaprotocoloinxmlns="NFe">
<ns0:Protocolo>string</ns0:Protocolo>
<ns0:Login>
<ns0:CodigoUsuario>string</ns0:CodigoUsuario>
<ns0:CodigoContribuinte>string</ns0:CodigoContribuinte>
</ns0:Login>
</ns0:Sdt_consultaprotocoloin>

<**OUTMessage**>

Mtodo:ws_nfe.CONSULTAPROTOCOLOResponse
<ns0:Sdt_consultaprotocolooutxmlns="NFe">
<ns0:Retorno>boolean</ns0:Retorno>
<ns0:PrtXSts>byte</ns0:PrtXSts>
<ns0:PrtCSerRps>string</ns0:PrtCSerRps>
<ns0:PrtCRps_1>long</ns0:PrtCRps_1>
<ns0:PrtCRps_2>long</ns0:PrtCRps_2>
<ns0:PrtLPrcIni>dateTime</ns0:PrtLPrcIni>
<ns0:PrtLFinGrv>dateTime</ns0:PrtLFinGrv>
<ns0:PnfCNfe_1>int</ns0:PnfCNfe_1>
<ns0:PnfCnfe_2>int</ns0:PnfCnfe_2>
<ns0:Messages>
<ns0:Message>
<ns0:Id>string</ns0:Id>
<ns0:Type>byte</ns0:Type>
<ns0:Description>string</ns0:Description>
<ns0:LinErr>int</ns0:LinErr>
</ns0:Message>
<ns0:Message>
<ns0:Id>string</ns0:Id>
<ns0:Type>byte</ns0:Type>
<ns0:Description>string</ns0:Description>
<ns0:LinErr>int</ns0:LinErr>
</ns0:Message>
</ns0:Messages>
</ns0:Sdt_consultaprotocoloout>

3.3.3.1. Detalhamentodosparmetrosdeentrada
3.3.3.1.1.
<Protocolo>XXX...</Protocolo>(Caracter20)
CdigodoprotocolodeenviodoRPS
3.3.3.1.2.
<Login>
TagquereceberasinformaesdelogindoWebService
3.3.3.1.2.1.
<CodigoUsuario>XXX...</CodigoUsuario>(Caracter64)
CdigodoUsurioquetemapermissoparaemisso/ConsultadeNFE
Paraobterocdigo,ousuriodeveconsutarocampocdigonaopodeediodoseuperfil
3.3.3.1.2.2.
<CodigoContribuinte>XXX...</CodigoContribuinte>(Caracter64)
CdigodoContribuintedoRPS

3.3.3.2. DetalhamentodosparmetrosdeSada
3.3.3.2.1.
Retorno(Boolean)
3.3.3.2.1.1.
True
Estruturafoienviadacorretamenteefoigeradoumprotocolodeprocessamento.
3.3.3.2.1.2.
False
Estruturanofoienviadacorretamenteenogeradoprotocolo.
3.3.3.2.2.
PrtXSts(Numrico1,0)
3.3.3.2.2.1.
1(Aguardandoprocessamento)
3.3.3.2.2.2.
2(EmProcessamento)
3.3.3.2.2.3.
3(Rejeitado)
3.3.3.2.2.4.
4(RejeitadoParcialmente)
3.3.3.2.2.5.
5(Processado)
3.3.3.2.3.
PrtCSerRps(Caracter5)
SriedoRPS
3.3.3.2.4.
PrtCRps_1(Numrico18,0)
NmerodoprimeiroRPSprocessadoouaprocessar.
3.3.3.2.5.
PrtCRps_2(Numrico18,0)
NmerodoprimeiroRPSprocessadoouaprocessar.
3.3.3.2.6.
PrtLPrcIni(Data/Hora)
Data/HoradoIniciodoprocessamento
3.3.3.2.7.
PrtLFinGrv(Data/Hora)
Data/HoradoFinaldoprocessamento
3.3.3.2.8.
PnfCNfe_1(Numrico9,0)
Nmerodaprimeiranotaprocessada
3.3.3.2.9.
PnfCnfe_2(Numrico9,0)

Nmerodaltimanotaprocessada

3.3.3.2.10.
Messages(Collection)
ColeocomasmensagensdoprocessamentodoRPS
3.3.3.2.10.1.
ID(Varchar128)
Identificadordoerro
3.3.3.2.10.2.
Type(Numrico2,0)
Tipodeerro
3.3.3.2.10.3.
Description(Varchar300)
Descritivodoerro
3.3.3.2.10.4.
LinErr(Numrico5,0)
LinhaqueocorreuoerronoXML

3.3.4. VERFICARPS(ValidaodelotedeRPS)
Utiliza a mesma estrutura do servio domtodo PROCESSARPS, comas mesmassadas retornandose
aestruturadoRPSestvalidaouno.
CasoaestruturanoestejavlidaoMtodoretornaasmensagensdeerro.
Esse mtodo no gera protocolo e no gravado no sistema, servindo somente para validao de
estrutura.

<**Method**>
Sdt_ProcessarpsOutVERFICARPS(

inSdt_ProcessarpsInSdt_processarpsin
)

<**Operationinfo**>

Address=https://nfehomologacao.etransparencia.com.br/<prefeitura>/webservice/aws_nfe.aspx

Action=NFeaction/AWS_NFE.VERFICARPS

Binding=ws_nfeSoapBinding

Protocol=SOAP

Style=Document

Use=Literal

Requestelement=ws_nfe.VERFICARPS

Requestnamespace=NFe

Responseelement=ws_nfe.VERFICARPSResponse

Responsenamespace=NFe

<**Schematypesreferenced**>

NFe:Sdt_ProcessarpsOut

NFe:Sdt_ProcessarpsOut.Message

NFe:Sdt_ProcessarpsIn

NFe:Sdt_ProcessarpsIn.Login

NFe:Sdt_ProcessarpsIn.SDTRPS

NFe:Sdt_ProcessarpsIn.SDTRPS.Reg20Item

NFe:Sdt_ProcessarpsIn.SDTRPS.Reg20Item.Reg30Item

NFe:Sdt_ProcessarpsIn.SDTRPS.Reg90

ns0=NFe

<**INMessage**>
<ns0:ws_nfe.VERFICARPS>

<ns0:Sdt_processarpsin>

<ns0:Login>

<ns0:CodigoUsuario>string</ns0:CodigoUsuario>

<ns0:CodigoContribuinte>string</ns0:CodigoContribuinte>

</ns0:Login>

<ns0:SDTRPS>

<ns0:Ano>string</ns0:Ano>

<ns0:Mes>string</ns0:Mes>

<ns0:CPFCNPJ>string</ns0:CPFCNPJ>

<ns0:DTIni>string</ns0:DTIni>

<ns0:DTFin>string</ns0:DTFin>

<ns0:TipoTrib>string</ns0:TipoTrib>

<ns0:DtAdeSN>string</ns0:DtAdeSN>


<ns0:AlqIssSN_IP>string</ns0:AlqIssSN_IP>

<ns0:Versao>string</ns0:Versao>

<ns0:Reg20>

<ns0:Reg20Item>

<ns0:TipoNFS>string</ns0:TipoNFS>

<ns0:NumRps>string</ns0:NumRps>

<ns0:SerRps>string</ns0:SerRps>

<ns0:DtEmi>string</ns0:DtEmi>

<ns0:RetFonte>string</ns0:RetFonte>

<ns0:CodSrv>string</ns0:CodSrv>

<ns0:DiscrSrv>string</ns0:DiscrSrv>

<ns0:VlNFS>string</ns0:VlNFS>

<ns0:VlDed>string</ns0:VlDed>

<ns0:DiscrDed>string</ns0:DiscrDed>

<ns0:VlBasCalc>string</ns0:VlBasCalc>

<ns0:AlqIss>string</ns0:AlqIss>

<ns0:VlIss>string</ns0:VlIss>

<ns0:VlIssRet>string</ns0:VlIssRet>

<ns0:CpfCnpTom>string</ns0:CpfCnpTom>

<ns0:RazSocTom>string</ns0:RazSocTom>

<ns0:TipoLogtom>string</ns0:TipoLogtom>

<ns0:LogTom>string</ns0:LogTom>

<ns0:NumEndTom>string</ns0:NumEndTom>

<ns0:ComplEndTom>string</ns0:ComplEndTom>

<ns0:BairroTom>string</ns0:BairroTom>

<ns0:MunTom>string</ns0:MunTom>

<ns0:SiglaUFTom>string</ns0:SiglaUFTom>

<ns0:CepTom>string</ns0:CepTom>

<ns0:Telefone>string</ns0:Telefone>

<ns0:InscricaoMunicipal>string</ns0:InscricaoMunicipal>

<ns0:TipoLogLocPre>string</ns0:TipoLogLocPre>

<ns0:LogLocPre>string</ns0:LogLocPre>

<ns0:NumEndLocPre>string</ns0:NumEndLocPre>

<ns0:ComplEndLocPre>string</ns0:ComplEndLocPre>

<ns0:BairroLocPre>string</ns0:BairroLocPre>

<ns0:MunLocPre>string</ns0:MunLocPre>

<ns0:SiglaUFLocpre>string</ns0:SiglaUFLocpre>

<ns0:CepLocPre>string</ns0:CepLocPre>

<ns0:Email1>string</ns0:Email1>

<ns0:Email2>string</ns0:Email2>

<ns0:Email3>string</ns0:Email3>

<ns0:Reg30>

<ns0:Reg30Item>

<ns0:TributoSigla>string</ns0:TributoSigla>

<ns0:TributoAliquota>string</ns0:TributoAliquota>

<ns0:TributoValor>string</ns0:TributoValor>

</ns0:Reg30Item>

<ns0:Reg30Item>

<ns0:TributoSigla>string</ns0:TributoSigla>

<ns0:TributoAliquota>string</ns0:TributoAliquota>

<ns0:TributoValor>string</ns0:TributoValor>

</ns0:Reg30Item>

</ns0:Reg30>

</ns0:Reg20Item>

<ns0:Reg20Item>

<ns0:TipoNFS>string</ns0:TipoNFS>

<ns0:NumRps>string</ns0:NumRps>

<ns0:SerRps>string</ns0:SerRps>

<ns0:DtEmi>string</ns0:DtEmi>

<ns0:RetFonte>string</ns0:RetFonte>

<ns0:CodSrv>string</ns0:CodSrv>

<ns0:DiscrSrv>string</ns0:DiscrSrv>

<ns0:VlNFS>string</ns0:VlNFS>

<ns0:VlDed>string</ns0:VlDed>

<ns0:DiscrDed>string</ns0:DiscrDed>

<ns0:VlBasCalc>string</ns0:VlBasCalc>

<ns0:AlqIss>string</ns0:AlqIss>

<ns0:VlIss>string</ns0:VlIss>

<ns0:VlIssRet>string</ns0:VlIssRet>

<ns0:CpfCnpTom>string</ns0:CpfCnpTom>

<ns0:RazSocTom>string</ns0:RazSocTom>


<ns0:TipoLogtom>string</ns0:TipoLogtom>

<ns0:LogTom>string</ns0:LogTom>

<ns0:NumEndTom>string</ns0:NumEndTom>

<ns0:ComplEndTom>string</ns0:ComplEndTom>

<ns0:BairroTom>string</ns0:BairroTom>

<ns0:MunTom>string</ns0:MunTom>

<ns0:SiglaUFTom>string</ns0:SiglaUFTom>

<ns0:CepTom>string</ns0:CepTom>

<ns0:Telefone>string</ns0:Telefone>

<ns0:InscricaoMunicipal>string</ns0:InscricaoMunicipal>

<ns0:TipoLogLocPre>string</ns0:TipoLogLocPre>

<ns0:LogLocPre>string</ns0:LogLocPre>

<ns0:NumEndLocPre>string</ns0:NumEndLocPre>

<ns0:ComplEndLocPre>string</ns0:ComplEndLocPre>

<ns0:BairroLocPre>string</ns0:BairroLocPre>

<ns0:MunLocPre>string</ns0:MunLocPre>

<ns0:SiglaUFLocpre>string</ns0:SiglaUFLocpre>

<ns0:CepLocPre>string</ns0:CepLocPre>

<ns0:Email1>string</ns0:Email1>

<ns0:Email2>string</ns0:Email2>

<ns0:Email3>string</ns0:Email3>

<ns0:Reg30>

<ns0:Reg30Item>

<ns0:TributoSigla>string</ns0:TributoSigla>

<ns0:TributoAliquota>string</ns0:TributoAliquota>

<ns0:TributoValor>string</ns0:TributoValor>

</ns0:Reg30Item>

<ns0:Reg30Item>

<ns0:TributoSigla>string</ns0:TributoSigla>

<ns0:TributoAliquota>string</ns0:TributoAliquota>

<ns0:TributoValor>string</ns0:TributoValor>

</ns0:Reg30Item>

</ns0:Reg30>

</ns0:Reg20Item>

</ns0:Reg20>

<ns0:Reg90>

<ns0:QtdRegNormal>string</ns0:QtdRegNormal>

<ns0:ValorNFS>string</ns0:ValorNFS>

<ns0:ValorISS>string</ns0:ValorISS>

<ns0:ValorDed>string</ns0:ValorDed>

<ns0:ValorIssRetTom>string</ns0:ValorIssRetTom>

<ns0:QtdReg30>string</ns0:QtdReg30>

<ns0:ValorTributos>string</ns0:ValorTributos>

</ns0:Reg90>

</ns0:SDTRPS>

</ns0:Sdt_processarpsin>
</ns0:ws_nfe.VERFICARPS>
<**OUTMessage**>
<ns0:ws_nfe.VERFICARPSResponse>

<ns0:Sdt_processarpsout>

<ns0:Retorno>boolean</ns0:Retorno>

<ns0:Protocolo>string</ns0:Protocolo>

<ns0:Messages>

<ns0:Message>

<ns0:Id>string</ns0:Id>

<ns0:Type>byte</ns0:Type>

<ns0:Description>string</ns0:Description>

<ns0:LinErr>int</ns0:LinErr>

</ns0:Message>

<ns0:Message>

<ns0:Id>string</ns0:Id>

<ns0:Type>byte</ns0:Type>

<ns0:Description>string</ns0:Description>

<ns0:LinErr>int</ns0:LinErr>

</ns0:Message>

</ns0:Messages>

</ns0:Sdt_processarpsout>
</ns0:ws_nfe.VERFICARPSResponse>

3.3.5. CANCELANOTAELETRONICA(CancelamentodeNotaFiscalEletrnicadeServios)

Efetuaocancelamentodeumanotadeacordocomosparmetrosinformados.
<**Method**>
Sdt_RetornoCancelaNFECANCELANOTAELETRONICA(

inSdt_CancelaNFESdt_cancelanfe
)

<**Operationinfo**>

Address=https://localhost/nfe/aws_nfe.aspx

Action=NFeaction/AWS_NFE.CANCELANOTAELETRONICA

Binding=ws_nfeSoapBinding

Protocol=SOAP

Style=Document

Use=Literal

Requestelement=ws_nfe.CANCELANOTAELETRONICA

Requestnamespace=NFe

Responseelement=ws_nfe.CANCELANOTAELETRONICAResponse

Responsenamespace=NFe

<**Schematypesreferenced**>

NFe:Sdt_RetornoCancelaNFE

NFe:Sdt_RetornoCancelaNFE.Message

NFe:Sdt_CancelaNFE

NFe:Sdt_CancelaNFE.Login

NFe:Sdt_CancelaNFE.Nota

ns0=NFe

<**INMessage**>
<ns0:ws_nfe.CANCELANOTAELETRONICA>

<ns0:Sdt_cancelanfe>

<ns0:Login>

<ns0:CodigoUsuario>string</ns0:CodigoUsuario>

<ns0:CodigoContribuinte>string</ns0:CodigoContribuinte>

</ns0:Login>

<ns0:Nota>

<ns0:SerieNota>string</ns0:SerieNota>

<ns0:NumeroNota>int</ns0:NumeroNota>

<ns0:SerieRPS>string</ns0:SerieRPS>

<ns0:NumeroRps>int</ns0:NumeroRps>

<ns0:ValorNota>double</ns0:ValorNota>

<ns0:MotivoCancelamento>string</ns0:MotivoCancelamento>

<ns0:PodeCancelarGuia>string</ns0:PodeCancelarGuia>

</ns0:Nota>

</ns0:Sdt_cancelanfe>
</ns0:ws_nfe.CANCELANOTAELETRONICA>
<**OUTMessage**>
<ns0:ws_nfe.CANCELANOTAELETRONICAResponse>

<ns0:Sdt_retornocancelanfe>

<ns0:Retorno>boolean</ns0:Retorno>

<ns0:Messages>

<ns0:Message>

<ns0:Id>string</ns0:Id>

<ns0:Description>string</ns0:Description>

</ns0:Message>

<ns0:Message>


<ns0:Id>string</ns0:Id>

<ns0:Description>string</ns0:Description>

</ns0:Message>

</ns0:Messages>

</ns0:Sdt_retornocancelanfe>
</ns0:ws_nfe.CANCELANOTAELETRONICAResponse>

3.3.5.1. Detalhamentodosparmetrosdeentrada
<Login>
TagquereceberasinformaesdelogindoWebService
<CodigoUsuario>XXX...</CodigoUsuario>(Caracter64)
CdigodousurioquetemapermissoparaEmisso/CancelamentodeNFSe
Para obter o cdigo, o usurio deveconsutar ocampocdigona opo de edio do
seuperfil
Obrigatrio
<CodigoContribuinte>XXX...</CodigoContribuinte>(Caracter64)
CdigodoContribuintedoRPS
Para obter o cdigo, o usurio deve consutar o campo cdigo na opo da consulta
docontribuinte
Obrigatrio
<Nota>
Tagquereceberasinformaesdanotaasercancelada
<SerieNota>(Caracter5)
Recebeasriedanotaeletrnicaasercancelada
ObrigatrioseinformaronmerodanotaousenoinformaronrodoRPS
<NumeroNota>(Numrico9)
Recebeonmerodanotaasercancelada
ObrigatrioseinformarasriedanotaousenoinformaronrodoRPS
<SerieRPS>(Caracter5)
RecebeasriedoRPSasercancelado
No obrigatrio, mas se o RPS que deseja cancelar possui uma srie ento
necessrioinformar.
<NumeroRps>(Numrico9)
RecebeonmerodoRPSasercancelado
ObrigatrioseinformarasriedoRPSousenofoiinformadoonmerodanota
<ValorNota>(Decimal18,2)
Valordanotaasercancelada
Obrigatrio
<MotivoCancelamento>(Caracter100)
Motivodocancelamento
Obrigatrio
<PodeCancelarGuia>(Caracter1)
Identificadorparainformarsepodeounocancelaraguiaassociada
Quando marcado como S, o usurio tem que estar autorizado para a funo de
cancelamentodeguia
Obrigatrioeseroaceitos(S/N)

3.3.5.2. DetalhamentodosparmetrosdeSada
<Retorno>
0Houveproblemasnocancelamento
1Cancelamentoefetuadocomsucesso
<Messages>

Tagqueretornarasmensagensderetornodocancelamento
<Message>
Composiodamensagem
<Id>
Retornar um cdigo ou uma string com uma informaoidentificadora doerro
queocorreu
<Description>
Retornaramensagemdoerroouobservao

Setembro/2014EquipeNFSe