REST API de Nota Fiscal de Serviço

Guia Rápido

Todas as solicitações na API devem ser realizadas em ambiente criptografado HTTPS através da URL https://api.webmaniabr.com. O prefixo /2/ indica que atualmente nós estamos utilizando a versão 2.0 da API.

Todas as respostas são no formato objeto JSON.

Uma requisição bem sucedida é indicada através do status HTTP, o status 2xx indica sucesso. Quando uma requisição ocorre falha o corpo da resposta [body] continua no formato JSON, mas sempre contém o campo error. Por exemplo, caso a sua autenticação não seja bem sucedida irá retornar a seguinte mensagem:

{
  "msg": "Acesso restrito."
}

Autenticação

Para as solicitações o corpo da requisição [body] deve ser enviado no formato JSON com os headers Content-Type e Accept definido para application/json.

A autenticação é realizada através do cabeçalho HTTP (HTTP headers). É necessário o envio do header Authorization Bearer Token com o Access-Token da API 2.0, que é encontrado no painel Webmania®.

Mantenha as credenciais de acesso em segurança. Nunca publique as credenciais de acesso no código fonte do site, aplicativo ou software onde o usuário possa ter fácil acesso.

Para aplicativos mobile iOS e Android recomendamos que o processo de emissão seja realizado no servidor (back-end). No código fonte do aplicativo deve possuir somente a solicitação de emissão, enquanto o processo deve ser realizado em seu servidor.

Status município

A disponibilidade de recursos e funções na emissão da NFS-e depende das regras do provedor de cada município. Para obter todos os recursos disponíveis do provedor, envie a requisição no método GET para a URL /2/nfse/status/.

  curl -X GET \
-H "Authorization: Bearer SEU_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
https://api.webmaniabr.com/2/nfse/status

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos status, versao, ambientes, emissao e funcoes:

{
  "status": true, // Ambiente homologado
  "modelo": "abrasf", // Provedor do município
  "versao": "2.02", // Versão homologada
  "ambientes": [ 1, 2 ], // Ambientes disponíveis para emissão
  "autenticacao": [ "certificado_a1" ], // Formato de autenticação
  "emissao": [ "lote_rps", "nfse" ], // Modelos disponíveis para emissão
  "funcoes": [ "consultar", "cancelar", "substituir" ] // Funções disponíveis
 }

Sobre Lote RPS e NFS-e

Ao emitir uma Nota Fiscal de Serviço é retornado o Lote RPS ou a NFS-e emitida. O tratamento depende do provedor de cada município, onde a Webmania sempre prioriza a emissão de forma síncrona, em tempo real, para proporcionar uma melhor experiência.

Ao realizar a integração é essencial recepcionar o retorno dos modelos lote_rps e nfse. Segue abaixo:

Notificações

Para que a sua plataforma se mantenha sempre atualizada a Webmania disponibiliza as notificações automáticas para todos os status da Nota Fiscal.

Cada Nota Fiscal possui um número único de identificação chamado de UUID, este número deve ser utilizado para recepcionar e identificar a Nota Fiscal para atualizar as informações no seu banco de dados.

Notificações
Lote RPS

Será enviado o retorno no formato POST para a URL especificada contendo no corpo os parâmetros uuid, modelo, status, motivo, numero_lote, quantidade_rps, protocolo, info_nfse e log.

A requisição via POST é realizada no formato x-www-form-urlencoded:

-X POST \
-header "Content-type: x-www-form-urlencoded" \

Segue exemplo do retorno via POST:

