22
Detalhes e especificações do WebService Nota Fiscal Eletrônica 1. Introdução Este manual tem como objetivo apresentar a definição das especificações e critérios técnicos necessários para utilização do Web Service para as empresas autorizadas a emitir nota fiscal eletrônica. Por meio do Web Service as empresas poderão integrar seus próprios sistemas de informações com o Sistema de Notas Fiscais Eletrônicas. Desta forma, conseguese automatizar o processo de emissão e consulta de NFe. 2. Interfaces disponíveis Através do Web Service, disponibiliza uma série de interfaces que poderão ser acessadas pelos sistemas dos contribuintes. A seguir, estão resumidas as interfaces disponíveis e suas respectivas funcionalidades básicas. 2.1. Envio de lote de RPS Através desta interface, os prestadores de serviços poderão enviar lotes de RPS emitidos por seus sistemas para que sejam substituídos por Notas Fiscais Eletrônicas. 2.2. Consulta de lote de RPS Após o envio bem sucedido de um Lote de RPS, informando o número do Protocolo gerado o Web Service retorna todas as NFe geradas neste lote. 2.3. Consulta de Protocolo de RPS Após o envio bem sucedido de um Lote de RPS, informando o número do Protocolo gerado o Web Service retorna as informações relativas ao processamento do protocolo. 2.4. Validação de lote de RPS Através desta interface, os prestadores de serviços poderão enviar lotes de RPS emitidos por seus sistemas em ambientes de teste para que sejam feitas as validações do RPS 3. Especificações 3.1. Endereço do WebService 3.1.1. Homologação: https://nfehomologacao.etransparencia.com.br/<prefeitura>/webservice/aws_nfe.aspx?wsdl 3.2. Métodos 3.2.1. PROCESSARPS (Envio de lote de RPS) <** Method **> void PROCESSARPS( in Sdt_ProcessarpsIn Sdt_processarpsin in/out Sdt_ProcessarpsOut Sdt_processarpsout ) <**Operation info**> 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 Request element = ws_nfe.PROCESSARPS Request namespace = NFe Response element = ws_nfe.PROCESSARPSResponse Response namespace = NFe <**Schema types referenced**> 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 NFe:Sdt_ProcessarpsOut NFe:Sdt_ProcessarpsOut.Message

webservicenfe (1)

Embed Size (px)

