{"id":250,"date":"2015-12-30T12:01:31","date_gmt":"2015-12-30T15:01:31","guid":{"rendered":"http:\/\/www.l2maker.com.br\/documentacao\/?p=250"},"modified":"2024-11-19T07:42:46","modified_gmt":"2024-11-19T10:42:46","slug":"nfs-e-emissao","status":"publish","type":"post","link":"https:\/\/www.l2maker.com.br\/documentacao\/2015\/12\/nfs-e-emissao\/","title":{"rendered":"NFS-e – Instru\u00e7\u00f5es de emiss\u00e3o de NFS-e"},"content":{"rendered":"

A API de NFS-e \u00e9 utilizada principalmente para emiss\u00e3o e cancelamento\u00a0(se suportado pela prefeitura) de notas ficais de servi\u00e7os, outras rotinas podem estar dispon\u00edveis.<\/p>\n

Passos para emiss\u00e3o da NFS-e<\/h1>\n

Resumidamente a emiss\u00e3o da NFS-e segue os seguintes passos:<\/p>\n

    \n
  1. Envio do Lote de RPS ou RPS individual para a prefeitura;<\/li>\n
  2. Consulta a situa\u00e7\u00e3o do lote ou RPS;<\/li>\n
  3. Obter os detalhes da(s) NFS-e gerada(s), ou do(s) erro(s) cr\u00edtica(s) retornados pelo servidor da prefeitura.<\/li>\n<\/ol>\n

    IMPORTANTE: Cada prefeitura tem total autonomia para implementar seus sistemas de emiss\u00e3o de NFS-e, apesar de existirem “padr\u00f5es” muitas tem suas particularidades. \u00c9 importante est\u00e1 familiarizado com os detalhes de cada cidade.<\/p>\n

    Enviando a nota fiscal para o servidor<\/h2>\n
      \n
    1. O primeiro passo \u00e9 obter um conector, podendo ser com ou sem certificado e\/ou senha, cada cidade tem seu padr\u00e3o;<\/li>\n
    2. Ap\u00f3s criar um conector definimos o nome e CNPJ padr\u00e3o do emissor usando a fun\u00e7\u00e3o “NFS-e: Definir o nome e documento do prestador<\/strong>“, passe o CNPJ somente com n\u00fameros, se tra\u00e7os ou pontos;<\/li>\n
    3. Em seguida criamos um novo lote (“NFS-e: Criar novo lote<\/strong>“), passando:\n
        \n
      1. Conector – (Variante) vari\u00e1vel retornada pela fun\u00e7\u00e3o de criar conector;<\/li>\n
      2. N\u00famero do Lote – (Inteiro ou Letras) Corresponde a um n\u00famero sequencial de envios de lotes para o servidor. Provavelmente, se tinha um sistema anterior ser\u00e1 necess\u00e1rio continuar a sequencia de envios, mas nesses casos (normalmente) uma mensagem de erro indica qual ser\u00e1 o pr\u00f3ximo.<\/span><\/li>\n<\/ol>\n<\/li>\n
      3. Dentro de um Lote pode existir um ou mais RPS (de acordo com as especifica\u00e7\u00f5es da prefeitura, preferencialmente envie uma por lote), para se criar um RPS dentro do lote ser\u00e1 utilizada a fun\u00e7\u00e3o “NFS-e: Novo RPS<\/strong>“, passando:\n
          \n
        1. O\u00a0Lote (retorno da fun\u00e7\u00e3o anterior) e o n\u00famero do RPS;<\/li>\n
        2. N\u00famero do RPS – N\u00famero sequencial de gera\u00e7\u00e3o de RPS, a faixa a ser utilizada deve ser consultada junto \u00e0 prefeitura;<\/li>\n
        3. S\u00e9rie: (Letras) – Verificar junto \u00e0 prefeitura.<\/li>\n
        4. Tipo (Inteiro): “1” para NFS-e<\/li>\n<\/ol>\n<\/li>\n
        5. Utilizar a fun\u00e7\u00e3o “NFS-e: RPS definir dados b\u00e1sicos<\/strong>” para definir alguns detalhes de tributa\u00e7\u00e3o. \u00c9 importante informar corretamente se \u00e9 do SIMPLES ou n\u00e3o. Al\u00e9m de regimes diferenciados de tributa\u00e7\u00e3o (se houver).\n
            \n
          • Par\u00e2metro 2: Data e hora de emiss\u00e3o da NFS-e. Importante, observe se a hora do Webrun est\u00e1 correta para evitar problemas com o hor\u00e1rio do servidor da prefeitura. Muitos validam a hora. O mesmo vale pra o hor\u00e1rio de ver\u00e3o.<\/li>\n
          • Par\u00e2metro 4: Regime especial da tributa\u00e7\u00e3o (Inteiro) \u00a0– Informar se houver, observar os valores aceitos no manual da prefeitura.<\/li>\n
          • Par\u00e2metro 7: Situa\u00e7\u00e3o – Usar 1 para Normal ou 2 para Cancelado.<\/li>\n<\/ul>\n<\/li>\n
          • OPCIONAL:<\/strong> Se a nota for emitida em substitui\u00e7\u00e3o de outra NFS-e voc\u00ea deve utilizar a fun\u00e7\u00e3o “NFS-e: RPS definir RPS substitu\u00eddo<\/strong>” passando os dados da nota substitu\u00edda.<\/li>\n
          • Adicione informa\u00e7\u00f5es sobre o servi\u00e7o prestado (“NFS-e: RPS Dados do servi\u00e7o<\/strong>“)\n
              \n
            1. RPS<\/li>\n
            2. Item da lista de servi\u00e7os (Letras)
              \nItem da lista de servi\u00e7os que corresponde ao servi\u00e7o da nota fiscal;<\/li>\n
            3. CNAE<\/li>\n
            4. C\u00f3digo Tribut\u00e1rio (Letras) –
              \nIdentifica\u00e7\u00e3o da lei que d\u00e1 sentido \u00e0s cobran\u00e7as (obter junto \u00e0 prefeitura);
              \nDica: Arrisque deixar em branco, caso n\u00e3o saiba;<\/li>\n
            5. Discrimina\u00e7\u00e3o (Letras) – A maioria das prefeituras aceita apenas um tipo servi\u00e7o por NFS-e, utilize este campo para descrever todos os servi\u00e7os de um mesmo tipo;<\/li>\n
            6. C\u00f3digo munic\u00edpio (Letras) – C\u00f3digo do IBGE;<\/li>\n
            7. C\u00f3digo do munic\u00edpio de incid\u00eancia (se for diferente).<\/li>\n<\/ol>\n<\/li>\n
            8. OPCIONAL: Adicione o endere\u00e7o de presta\u00e7\u00e3o “NFS-e:<\/strong>\u00a0RPS definir endere\u00e7o de presta\u00e7\u00e3o do servi\u00e7o”;<\/strong><\/li>\n
            9. Adicione os totais da NFS-e “NFS-e: RPS definir valores totais<\/strong>“;<\/li>\n
            10. Adicione as al\u00edquotas dos impostos com a fun\u00e7\u00e3o “NFS-e: RPS Definir Al\u00edquotas Impostos<\/b>“;<\/li>\n
            11. Adicione os dados do tomador do servi\u00e7o usando as fun\u00e7\u00f5es “NFS-e: RPS definir identifica\u00e7\u00e3o do Tomador<\/strong>” e “NFS-e: RPS definir endere\u00e7o do Tomador<\/strong>“.<\/li>\n
            12. Utilize a fun\u00e7\u00e3o “NFS-e: Obter XML do Lote de RPS<\/strong>” para pegar o XML do lote que ser\u00e1 enviado.<\/li>\n
            13. Envie o lote atrav\u00e9s da fun\u00e7\u00e3o “NFS-e: Enviar Lote de RPS<\/strong>” e o retorno ser\u00e1 o XML de resposta da prefeitura.<\/li>\n<\/ol>\n

              Processando a resposta do servidor<\/h2>\n
                \n
              1. Utilize a fun\u00e7\u00e3o “NFS-e: Processar resposta do servidor<\/strong>”\u00a0passando o XML devolvido no retorno do envio de lote, esta fun\u00e7\u00e3o transformar\u00e1 o resultado num mapeamento (Variante) com os campos abaixo;<\/li>\n
              2. Obtenha\u00a0o elemento “QTD_NFS<\/strong>“, observe se j\u00e1 foram retornas NFS-e (se o servi\u00e7o for s\u00edncrono).<\/li>\n
              3. Neste caso pule diretamente para a parte de leitura dos dados da NFS-e;<\/li>\n
              4. Obtenha o “PROTOCOLO<\/strong>” e fa\u00e7a a consulta da situa\u00e7\u00e3o do lote alguns segundos ap\u00f3s (30 segundos ou mais em m\u00e9dia) usando a fun\u00e7\u00e3o “NFS-e: Consultar situa\u00e7\u00e3o do Lote de RPS<\/strong>“;<\/li>\n
              5. Se o lote ainda n\u00e3o foi processado voc\u00ea deve consultar novamente depois de mais alguns segundos (30 a 90 segundos).<\/li>\n
              6. Algumas prefeituras j\u00e1 retorna os dados da NFS-e na consulta da situa\u00e7\u00e3o, outras s\u00f3 retornam os dados com a chamada da fun\u00e7\u00e3o\u00a0“NFS-e: Consultar Lote de RPS<\/strong>“, neste caso, ap\u00f3s o lote ser processado chame a fun\u00e7\u00e3o “NFS-e: Consultar Lote de RPS<\/strong>” para obter detalhes da resposta.<\/li>\n<\/ol>\n

                Leitura dos dados da NFS-e<\/h3>\n
                  \n
                1. Com o retorno do envio do lote (“NFS-e: Enviar Lote de RPS<\/strong>“), consulta situa\u00e7\u00e3o (“NFS-e: Consultar situa\u00e7\u00e3o do Lote de RPS<\/strong>“) ou consultar lote (“NFS-e: Consultar Lote de RPS<\/strong>“), vai depender de cada prefeitura, voc\u00ea receber\u00e1 os dados do RPS convertido em NFS-e, que pode ser retornado de forma individual (NFS-e \u00fanico), ou em lote (normalmente limitado a 50 no m\u00e1ximo).<\/li>\n
                2. Fa\u00e7a um loop, ou pegue o primeiro item se for NFS-e \u00fanico e obtenha os dados de cada NFS-e retornada, nem todas as prefeituras retornam todos os dados abaixo:\n
                    \n
                  • NFSx<\/strong><\/span>_NUMERO (Letras);<\/li>\n
                  • NFSx<\/span><\/strong>_DH_EMISSAO (Data);<\/li>\n
                  • NFSx<\/strong><\/span>_CODIGO_VERIFICACAO (Letras);<\/li>\n
                  • NFSx<\/strong><\/span>_XML (Letras);<\/li>\n
                  • NFSx<\/strong><\/span>_RPS_NUMERO (Letras);<\/li>\n
                  • NFSx<\/strong><\/span>_RPS_SERIE (Letras);<\/li>\n
                  • NFSx<\/strong><\/span>_RPS_TIPO (Letras);<\/li>\n
                  • NFSx<\/strong><\/span>_SITUACAO (Letras) – Situa\u00e7\u00e3o do RPS;<\/li>\n
                  • NFSx<\/strong><\/span>_LINK (Letras) – Link para download do PDF ou HTML da nota fiscal.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n

                    Em caso de erro<\/h3>\n

                    Quado h\u00e1 algum erro, ou mensagem de alerta as mesmas s\u00e3o retoradas a seguinte estrutura:<\/p>\n

                      \n
                    • MENSAGENS_QTD (Inteiro) – N\u00famero de mensagens retornar, de aviso e\/ou erro.<\/li>\n
                    • MENSAGENS_ERRO_QTD (Inteiro) – Quantidade de mensagens de erro;<\/li>\n
                    • MSGx<\/strong><\/span>_CODIGO (Letras) – C\u00f3digo da mensagem;<\/li>\n
                    • MSGx<\/strong><\/span>_MENSAGEM (Letras) – Descri\u00e7\u00e3o da mensagem.<\/li>\n
                    • MSGx<\/strong><\/span>_CORRECAO (Letras) – Texto descritivo da solu\u00e7\u00e3o retornado pela prefeitura.<\/li>\n<\/ul>\n

                      Dicas<\/h1>\n

                      Resumo de sequencia de chamada das fun\u00e7\u00f5es<\/h2>\n

                      Esta \u00e9 a sequencia b\u00e1sica de chamadas das fun\u00e7\u00f5es, algumas delas s\u00e3o opcionais, a depender do munic\u00edpio, ou do tipo de documento a ser emitido.<\/p>\n

                        \n
                      1. NFS-e: Criar conex\u00e3o;<\/li>\n
                      2. NFS-e: Definir par\u00e2metro do conector;<\/li>\n
                      3. NFS-e: Definir o nome e documento do prestador;<\/li>\n
                      4. NFS-e: RPS definir dados do SIMPLES;<\/li>\n
                      5. NFS-e: Criar novo lote;<\/li>\n
                      6. NFS-e: Novo RPS;<\/li>\n
                      7. NFS-e: RPS definir dados b\u00e1sicos;<\/li>\n
                      8. NFS-e: RPS definir RPS substitu\u00eddo;<\/li>\n
                      9. NFS-e: RPS Dados do servi\u00e7o;<\/li>\n
                      10. NFS-e: RPS adicionar Item;<\/li>\n
                      11. NFS-e: RPS definir endere\u00e7o de presta\u00e7\u00e3o do servi\u00e7o;<\/li>\n
                      12. NFS-e: RPS definir valores totais;<\/li>\n
                      13. NFS-e: RPS Definir Al\u00edquotas Impostos;<\/li>\n
                      14. NFS-e: RPS definir dados do Tomador (Depreciada);<\/del><\/li>\n
                      15. NFS-e: RPS definir dados do Tomador 2 (Depreciada);<\/del><\/li>\n
                      16. NFS-e: RPS definir identifica\u00e7\u00e3o do Tomador;<\/li>\n
                      17. NFS-e: RPS definir endere\u00e7o do Tomador;<\/li>\n
                      18. NFS-e: Obter XML do Lote de RPS;<\/li>\n
                      19. NFS-e: Enviar Lote de RPS;<\/li>\n
                      20. NFS-e: Consultar situa\u00e7\u00e3o do Lote de RPS;<\/li>\n
                      21. NFS-e: Consultar Lote de RPS;<\/li>\n
                      22. NFS-e: Processar resposta do servidor.<\/li>\n<\/ol>\n

                        Trabalhando com v\u00e1rias cidades<\/h2>\n

                        Utilize tantas fun\u00e7\u00f5es quanto forem necess\u00e1rias para atender o maior n\u00famero de cidades, deixe a API ignorar os dados desnecess\u00e1rios. Ou seja, n\u00e3o se ocupe em criar um fluxo para cada cidade, e sim um grande fluxo com todos os dados. Assim para adicionar novas cidades somente o c\u00f3digo do IBGE ser\u00e1 alterado.<\/p>\n

                        Validando os XMLs<\/h2>\n

                        Algumas valida\u00e7\u00f5es s\u00e3o espec\u00edficas da prefeitura (regras de neg\u00f3cio internas), outras s\u00e3o especificadas num arquivo de valida\u00e7\u00e3o do XML, voc\u00ea pode testar o XML gerado atrav\u00e9s da fun\u00e7\u00e3o “NFS-e – Obter XML do Lote<\/strong>” e testar junto com XSD fornecido pela prefeitura em sites como esse:<\/p>\n

                        http:\/\/www.utilities-online.info\/xsdvalidation\/<\/p>\n","protected":false},"excerpt":{"rendered":"

                        A API de NFS-e \u00e9 utilizada principalmente para emiss\u00e3o e cancelamento\u00a0(se suportado pela prefeitura) de notas ficais de servi\u00e7os, outras rotinas podem estar dispon\u00edveis. Passos para emiss\u00e3o da NFS-e Resumidamente a emiss\u00e3o da NFS-e segue os seguintes passos: Envio do Lote de RPS ou RPS individual para a prefeitura; Consulta a situa\u00e7\u00e3o do lote ou […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[56,20],"tags":[],"class_list":["post-250","post","type-post","status-publish","format-standard","hentry","category-instrucoes-de-uso","category-nfs-e"],"_links":{"self":[{"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/posts\/250","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/comments?post=250"}],"version-history":[{"count":45,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/posts\/250\/revisions"}],"predecessor-version":[{"id":3849,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/posts\/250\/revisions\/3849"}],"wp:attachment":[{"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/media?parent=250"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/categories?post=250"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.l2maker.com.br\/documentacao\/wp-json\/wp\/v2\/tags?post=250"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}