["uuid"] = "00000000-0000-0000-0000-000000000000"
["modelo"] = "lote_rps"
["status"] = "processado"
["motivo"] = "Lote processado com sucesso"
["numero_lote"] = "0000"
["serie_lote"] = "A0"
["quantidade_rps"] = 2
["protocolo"] = "000000000000000"
["info_nfse"] = [
  {
    "uuid" = "00000000-0000-0000-0000-000000000000",
    "modelo" = "nfse",
    "status" = "aprovado",
    "motivo" = "Autorizado o uso da NFS-e",
    "numero" = "00",
    "codigo_verificacao" = "000000000",
    "xml" = "http://api.webmaniabr.com/xmlnfse/[uuid]/",
    "pdf" = "https://nfe.prefeitura.xx.gov.br/contribuinte/...",
    "pdf_rps" = "http://api.webmaniabr.com/darps/[uuid]/"
  },
  {
    "uuid" = "00000000-0000-0000-0000-000000000000",
    "modelo" = "nfse",
    "status" = "aprovado",
    "motivo" = "Autorizado o uso da NFS-e",
    "numero" = "00",
    "codigo_verificacao" = "000000000",
    "xml" = "http://api.webmaniabr.com/xmlnfse/[uuid]/",
    "pdf" = "https://nfe.prefeitura.xx.gov.br/contribuinte/...",
    "pdf_rps" = "http://api.webmaniabr.com/darps/[uuid]/"
  }
]
["log"] = { ... }

Notificações
NFS-e

Será enviado o retorno no formato POST para a URL especificada contendo no corpo os parâmetros uuid, modelo, status, motivo, numero, codigo_verificacao, serie_rps, numero_rps, xml, pdf, pdf_rps e log.

A requisição via POST é realizada no formato x-www-form-urlencoded:

-X POST \
-header "Content-type: x-www-form-urlencoded" \

Segue exemplo do retorno via POST:

["uuid"] = "00000000-0000-0000-0000-000000000000"
["modelo"] = "nfse"
["status"] = "aprovado"
["motivo"] = "Autorizado o uso da NFS-e"
["numero"] = "00"
["codigo_verificacao"] = "000000000"
["serie_rps"] = "A0"
["numero_rps"] = 00
["xml"] = "http://api.webmaniabr.com/xmlnfse/[uuid]/"
["pdf"] = "https://nfe.prefeitura.xx.gov.br/contribuinte/..."
["pdf_rps"] = "http://api.webmaniabr.com/darps/[uuid]/"
["log"] = { ... }

Emissão de Nota Fiscal

Para emitir uma Nota Fiscal de Serviço, envie a requisição no método POST para a URL /2/nfse/emissao/ contendo no corpo da requisição os objetos no formato JSON.

  curl -X POST \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ambiente": 1,
    "rps": [...]
  }' \
  https://api.webmaniabr.com/2/nfse/emissao

Segue abaixo exemplo de como Emitir Nota Fiscal de Serviço de modo simplificado com classe de imposto:

{
  "ambiente": 2,
  "url_notificacao": "http://meudominio.com/retorno.php",
  "rps": [
    {
      "servico": {
        "valor_servicos": "15.00",
        "discriminacao": "Prestação de Serviço referente ao mês X",
        "classe_imposto": "REF000000"
      },
      "tomador": {
        "cpf": "000.000.000-00",
        "nome_completo": "Nome do tomador"
      }
    }
  ]
}

A resposta do corpo da mensagem será no formato objeto JSON, podendo ser retornado os modelos lote_rps ou nfse. Em caso de dúvidas, clique aqui para saber mais sobre Lote RPS e NFS-e.

No momento que realizado a emissão da Nota Fiscal, caso tenha informado o parâmetro url_notificacao, será enviado o retorno no formato POST para URL especificada. Saiba mais

Emissão de Nota Fiscal
Informações da Nota Fiscal

As Informações da Nota Fiscal possuem todos os campos necessários para a emissão de uma Nota Fiscal de Serviço.

Preencha os campos conforme finalidade da sua emissão, alguns parâmetros possuem informações adicionais que podem ser acessadas ao clicar em cima.

Informações da Nota Fiscal
Retorno Lote RPS