Citation preview

  • DetalheseespecificaesdoWebServiceNotaFiscalEletrnica

    1. IntroduoEste manual tem como objetivo apresentar a definio das especificaes e critrios tcnicos necessrios para utilizaodoWebServiceparaasempresasautorizadasaemitirnotafiscaleletrnica.Por meio do Web Service as empresas podero integrar seus prprios sistemas de informaes com o Sistema de Notas Fiscais Eletrnicas. Desta forma, conseguese automatizar o processo de emisso e consulta de NFe.

    2. InterfacesdisponveisAtravs do Web Service, disponibiliza uma srie de interfaces que podero ser acessadas pelos sistemas dos

    contribuintes.Aseguir,estoresumidasasinterfacesdisponveisesuasrespectivasfuncionalidadesbsicas.

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

    paraquesejamsubstitudosporNotasFiscaisEletrnicas.

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

    retornatodasasNFegeradasnestelote.

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

    retornaasinformaesrelativasaoprocessamentodoprotocolo.

    2.4. ValidaodelotedeRPSAtravs desta interface, os prestadores de servios podero enviar lotes de RPS emitidos por seus sistemas em

    ambientesdetesteparaquesejamfeitasasvalidaesdoRPS

    3. Especificaes3.1. EndereodoWebService

    3.1.1.Homologao:https://nfehomologacao.etransparencia.com.br//webservice/aws_nfe.aspx?wsdl

    3.2. Mtodos3.2.1. PROCESSARPS(EnviodelotedeRPS)

    voidPROCESSARPS(inSdt_ProcessarpsInSdt_processarpsinin/outSdt_ProcessarpsOutSdt_processarpsout)

    Address=https://nfehomologacao.etransparencia.com.br//webservice/aws_nfe.aspxAction=NFeaction/AWS_NFE.PROCESSARPSBinding=ws_nfeSoapBindingProtocol=SOAPStyle=DocumentUse=LiteralRequestelement=ws_nfe.PROCESSARPSRequestnamespace=NFeResponseelement=ws_nfe.PROCESSARPSResponseResponsenamespace=NFe

    NFe:Sdt_ProcessarpsInNFe:Sdt_ProcessarpsIn.LoginNFe:Sdt_ProcessarpsIn.SDTRPSNFe:Sdt_ProcessarpsIn.SDTRPS.Reg20ItemNFe:Sdt_ProcessarpsIn.SDTRPS.Reg20Item.Reg30ItemNFe:Sdt_ProcessarpsIn.SDTRPS.Reg90NFe:Sdt_ProcessarpsOutNFe:Sdt_ProcessarpsOut.Message

  • Mtodo:ws_nfe.PROCESSARPS

    stringstring

    stringstringstringstringstringstringstringstringstring

    stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring

    stringstringstring

    stringstringstring

    stringstringstringstringstring

  • stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring

    stringstringstring

    stringstringstring

    stringstringstringstringstringstringstring

    booleanstring

    stringbytestringint

    stringbytestringint

  • Mtodo:ws_nfe.PROCESSARPSResponse

    booleanstring

    stringbytestringint

    stringbytestringint

    3.2.1.1. Detalhamentodosparmetrosdeentrada3.2.1.1.1.

    TagquereceberasinformaesdelogindoWebService3.2.1.1.1.1. XXX...(Caracter64)

    CdigodoUsurioquetemapermissoparaemisso/ConsultadeNFEParaobterocdigo,ousuriodeveconsutarocampocdigonaopodeediodoseuperfil

    3.2.1.1.1.2. XXX...(Caracter64)CdigodoContribuintedoRPS

    3.2.1.1.2. LayoutdoRPSOarquivoapresentaumaestruturaderegistrosquedeveserenviadaconformeapresentaoabaixo:1. Declaraodenamespace

    Todasasestruturasdeveternocabealhoessexmlns="NFe"

    2. Cabealho NNNN(Numrico4,0)

    AnodasnotasenviadasNN(Numrico2,0)

    Msdasnotasenviadas NNNNNNNNNNNNNN(Numrico14,0)

    CPF/CNPJdoPrestadorRegras:

    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.

    dd/mm/aaaa(Data)MenordatadeemissodasNFstransmitidas.Regras:

    DeveserMenorouigualaDatadeInciodoPerodotransferido. dd/mm/aaaa(Data)

    MaiordatadeemissodasNFstransmitidas.Regras:

    DeveserMaiorouigualaDatadeInciodoPeriodotransferido. N(Numrico1,0)

    TipodetributaodoprestadorRegras:

    Podeterosseguintescontedos: 1 Tributado. O Servio tributado de acordo com a alquota do 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. dd/mm/aaaa(Data)

    DatadeAdesoaosimplesnacional.Regras:

    Deverterosseguintescontedos: CampoobrigatrioseTipoTrib=4 Caso contrrio o campo no deve ser informado ou enviada a TAG

    NNN,NN(Numrico5,2)

    AlquotadeISS(SimplesNacional,IsenoParcial).Regras:

    Deverterosseguintescontedos: Se o campo TipoPrib 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

    . 2.00(Caracter4)

    VersodoLayoutRegras:

    Preenchercom2.00

    3. RegistroondedeveroserenviadososcomasnotasdoRPSRegras:

    ObrigatrioComposio:

    soositenscontendoasnotasComposio: XXX(Caracter3)

    TipodeNFSRegras:

    Preenchercom'RPS'/'RPC'. RPCindicaqueoRPSinformadofoicancelado

    NNNNNNNNN (Numrico9,0)NmerodoReciboprovisriodeserviosRegras:

    Campo sequencial que no pode ser repetido e deve ser informado nasequnciaporsrie.Indicadordodocumentoprovisrio.

    XXX(Caracter3)SriedoRPS

    dd/mm/aaaa (Data)DatadeemissodoreciboRegras:

    DataInformadadevepertenceraoperodoinformado XXX(Caracter3)

  • Indica se o imposto foi retido no municpio do tomador de servios,ounomunicpiodoprestador.Regras:

    InformarocontedofixoigualaSIMouNAO. NN.NN(Caracter10)

    CdigodoServioRegras:

    Conforme lista de servios do municpio. Inclui pontuao se necessrio. O cdigo do servio deve fazer parte da lista de serviosdeclaradospeloprestador.

    XXX.....(Caracter4000)DiscriminaodanaturezadoservioprestadoRegras:

    Alm da discriminao dos servios, os dados de frete,caso tenha, devero ser digitados neste campo. O \\ representa o retorno de linha e assim ser considerado na impresso da nota gerada

    NNNNNNNNNNNNN,NN(Numrico16,2)ValordaNotaFiscalRegras:

    Usaravrgulacomoseparadordecimal. NNNNNNNNNNNNN,NN(Numrico16,2)

    Valor a ser deduzido do valor da nota para obteno da base declculodoimposto.Regras:

    NopodeserMaiorqueovalordaNotaFiscal Usaravrgulacomoseparadordecimal.

    XXXXX......(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 retorno de linha e assim ser considerado na impressodanotagerada.

    NNNNNNNNNNNNN,NN(Numrico16,2)BasedeclculoRegras:

    Deve ser igual ao informado no campo valor da nota menos o informadonocampodevalordededuo.

    Usaravrgulacomoseparadordecimal. NNN,NN(Numrico5,2)

    PercentualdealquotadeISSRegras:

    Deve estar de acordo com Tabela de servios ou adeso do simplesnacionaldoPrestadordeservios.

    Usaravrgulacomoseparadordecimal. NNNNNNNNNNNNN,NN(Numrico16,2)

    ValordoImpostoCalculadoRegras:

    Obrigatriose='NAO' Valoriguala0(zero)se='SIM Usaravrgulacomoseparadordecimal.

    NNN,NN(Numrico16,2)ValordoISSRetidopeloTomadorRegras:

  • Obrigatriose='SIM' Valoriguala0(zero)se='NAO' Usaravrgulacomoseparadordecimal.

    NNNNNNNNNNNNNN(Numrico14,0)CPF/CNPJdoTomadordeservioRegras:

    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.

    XXXX....(Caracter60)RazoSocialouNomedotomadorRegras:

    ObrigatrioseTomadorPessoaFsicaoujurdica. Permiteinformarrazosocialparatomadordoexterior.

    XXXX...(Caracter10)TipodoLogradouroTomadorRegras:

    Informarsegundoatabelaquesegue: RUA AVENIDA PRAA ALAMEDA.

    ObrigatrioseTomadorPessoafsicaoujurdica. XXXX...(Caracter60)

    LogradourodoTomadorRegras:

    ObrigatriosomenteseTomadorPessoafsicaoujurdica. Poder ser informado um endereo para tomador do exterior. Se

    for informado, os demais dados do endereo sero obrigatrios, comobairro,numero,etc...

    XXXX...(Caracter10)NmerodoEndereodoLogradourodoTomadorRegras:

    ObrigatrioseTomadorPessoafsicaoujurdica. Obrigatriosefoiinformadoparatomadordoexterior.

    XXX...(Caracter60)ComplementodoEndereodoTomador

    XXXX....(Caracter60)BairrodoTomadorRegras:

    ObrigatrioseTomadorPessoafsicaoujurdica. Obrigatriosefoiinformadoparatomadordoexterior.

    XXXXX...(Caracter60)NomedoMunicpiodoTomadorRegras:

    InformarEXTERIORparaoperaescomoexterior. Informar o municpio do prestador quando tomador Consumidor

    Final XX(Caracter2)

    SigladoestadodoTomadorRegras:

    InformarEXparaoperaescomoexterior. InformaraUFdoPrestadorquandootomadorConsumidorFinal.

    NNNNNNNN(Numrico8,0)CEPdoTomador

  • Regras: Se = 'EX' ou se o Tomador Consumidor Final,

    campodoCEPdevevirzerado NNNNNNNNNN(Numrico10,0)

    TelefonedoTomadorRegras:

    Informaroszerosnosignificativos. Preencherapenascomnmeros,semseparadores. NoinformarquandoTomadorConsumidorFinal

    XXXXX....(Caracter20)InscrioMunicipalRegras:

    SeTomadorPessoajurdica,InscrioMunicipalobrigatria. No Informar quando Tomador Consumidor Final ou Pessoa do

    Exterior. XXX...(Caracter10)

    TipodoLogradourodolocaldePrestaodeServiosRegras:

    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. XXXXX...(Caracter60)

    LogradourodoLocaldePrestaodeServiosRegras:

    Obrigatrio Somente se o campo foi informado. Poder ser informado endereo de prestao no exterior tambm. NestecasoaUFdeveserigualaEXeomunicpio=EXTERIOR.

    XXXXX....(Caracter10)NmerodoEndereodoLocaldePrestaodeServiosRegras:

    ObrigatrioSomenteseocampofoiinformado XXXXX.....(Caracter60)

    ComplementodoEndereodoLocaldePrestaodeServios XXXXX.....(Caracter60)

    BairrodoLocaldePrestaodeServiosRegras:

    ObrigatrioSomenteseocampofoiinformado XXXXX.....(Caracter60)

    NomedoMunicpiodoLocaldePrestaodeServiosRegras:

    Obrigatrio Somente se o campo foi informado. InformarEXTERIORparaserviosprestadosnoExterior.

    XX(Caracter2)SigladoEstadodoLocaldePrestaodeServiosRegras:

    Obrigatrio Somente se o campo foi informado. InformarEXparaoperaescomoexterior

    NNNNNNNN(Numrico8,0)CdigodoCEPdoLocaldePrestaodeServiosRegras:

    Obrigatriosomenteseocampofoiinformado. Se='EX'campodoCEPdevevirzerado.

    [email protected](Caracter120)

  • EmaildoTomadorparaEnviodaNFERegras:

    Quando o Tomador pessoa Externa ou consumidor final, o campo poder ser usado como um endereo de Email para envio daNFE.

    [email protected](Caracter120)EmailparaEnviodaNFERegras:

    Deve ser diferente do campo e s deve ser informado se anotadeveserenviadaparamaisdeumendereodeemail

    [email protected](Caracter120)EmailparaEnviodaNFERegras:

    Deve ser diferente dos campos e e s deve ser informado se a nota deve ser enviada para mais de um endereo deemail

    Contm os tributos municipais, Estaduais e Federais que devem ser destacadosnanotafiscaleletrnicaimpressa.Regras:

    NoObrigatrio Para cada registro que consta no arquivo XML, o

    contribuinte pode enviar dezeroaNregistros do tipo

    No so aceitos registros sem os registros do tipo correspondentes.

    SoostributosdeclaradosdoRegras: Siglasdetributospermitidas:

    COFINS CSLL INSS IR ISS Informar apenas o ISS quando retido para obter

    ovalorlquidodanota. PIS

    Composio: XXXXXXXXXX(Caracter10)

    SigladoTributo NNN,NN(Numrico5,2)

    PercentualdoTributoRegras:

    Estarnalistadetributosdomuncipio NNNNNNNNNN,NN(Numrico

    10,2)ValordoTributo

    4. RepresentaumalinhaderodapdevalidaodevaloresenviadosnasnotasRegras:

    ObrigatrioComposio

    NNNNN(Numrico5,0)Qtd.Deregistrostipo

    NNNNNNNNNNNNN,NN(Numrico16,2)Valortotaldanotasinformadasnoregistrotipo

  • Regras: Usaravrgulacomoseparadordecimal.

    NNNNNNNNNNNNN,NN(Numrico16,2)ValortotaldoISSdeNotasinformadasnoregistrotipoRegras:

    Usaravrgulacomoseparadordecimal. NNNNNNNNNNNNN,NN(Numrico16,2)

    ValortotaldocampoDeduoinformadasnoregistrotipoRegras:

    Usaravrgulacomoseparadordecimal. NNNNNNNNNNNNN,NN

    (Numrico16,2)ValorTotaldoISSRetidopeloTomadorinformadasnoregistrotipo

    Regras:

    Usaravrgulacomoseparadordecimal. NNNNN(Numrico5,0)

    QuantidadedeRegistrostipo NNNNNNNNNNNNN,NN(Numrico16,2)

    ValortotaldostributosenviadosnoregistroRegras:

    Usaravrgulacomoseparadordecimal..

    3.2.1.1.3. ExemplodeXML(utilizandodadosinvlidos):

    xxxxxxxxxx

    NNNNNNNNNNNNNNNNNNNNdd/mm/aaaadd/mm/aaaaNdd/mm/aaaaNNN,NN2.00

    XXX999999999XXXdd/mm/aaaaNAONN.NNDESCRICAO1000,000,00DESCRICAO1000,001,0010,000,00NNNNNNNNNNNNNNXXXXX....RUAXXXXX...XXX...XXXX...XXXXX...XXXXX...XX

  • NNNNNNNNNNNNNNNNNNXXXXXXXXXXXXXXXXXXXXXXXXXXX...XXXXX..XXXXX...XXXXX...XXXXX...XXNNNNNNNNemail1@email1.com

    INSS1,000,10

    11000,0010,000,000,0010,10

    3.2.1.2. Detalhamentodosparmetrosdesada3.2.1.2.1. Retorno(Boolean)

    3.2.1.2.1.1. TrueEstruturafoienviadacorretamenteefoigeradoumprotocolodeprocessamento.

    3.2.1.2.1.2. FalseEstruturanofoienviadacorretamenteenogeradoprotocolo.

    3.2.1.2.2. XXX...(Caracter20)CdigodoprotocolodeenviodoRPS

    3.2.1.2.3. Messages(Collection)ColeocomasmensagensdoprocessamentodoRPS3.2.1.2.3.1. ID(Varchar128)

    Identificadordoerro3.2.1.2.3.2. Type(Numrico2,0)

    Tipodeerro3.2.1.2.3.3. Description(Varchar300)

    Descritivodoerro3.2.1.2.3.4. LinErr(Numrico5,0)

    LinhaqueocorreuoerronoXML

    3.2.2.CONSULTANOTASPROTOCOLO(ConsultadelotedeRPS)

    SDT_ConsultaNotasProtocoloOutCONSULTANOTASPROTOCOLO(

  • inSDT_ConsultaNotasProtocoloInSdt_consultanotasprotocoloin)

    Address=https://nfehomologacao.etransparencia.com.br//webservice/aws_nfe.aspxAction=NFeaction/AWS_NFE.CONSULTANOTASPROTOCOLOBinding=ws_nfeSoapBindingProtocol=SOAPStyle=DocumentUse=LiteralRequestelement=ws_nfe.CONSULTANOTASPROTOCOLORequestnamespace=NFeResponseelement=ws_nfe.CONSULTANOTASPROTOCOLOResponseResponsenamespace=NFe

    NFe:SDT_ConsultaNotasProtocoloOutNFe:SDT_ConsultaNotasProtocoloOut.MessageNFe:SDT_ConsultaNotasProtocoloOut.XML_NotasNFe:SDT_ConsultaNotasProtocoloOut.XML_Notas.Reg20ItemNFe:SDT_ConsultaNotasProtocoloOut.XML_Notas.Reg20Item.Reg30ItemNFe:SDT_ConsultaNotasProtocoloOut.XML_Notas.Reg90NFe:SDT_ConsultaNotasProtocoloInNFe:SDT_ConsultaNotasProtocoloIn.Login

    Mtodo:ws_nfe.CONSULTANOTASPROTOCOLO

    string

    stringstring

    Mtodo:ws_nfe.CONSULTANOTASPROTOCOLOResponse

    boolean

    stringbytestringint

    stringbytestringint

    stringdatedateshortstring

    stringintstringstringstringstringintstringstringstringstringstringstringstringstring

  • stringstringstringintstringstringstringdoublebytestringstringstringstringstringstringstringstringstringstringstringintstringstringstringstringstringstringstringintstringstringdoubledoublestringdoubledoubledoubledouble

    stringdoubledouble

    stringdoubledouble

    stringintstringstringstringstringintstringstringstringstringstringstringstringstringstringstringstringintstringstringstringdoublebytestringstringstring

  • stringstringstringstringstringstringstringstringintstringstringstringstringstringstringstringintstringstringdoubledoublestringdoubledoubledoubledouble

    stringdoubledouble

    stringdoubledouble

    intdoubledoubledoubledoubleintdouble

    3.2.2.1. Detalhamentodosparmetrosdeentrada3.2.2.1.1. XXX...(Caracter20)

    CdigodoprotocolodeenviodoRPS3.2.2.1.2.

    TagquereceberasinformaesdelogindoWebService3.2.2.1.2.1. XXX...(Caracter64)

    CdigodoUsurioquetemapermissoparaemisso/ConsultadeNFEParaobterocdigo,ousuriodeveconsutarocampocdigonaopodeediodoseuperfil

    3.2.2.1.2.2. XXX...(Caracter64)CdigodoContribuintedoRPS

    3.2.2.2. DetalhamentodosparmetrosdeSada3.2.2.2.1. Retorno(Boolean)

    3.2.2.2.1.1. TrueEstruturafoienviadacorretamenteefoigeradoumprotocolodeprocessamento.

    3.2.2.2.1.2. FalseEstruturanofoienviadacorretamenteenogeradoprotocolo.

  • 3.2.2.2.2. Messages(Collection)ColeocomasmensagensdoprocessamentodoRPS3.2.2.2.2.1. ID(Varchar128)

    Identificadordoerro3.2.2.2.2.2. Type(Numrico2,0)

    Tipodeerro3.2.2.2.2.3. Description(Varchar300)

    Descritivodoerro3.2.2.2.2.4. LinErr(Numrico5,0)

    LinhaqueocorreuoerronoXML

    3.2.2.2.3. NNNNNNNNNNNNNN(Numrico14,0)

    CPF/CNPJdoPrestador dd/mm/aaaa(Data)

    MenordatadeemissodasNFstransmitidas. dd/mm/aaaa(Data)

    MaiordatadeemissodasNFstransmitidas. N(Numrico1,0)

    Tipodetributaodoprestador 2.00(Caracter4)

    VersodoLayout

    ondedeveroserenviadososcomasnotasdoRPSComposio:

    soositenscontendoasnotasComposio:

    X(Caracter1)TipodeNFS

    XXX(Numrico9)NmerodaNotaFiscal

    XXX(Caracter3)SriedaNotaFiscal

    dd/mm/aaaa(Varchar10)Datadeemissodanotafiscal

    dd/mm/aaaahh:mm:ss(Varchar10)Datadegeraodanotafiscal

    XXX(Caracter3)SriedaNotaFiscal

    NNNNNNNNN (Numrico9,0)NmerodoReciboprovisriodeservios

    XXX(Caracter3)SriedoRPS

    dd/mm/aaaa (Varchar10)Datadeemissodorecibo

    X(Caracter1)TipodeCpf/Cnpj(Prestadordeservio)

    XXX...(Varchar20)Cpf/Cnpj(Prestadordeservio)

    XXX...(Varchar60)RazoSocialouNome(Prestadordeservio)

    XXX...(Varchar70)Logradouro(Prestadordeservio)

    XXX...(Varchar10)NmerodoEndereodoLogradouro(Prestadordeservio)

    XXX...(Varchar60)

  • ComplementodoEndereco(Prestadordeservio) XXX...(Varchar60)

    Bairro(Prestadordeservio) XXX...(Varchar60)

    Municpio(Prestadordeservio) XX(Caracter2)

    UF(Prestadordeservio) NNNNNNNN(Numrico8,0)

    CEP(Prestadordeservio) XXX...(Varchar120)

    Email(Prestadordeservio) xx(Caracter2)

    Tipodetributao(Prestadordeservio) dd/mm/aaaa(Varchar10)

    DatadeadesoSimplesNAcional NN,NN(Numrico5,2)

    AlquotaSimplesNacional N(Numrico1,0)

    SituaodaNotaFiscal dd/mm/aaaa(Varchar10)

    DatadocancelamentodaNotafiscal XXX...(Varchar100)

    Motivodocancelamento X(Caracter1)

    TipoCPF/CNPJ(Tomador) XXX....(Varchar20)

    CPF/CNPJ(Tomador) XXX...(Varchar60)

    Razosocial(Tomador) XXX...(Varchar70)

    Logradouro(Tomador) XXX...(Varchar10)

    Nmerologradouro(Tomador) XXX...(Varchar60)

    Complemento(Tomador) XXX...(Varchar60)

    Bairro(Tomador) XXX...(Varchar60)

    Municpio(Tomador) XX(Caracter2)

    UF(Tomador) NNNNNNNN(Numrico8,0)

    CEP(Tomador) XXX...(Varchar120)

    Email(Tomador) XXX...(Varchar70)

    Logradouro(Localdeprestao) XXX...(Varchar10)

    NmerodoLogradouro(Localdeprestao) XXX...(Varchar60)

    Complemento(Localdeprestao) XXX...(Varchar60)

    Bairro(Localdeprestao) XXX...(Varchar60)

    Municpio(Localdeprestao) XX(Caracter2)

    UF(Localdeprestao) NNNNNNNJN(Numrico8,0)

    CEP(Localdeprestao) XXXXXXXXXX(Caracter10)

    CdigodoServio XXX...(Varchar4000)

  • Discriminaodoservio NNNNNNNNNNNNNNN,NN(Numrico16,2)

    ValordaNota NNNNNNNNNNNNNNN,NN(Numrico16,2)

    Valordadeduo XXX...(Varchar1000)

    Discriminaodadeduo NN,NN(Numrico16,2)

    Valordabasedeclculo NNNNNNNNNNNNNNN,NN(Numrico5,2)

    AlquotaISS NNNNNNNNNNNNNNN,NN(Numrico16,2)

    ValordoISS NNNNNNNNNNNNNNN,NN(Numrico16,2)

    ValordoISSretido

    Contm os tributos municipais, Estaduais e Federais que devem ser destacadosnanotafiscaleletrnicaimpressa.

    SoostributosdoComposio:

    XXXXXXXXXX(Caracter10)SigladoTributo

    NNN,NN(Numrico5,2)PercentualdoTributo

    NNNNNNNNNN,NN(Numrico10,2)

    ValordoTributo

    Representaumalinhaderodapdevalidaodevaloresenviadosnasnotas

    Composio NNNNN(Numrico5,0)

    Qtd.Deregistrostipo NNNNNNNNNNNNN,NN(Numrico16,2)

    Valortotaldanotasinformadasnoregistrotipo NNNNNNNNNNNNN,NN(Numrico16,2)

    ValortotaldoISSdeNotasinformadasnoregistrotipo NNNNNNNNNNNNN,NN(Numrico16,2)

    ValortotaldocampoDeduoinformadasnoregistrotipo NNNNNNNNNNNNN,NN

    (Numrico16,2)ValorTotaldoISSRetidopeloTomadorinformadasnoregistrotipo

    NNNNN(Numrico5,0)QuantidadedeRegistrostipo

    NNNNNNNNNNNNN,NN(Numrico16,2)Valortotaldostributosenviadosnoregistro

    3.2.3.CONSULTAPROTOCOLO(ConsultadeProtocolodeRPS)

    SDT_ConsultaProtocoloOutCONSULTAPROTOCOLO(inSDT_ConsultaProtocoloInSdt_consultaprotocoloin)

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

    Action=NFeaction/AWS_NFE.CONSULTAPROTOCOLOBinding=ws_nfeSoapBindingProtocol=SOAPStyle=DocumentUse=Literal

  • Requestelement=ws_nfe.CONSULTAPROTOCOLORequestnamespace=NFeResponseelement=ws_nfe.CONSULTAPROTOCOLOResponseResponsenamespace=NFe

    NFe:SDT_ConsultaProtocoloOutNFe:SDT_ConsultaProtocoloOut.MessageNFe:SDT_ConsultaProtocoloInNFe:SDT_ConsultaProtocoloIn.Login

    ns0=NFe

    Mtodo:ws_nfe.CONSULTAPROTOCOLO

    string

    stringstring

    Mtodo:ws_nfe.CONSULTAPROTOCOLOResponse

    booleanbytestringlonglongdateTimedateTimeintint

    stringbytestringint

    stringbytestringint

    3.2.3.1. Detalhamentodosparmetrosdeentrada3.2.3.1.1. XXX...(Caracter20)

    CdigodoprotocolodeenviodoRPS3.2.3.1.2.

    TagquereceberasinformaesdelogindoWebService3.2.3.1.2.1. XXX...(Caracter64)

    CdigodoUsurioquetemapermissoparaemisso/ConsultadeNFEParaobterocdigo,ousuriodeveconsutarocampocdigonaopodeediodoseuperfil

    3.2.3.1.2.2. XXX...(Caracter64)CdigodoContribuintedoRPS

    3.2.3.2. DetalhamentodosparmetrosdeSada3.2.3.2.1. Retorno(Boolean)

    3.2.3.2.1.1. TrueEstruturafoienviadacorretamenteefoigeradoumprotocolodeprocessamento.

    3.2.3.2.1.2. False

  • Estruturanofoienviadacorretamenteenogeradoprotocolo.3.2.3.2.2. PrtXSts(Numrico1,0)

    3.2.3.2.2.1. 1(Aguardandoprocessamento)3.2.3.2.2.2. 2(EmProcessamento)3.2.3.2.2.3. 3(Rejeitado)3.2.3.2.2.4. 4(RejeitadoParcialmente)3.2.3.2.2.5. 5(Processado)

    3.2.3.2.3. PrtCSerRps(Caracter5)SriedoRPS

    3.2.3.2.4. PrtCRps_1(Numrico18,0)NmerodoprimeiroRPSprocessadoouaprocessar.

    3.2.3.2.5. PrtCRps_2(Numrico18,0)NmerodoprimeiroRPSprocessadoouaprocessar.

    3.2.3.2.6. PrtLPrcIni(Data/Hora)Data/HoradoIniciodoprocessamento

    3.2.3.2.7. PrtLFinGrv(Data/Hora)Data/HoradoFinaldoprocessamento

    3.2.3.2.8. PnfCNfe_1(Numrico9,0)Nmerodaprimeiranotaprocessada

    3.2.3.2.9. PnfCnfe_2(Numrico9,0)Nmerodaltimanotaprocessada

    3.2.3.2.10. Messages(Collection)ColeocomasmensagensdoprocessamentodoRPS3.2.3.2.10.1. ID(Varchar128)

    Identificadordoerro3.2.3.2.10.2. Type(Numrico2,0)

    Tipodeerro3.2.3.2.10.3. Description(Varchar300)

    Descritivodoerro3.2.3.2.10.4. LinErr(Numrico5,0)

    LinhaqueocorreuoerronoXML

    3.2.4.VERFICARPS(ValidaodelotedeRPS)Utiliza a mesma estrutura do servio do mtodo PROCESSARPS , com as mesmas sadas retornando se aestruturadoRPSestvalidaouno.CasoaestruturanoestejavlidaoMtodoretornaasmensagensdeerro.Esse mtodo no gera protocolo e no gravado no sistema, servindo somente para validao de estrutura.

    Sdt_ProcessarpsOutVERFICARPS(inSdt_ProcessarpsInSdt_processarpsin)

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

    Action=NFeaction/AWS_NFE.VERFICARPSBinding=ws_nfeSoapBindingProtocol=SOAPStyle=DocumentUse=LiteralRequestelement=ws_nfe.VERFICARPSRequestnamespace=NFeResponseelement=ws_nfe.VERFICARPSResponseResponsenamespace=NFe

    NFe:Sdt_ProcessarpsOutNFe:Sdt_ProcessarpsOut.MessageNFe:Sdt_ProcessarpsIn

  • NFe:Sdt_ProcessarpsIn.LoginNFe:Sdt_ProcessarpsIn.SDTRPSNFe:Sdt_ProcessarpsIn.SDTRPS.Reg20ItemNFe:Sdt_ProcessarpsIn.SDTRPS.Reg20Item.Reg30ItemNFe:Sdt_ProcessarpsIn.SDTRPS.Reg90

    ns0=NFe

    Mtodo:ws_nfe.VERFICARPS

    stringstring

    stringstringstringstringstringstringstringstringstring

    stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring

    stringstringstring

    stringstringstring

  • stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring

    stringstringstring

    stringstringstring

    stringstringstringstringstringstringstring

    Mtodo:ws_nfe.VERFICARPSResponse

    booleanstring

    stringbytestringint

  • stringbytestringint