Segue abaixo exemplo do retorno do Lote RPS contendo os campos uuid, modelo, status, motivo, numero_lote, quantidade_rps, protocolo, info_nfse e log.

Segue exemplo do retorno no formato JSON:

{
  "uuid": "00000000-0000-0000-0000-000000000000", // Número único de identificação
  "modelo": "lote_rps", // Modelo do Lote RPS (nfse, lote_rps)
  "status": "processado", // processando, processado, agendado, reprovado, cancelado, contingencia
  "motivo": "Lote processado com sucesso", // Motivo do status
  "numero_lote": "0000", // Número do Lote RPS
  "serie_lote": "A0", // Série do Lote RPS
  "quantidade_rps": 2, // Quantidade de NFS-e no Lote RPS
  "protocolo": "000000000000000", // Protocolo do Lote RPS
  "info_nfse": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000", // UUID da NFS-e 
      "modelo": "nfse", // Modelo da NFS-e
      "status": "aprovado", // Status da NFS-e
      "motivo": "Autorizado o uso da NFS-e", // Motivo da NFS-e
      "numero": "00", // Número da NFS-e
      "codigo_verificacao": "000000000", // Código de verificação da NFS-e
      "xml": "http://api.webmaniabr.com/xmlnfse/uuid/", // XML da NFS-e
      "pdf": "https://nfe.prefeitura.xx.gov.br/contribuinte/..", // PDF da prefeitura da NFS-e (quando disponível)
      "pdf_rps": "http://api.webmaniabr.com/xmlnfse/uuid/", // PDF do RPS da NFS-e
    }
  ],
  "log": "{...}" // Log de retorno da prefeitura
}

No momento que realizado a emissão da Nota Fiscal de Serviço (NFS-e), caso tenha informado o parâmetro url_notificacao, será enviado o retorno no formato POST para a URL especificada com o retorno no modelo lote_rps. Saiba mais

Informações da Nota Fiscal
Retorno NFS-e

Segue abaixo exemplo do retorno da NFS-e contendo os campos uuid, modelo, status, motivo, numero, codigo_verificacao, serie_rps, numero_rps, xml, pdf, pdf_rps e log.

Segue exemplo do retorno no formato JSON:

{
  "uuid": "00000000-0000-0000-0000-000000000000", // UUID da NFS-e 
  "modelo": "nfse", // Modelo da NFS-e
  "status": "aprovado", // processando, aprovado, agendado, reprovado, cancelado, contingencia
  "motivo": "Autorizado o uso da NFS-e", // Motivo da NFS-e
  "numero": "00", // Número da NFS-e
  "codigo_verificacao": "000000000", // Código de verificação da NFS-e
  "serie_rps": "A0", // Série do Lote RPS da NFS-e
  "numero_rps": 00, // Número do Lote RPS da NFS-e
  "xml": "http://api.webmaniabr.com/xmlnfse/uuid/", // XML da NFS-e
  "pdf": "https://nfe.prefeitura.xx.gov.br/contribuinte/..", // PDF da prefeitura da NFS-e (quando disponível)
  "pdf_rps": "http://api.webmaniabr.com/xmlnfse/uuid/", // PDF do RPS da NFS-e
  "log": "{...}" // Log de retorno da prefeitura
}

No momento que realizado a emissão da Nota Fiscal de Serviço (NFS-e), caso tenha informado o parâmetro url_notificacao, será enviado o retorno no formato POST para a URL especificada com o retorno no modelo nfse. Saiba mais

Emissão de Nota Fiscal
Informações do RPS

O RPS (Recibo Provisório de Serviço) contém todas as informações de uma prestação de serviços montados dentro da array rps, conforme mostrado na tabela Informações da Nota Fiscal.

Segue abaixo exemplo de como informar o RPS para emissão em massa:

{
  ...
  "rps": [
    {
      "servico": {
        "valor_servicos": "15.00",
        "discriminacao": "Prestação de Serviço referente ao mês X",
        "classe_imposto": "REF000000"
      },
      "tomador": {
        "cpf": "000.000.000-00",
        "nome_completo": "Nome do tomador"
      }
    },
    {
      "servico": {
        "valor_servicos": "25.00",
        "discriminacao": "Prestação de Serviço referente ao mês Y",
        "classe_imposto": "REF000000"
      },
      "tomador": {
        "cpf": "000.000.000-00",
        "nome_completo": "Nome do tomador"
      }
    }
  ]
}

Emissão de Nota Fiscal > Informações do RPS
Serviço

As informações do serviço são montados dentro do objeto servico, conforme mostrado na tabela Informações do RPS.

Segue abaixo exemplo para informar os serviços sem classe de imposto:

Emissão de Nota Fiscal > RPS > Serviço
Impostos

As informações dos impostos são montados dentro do objeto impostos, conforme mostrado na tabela serviço.

Aproveite o cálculo automático de impostos, ao utilizar a classe de imposto configurado no Painel Webmania®. Nesse caso, deverá ser informado somente o parâmetro classe_imposto com a referência (REF) da classe de imposto configurada.

Emissão de Nota Fiscal > RPS > Serviço
Intermediário

As informações do intermediário do serviço são montados dentro do objeto intermediario conforme mostrado na tabela Informações do Serviço.

Emissão de Nota Fiscal > RPS
Tomador

As informações do tomador do serviço são montados dentro do objeto tomador conforme mostrado na tabela Informações do RPS.

Emissão de Nota Fiscal > RPS
Construção Civil

As informações de construção civil devem ser informadas caso o serviço prestado esteja relacionado à obras de construção civil. As informações são montadas dentro do objeto construcao_civil conforme mostrado na tabela Informações do RPS.

Emissão de Nota Fiscal
Provedores

Conforme estipulado por cada provedor, campos adicionais podem ser solicitados dentro do objeto servico, conforme mostrado na tabela Informações do RPS. Verifique o provedor do seu município ao consultar o status e verifique os campos adicionais disponíveis e/ou obrigatórios.

Provedor Abrasf

O modelo de XML da Abrasf é o mais utilizado pelos municípios em emissões de Nota Fiscal de Serviço, o modelo está disponível nas versões 1.00, 2.00, 2.01, 2.02 e 2.03. Os campos específicos para cada versão desse modelo estão listados na tabela abaixo:

Emissão de Nota Fiscal
Provedor Cecam

Os campos específicos para emissão de Nota Fiscal de Serviço para os municípios atendidos pelo provedor Cecam estão listados na tabela abaixo:

Emissão de Nota Fiscal
Provedor DSF

Os campos específicos para emissão de Nota Fiscal de Serviço nos municípios atendidos pelo provedor DSF estão listados na tabela abaixo:

Emissão de Nota Fiscal
Provedor Florianópolis

Os campos específicos para emissão de Nota Fiscal de Serviço no município de Florianópolis estão listados na tabela abaixo:

Emissão de Nota Fiscal
Provedor Governa

Os campos específicos para emissão de Nota Fiscal de Serviço para os municípios atendidos pelo provedor Governa estão listados na tabela abaixo:

Emissão de Nota Fiscal
Provedor IPM

Os campos específicos para emissão de Nota Fiscal de Serviço para os municípios atendidos pelo provedor IPM estão listados na tabela abaixo:

Emissão de Nota Fiscal
Provedor Pública

Os campos específicos para emissão de Nota Fiscal de Serviço para os municípios atendidos pelo provedor Pública estão listados na tabela abaixo:

Emissão de Nota Fiscal
Provedor São Paulo

Os campos específicos para emissão de Nota Fiscal de Serviço para o município de São Paulo estão listados na tabela abaixo:

Emissão de Nota Fiscal > Provedores
SIGISS

Os campos específicos para emissão de Nota Fiscal de Serviço para o provedor SIGISS estão listados na tabela abaixo:

Funções
Consultar Nota Fiscal

Para consultar o status de emissão da Nota Fiscal de Serviço, envie a requisição no método GET para URL /2/nfse/consulta/ contendo na URL o uuid da Nota Fiscal.

Segue abaixo exemplo da consulta de uma Nota Fiscal:

curl -X GET \
-H "Authorization: Bearer SEU_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
https://api.webmaniabr.com/2/nfse/consulta/43eace5c-8008-4f6c-b830-b6d52d7ff90c

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos uuid, status, motivo, numero, codigo_verificacao, serie_rps, numero_rps, xml e log:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "modelo": "nfse", // Modelo da Nota Fiscal (nfse, lote_rps)
  "status": "aprovado", // aprovado, reprovado, cancelado, processamento ou contingencia
  "motivo": "Autorizado o uso da NFS-e", // Motivo do status
  "numero": "25000", // Número da NF-e
  "codigo_verificacao": "SFH-046", // Número de série
  "serie_rps": "A1", // Série do RPS
  "numero_rps": "2000", // Número do RPS
  "pdf_rps": "http://api.webmaniabr.com/darps/uuid/",
  "pdf_nfse": "http://api.webmaniabr.com/nfse/uuid/",
  "xml": "http://api.webmaniabr.com/xmlnfse/uuid/",
  "log": "{...}" // Log de retorno da prefeitura
}

Funções
Cancelar Nota Fiscal

Para cancelar uma Nota Fiscal de Serviço, envie a requisição no método PUT para URL /2/nfse/cancelar/ contendo na requisição os parâmetros uuid e motivo da Nota Fiscal.

Segue abaixo exemplo de cancelamento da Nota Fiscal:

curl -X PUT \
-H "Authorization: Bearer SEU_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
   "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c",
   "motivo": 1
}' \
https://api.webmaniabr.com/2/nfse/cancelar/

A resposta do corpo da mensagem será no formato objeto JSON:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "cancelado",
  "xml": "https://api.webmaniabr.com/xmlnfse/uuid",
  "log": "{...}" // Log de retorno da prefeitura
}

Funções
Substituir Nota Fiscal

Para substituir uma Nota Fiscal de Serviço, envie a requisição no método POST para URL /2/nfse/substituir/ contendo na requisição os parâmetros uuid e motivo da Nota Fiscal.

Segue abaixo exemplo de substituição de uma Nota Fiscal:

curl -X POST \
-H "Authorization: Bearer SEU_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
   "ambiente": 1,
   "codigo_verificacao": "XXX-XXX",
   "motivo": 1,
   "rps": {
     ...
   }
}' \
https://api.webmaniabr.com/2/nfse/substituir/

A resposta do corpo da mensagem será no formato objeto JSON:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "aprovado",
  "numero": "340",
  "codigo_verificacao": "XXX-XXX",
  "serie_rps": "A2",
  "numero_rps": "99",
  "nfse_substituida": {
    "uuid": "8f54e040-4344-4169-a9e7-daacd35bcfb1",
    "numero": "95",
    "codigo_verificacao": "XXX-XXX",
  },
  "xml": "https://api.webmaniabr.com/xmlnfse/uuid",
  "log": "{...}" // Log de retorno da prefeitura
}

Notas Fiscais em Processamento

A Nota Fiscal de Serviço (NFS-e) pode ser emitida de forma síncrona ou assíncrona, dependendo da disponibilidade de cada provedor do município, exceto quando é feito um envio de vários RPS, nesse caso a emissão sempre será assíncrona podendo variar de segundos a minutos, e nestes casos o status da Nota Fiscal é definida inicialmente como processando. É necessário aguardar o retorno da prefeitura antes de solicitar a emissão de uma nova Nota Fiscal.

No momento que realizado a emissão da Nota Fiscal, caso tenha informado o parâmetro url_notificacao, será enviado o retorno no formato POST para a URL especificada. Saiba mais