Comece agora
Teste Grátis!

Conheças as soluções Webmania® para o seu negócio. Teste grátis as nossas soluções*

Conversar no WhatsApp

*Teste grátis para novos clientes. Consulte condições e serviços disponíveis.

Suporte Técnico Webmania®

Oi, estamos aqui para te ajudar 😄

A Webmania® conta com um time de Weblovers completo, com especialistas no emissor de Nota Fiscal, contabilidade, código de programação, módulos de loja virtual e principalmente no encantamento das nossas soluções.


Está com dúvidas?
Confira nossa Central de Ajuda

Ainda com dúvidas? Estamos aqui! 😊️

  • Envie um E-mail com todos os detalhes (abrir ticket)
  • Ou acesse o Painel Webmania® e converse via Chat (iniciar chat)

Horário de atendimento:
E-mail 24 horas por dia. Chat de Segunda a Sexta-feira das 9h às 18h, exceto feriados.

Logo da Webmania
    • Ícone do produto Emissor Nota Fiscal Emissor de Notas Fiscais

      Conheça o emissor de Nota Fiscal nº 1 para sua empresa.

    • Ícone do produto Consulta de Notas Fiscais XML Consulta de Notas Fiscais

      Consulte e valide documentos fiscais em segundos.

    • Emissor de Nota Fiscal

      Emita nos modelos NF-e, NFC-e, NFS-e, CT-e e MDF-e. Confira!

    • API de Nota Fiscal

      Veja a documentação e conheça a nossa API de fácil integração.

    • Consulta de QR Code e Chave

      Consulta e Validação de QR Code, Chave e XML.

    • API de Consulta

      Veja a documentação e conheça a nossa API de fácil integração.

    Teste grátis Dúvidas? Estamos no WhatsApp
    • Ícone da solução Segmentos Segmentos

      De acordo com cada modelo de negócio.

    • Ícone da solução Integração Integração

      Veja como conectar a Webmania no seu negócio.

    • Logística e Transporte

      Agilidade na emissão da CT-e e MDF-e.

    • Contadores

      A Webmania é sua melhor parceira.

    • Loja Virtual WooCommerce

      Instale o plugin na sua loja e comece a emitir.

    • API de fácil integração

      Integre o seu software e ERP com as nossas APIs.

    Documentos
    • CT-e

      Emissões mais ágeis, simplificadas e automáticas.

    • MDF-e

      Conformidade fiscal e segurança em operações logÍsticas.

    • Comece Já

      Conheça a API de fácil integração da Webmania®

    • Guias

      Guias de fácil acesso para agilizar sua integração

    • API Nota Fiscal de Produto
    • API Nota Fiscal de Serviço
    • API Conhecimento de Transporte
    • API Manifesto Eletrônico
    • API Consulta QR Code e Chave
    • Documentação
    • Teste grátis
    • Módulos e Exemplos
    • Guia Loja Virtual
    • Testar sem código
    Monitor Sefaz em tempo real
    Monitor Prefeituras em tempo real
    Documentação completa
    Monitor Consultas em tempo real
  • Planos
    • Blog

      Acompanhe as novidades e dicas do mundo empresarial.

    • Clientes e Cases

      Saiba mais sobre nossos clientes e cases.

    • Sobre a Webmania

      Conheça a nossa história.

  • Contato
Entrar WhatsApp
      • Ícone do produto Emissor Nota Fiscal Emissor de Notas Fiscais

        Conheça o emissor de Nota Fiscal nº 1 para sua empresa.

      • Emissor de Nota Fiscal

        Emita nos modelos NF-e, NFC-e, NFS-e, CT-e e MDF-e.

      • API de Nota Fiscal

        Veja a documentação e conheça a nossa API de fácil integração.

      • Ícone do produto Consulta de Notas Fiscais XML Consulta de Notas Fiscais

        Consulte e valide documentos fiscais em segundos.

      • Consulta de QR Code e Chave

        Consulta e Validação de QR Code, Chave e XML.

      • API de Consulta

        Veja a documentação e conheça a nossa API de fácil integração.

      • Ícone da solução Segmentos Segmentos

        De acordo com cada modelo de negócio.

      • Logística e Transporte

        Agilidade na emissão da CT-e e MDF-e.

      • Contadores

        A Webmania é sua melhor parceira.

      • Ícone da solução Integração Integração

        Veja como conectar a Webmania no seu negócio.

      • Loja Virtual WooCommerce

        Instale o plugin na sua loja e comece a emitir.

      • API de fácil integração

        Integre o seu software e ERP com as nossas APIs.

      • Documentos
        • CT-e

          Emissões mais ágeis, simplificadas e automáticas.

        • MDF-e

          Conformidade fiscal e segurança em operações logÍsticas.

      • Comece Já

        Conheça a API de fácil integração da Webmania®

      • Documentação
      • Teste grátis
      • Módulos e Exemplos
      • Guia Loja Virtual
      • Testar sem código
      • Monitor Sefaz em tempo real
      • Monitor Prefeituras em tempo real
      • Monitor Consultas em tempo real
  • Planos
    • Sobre a Webmania
    • Clientes e Cases
    • Blog
    • WhatsApp
    • Fale Conosco
  • REST API NFS-e
  • Guia Rápido
  • Módulos & Exemplos
  • Autenticação
  • Status município
  • Lote RPS e NFS-e
  • Notificações
    • Informações
    • Lote RPS
    • NFS-e
  • Emissão de Nota Fiscal
    • Exemplo de emissão
    • Informações da Nota Fiscal
      • Informações
      • Retorno Lote RPS
      • Retorno NFS-e
    • Informações do RPS
      • Serviço
        • Informações
        • Impostos
        • Intermediário
      • Tomador
        • Nacional
        • Estrangeiro
      • Construção Civil
      • Atividades em eventos
    • Provedores
      • Abrasf
        • Itens
      • Cecam
      • DSF
      • Equiplano
      • Florianópolis
      • Governa
      • IPM
      • Osasco
      • Padrão Nacional
      • Pública
      • Prescon
      • São Paulo
      • SIGISS
      • Sigissweb
      • Thema
  • Funções
    • Download XML e PDF
      • Credenciais de acesso
      • Token
    • Consultar Nota Fiscal
    • Cancelar Nota Fiscal | Agendamento
    • Substituir Nota Fiscal
    • Manifestar participação
  • Informações
    • Notas em Processamento
    • Infraestrutura
    • Limite de requisições
⚡ Acompanhe em tempo real: Status | Monitor Sefaz | Monitor Prefeituras | Monitor Consultas
Versão: 2.9.5

REST API de Nota Fiscal de Serviço

Documentação para emissão de Nota Fiscal no modelo NFS-e.

Utilize a REST API da Webmania®, para emissão de Nota Fiscal de Serviço disponível em 2.089 municípios. Deseja emitir outros modelos? Ver documentação

Disponibilidade e Segurança
Alta disponibilidade, escalabilidade e servidores redundantes no mais alto nível de segurança PCI DSS na líder global de cloud computing Amazon Web Services.
Armazenamento
Arquivamento seguro, criptografado e ilimitado das Notas Fiscais na tecnologia Amazon S3, que garante 99,999999999% de durabilidade dos arquivos XML.
Integração REST API
Compatível com todas as linguagens de programação através da comunicação JSON. Garantia de baixa latência com mais de 200 pontos de presença na rede Amazon Web Services.
Numeração automática
Emita Notas Fiscais ao mesmo tempo via API, Ponto de Venda, Loja Virtual e painel Webmania®, onde todas as numerações são gerenciadas e auditadas automaticamente.
DANFE e Envio por e-mail
Geração de DANFE automático e compatível com todas as impressoras comuns e térmicas, com envio seguro da Nota Fiscal por e-mail.
Suporte Especializado
Atendimento pelos nossos Weblovers, especialistas na área contábil e programação para te ajudar. #weblovers #webmaniabr

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.

URL HTTP Verb Função
/2/nfse/emissao POST Emissão de Nota Fiscal
/2/nfse/substituir POST Substituição de Nota Fiscal
/2/nfse/manifestar POST Manifestar participação (Padrão Nacional)
/2/nfse/consulta GET Consulta de Nota Fiscal
/2/nfse/status GET Consulta status e recursos do provedor do município
/2/nfse/cancelar PUT Cancelar Nota Fiscal | Agendamento

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."
}

Módulos & Exemplos

Realize a emissão com apenas um clique na sua Loja Virtual através dos módulos da Webmania® ou realize a integração para os diversos tipos de linguagens de programação.

  • Ferramentas
    • Coleção Postman e Insomnia (Testes instantâneos)
    • Vídeo: Testar REST API sem linha de código
  • Módulos
    • WooCommerce
  • Linguagens
    • PHP

Autenticação

Para as requisições, o corpo da requisição [body] deve ser enviado no formato JSON com os headers Content-Type e Accept definidos 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, 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 móveis iOS e Android, recomendamos que o processo de emissão seja realizado no servidor (back-end). O 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 uma 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, modelo, versao, ambientes, autenticacao, emissao, funcoes e parametros_disponiveis:

Parâmetro Tipo Descrição
status boolean Informa se o município se encontra homologado na Webmania®
Novos ambientes são homologados conforme requisições.
modelo string Modelo do provedor do município
versao string Versão do XML do provedor
Parâmetros na API podem mudar conforme versão do XML.
ambientes array Ambientes disponíveis conforme regras do provedor
1 - Produção
2 - Homologação

Atenção: Alguns provedores não fornecem ambiente de homologação.
autenticacao array Autenticação disponível conforme regras do provedor
certificado_a1
login_senha
token
O método de autenticação deve ser configurado na empresa através da API ou Painel Webmania®. Saiba mais
emissao array Modelos disponíveis conforme regras do provedor
lote_rps
nfse

Atenção: O tipo de emissão e o retorno variam para cada modelo. Saiba mais
funcoes array Funções disponíveis conforme regras do provedor
consultar
cancelar
substituir
codigo_servico array Código de serviços disponíveis para empresa com base no CNAE e as alíquotas sugeridas para os impostos.
parametros_disponiveis objeto Parâmetros disponíveis para o modelo utilizado pelo município e a sua obrigatoriedade.
obrigatorio - Obrigatório
obrigatorio_pf - Obrigatório para Pessoa Física
obrigatorio_pj - Obrigatório para Pessoa Jurídica
opcional - Opcional

Atenção: O parâmetro será retornado apenas para São Paulo - SP e Rio de Janeiro - RJ, em breve os outros modelos serão incluídos.
{
  "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
  "codigo_servico": [
    {
      "codigo": "0000", // Código do serviço
      "descricao": "Serviço 1", // Descrição do serviço
      "codigo_tributacao": "000000000", // Código de tributação do serviço no município, caso esteja disponível
      "aliquota_sugerida": {
        "iss": 5 // Alíquota Sugerida do ISS
      }
    },
    {
      "codigo": "0000", // Código do serviço
      "descricao": "Serviço 2", // Descrição do serviço
      "aliquota_sugerida": {
        "iss": 2 // Alíquota Sugerida do ISS
      }
    },
    ...
  ],
  "parametros_disponiveis": {
    "empresa.cnpj": "obrigatorio_pj", // Para pessoa jurídica, obrigatório preencher o CNPJ nas configurações da empresa
    "servico.valor_servicos": "obrigatorio", // Obrigatório informar o valor dos serviços
    "tomador.cpf": "obrigatorio_pf", // Para pessoa física, obrigatório informar o CPF do tomador
    "tomador.email": "opcional", // Informar o e-mail do tomador é opcional
    ...
  }
 }

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. 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:

Modelo Envio Descrição
lote_rps assíncrono O retorno do Lote RPS pode ser gerado ao emitir notas fiscais em massa ou caso o município processe as notas fiscais no modo assíncrono, ou seja, a nota é primeiro recepcionada e somente depois processada.
Envio em massa: Limite 50 notas (quando disponível)
nfse síncrono O retorno da NFS-e ocorre quando solicitado uma única emissão e quando o município permite o envio no formato síncrono, ou seja, em tempo real.

Notificações

Para que sua plataforma se mantenha sempre atualizada, a Webmania disponibiliza notificações automáticas para todos os status da Nota Fiscal e para todas as atualizações relacionadas ao DANFS-e.

Todas as atualizações feitas no DANFS-e serão notificadas com o mesmo padrão de notificação. Isso garante que você esteja sempre informado sobre qualquer modificação relevante relacionada ao seu documento fiscal. Essas notificações proporcionam uma maneira eficiente de acompanhar e gerenciar as atualizações, garantindo maior transparência e controle sobre seus registros fiscais.

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 e 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, serie_lote, quantidade_rps, protocolo, info_nfse, log e atualizado_em.

Notificação Lote RPS
Parâmetro Tipo Descrição
uuid string Número único de identificação do Lote RPSDeve ser utilizada a UUID para recepcionar o retorno da notificação.
modelo string Modelo do retorno
lote_rps
status string Status do Lote RPS
processando
processado
agendado
reprovado
cancelado
contingencia
motivo string Motivo do status do Lote RPS
Ex.: Lote processado com sucesso
numero_lote string Número do Lote RPS
serie_lote string Série do Lote RPS
quantidade_rps string Quantidade de NFS-e no Lote RPS
protocolo string Protocolo do Lote RPS
info_nfse array Listagem e retorno de todas as notas fiscais do Lote RPS
Os parâmetros são os mesmos do retorno da NFS-e. Saiba mais
log objeto Log de retorno da prefeitura
atualizado_em data e hora Data e Hora da última atualização

A requisição via POST é realizada no formato application/json:

-X POST \
-header "Content-type: application/json" \

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_nfse": "https://api.webmaniabr.com/nfse/[uuid]",
            "pdf_nfse_status": "processado",
            "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_nfse": "https://api.webmaniabr.com/nfse/[uuid]",
            "pdf_nfse_status": "processando",
            "pdf_rps": "http://api.webmaniabr.com/darps/[uuid]"
        }
    ],
    "log": { ... },
    "atualizado_em": "2024-01-01T12:00:00-03:00"
}

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_nfse, pdf_nfse_status, pdf_rps, log e atualizado_em.

Notificação NFS-e
Parâmetro Tipo Descrição
uuid string Número único de identificação da Nota FiscalDeve ser utilizado a UUID para recepcionar o retorno da notificação.
modelo string Modelo do retorno
nfse
status string Status da Nota Fiscal
processando
aprovado
agendado
reprovado
cancelado
contingencia
motivo string Motivo do status da Nota Fiscal
Ex.: Autorizado o uso da NFS-e
numero string Número da Nota Fiscal
Gerenciado automaticamente pela prefeitura do município.
codigo_verificacao string Código de verificação da Nota Fiscal
serie_rps string Série do RPS
numero_rps string Número do RPS
xml string URL do XML da Nota Fiscal
pdf_nfse string URL do PDF da Nota Fiscal
quando disponibilizado pela prefeitura
pdf_nfse_status string Status do PDF da Nota Fiscal
quando disponibilizado pela prefeitura
status:
processando
processado
indisponivel
pdf_rps string URL do PDF do Recibo Provisório (RPS) da Nota Fiscal
log objeto Log de retorno da prefeitura
atualizado_em data e hora Data e Hora da última atualização

A requisição via POST é realizada no formato application/json:

-X POST \
-header "Content-type: application/json" \

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_nfse": "https://api.webmaniabr.com/nfse/[uuid]",
    "pdf_nfse_status": "indisponivel",
    "pdf_rps": "http://api.webmaniabr.com/darps/[uuid]",
    "log": { ... },
    "atualizado_em": "2024-01-01T12:00:00-03:00"
}

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.

Parâmetro NFS-e Tipo Tam. Descrição
ID
string 1-15 Número do pedido de compra ou ID de processamento
Controle das solicitações de emissão por pedido ou ID de processamento. Saiba mais
ambiente
número 1 Identificação do Ambiente da Nota Fiscal
1 - Produção
2 - Homologação
A disponibilidade do ambiente de homologação depende do provedor de cada município. Consulte o status para validação.
rps
array 1-50 Informações do serviço e tomador de cada Nota Fiscal, limitado a 50 NFS-e por requisição.
Somente municípios com suporte ao lote_rps permitem envio em massa. Consulte o status para validação.
url_notificacao
string --- URL de notificação para todas as atualizações de status da Nota Fiscal
data_agendamento
data e hora --- Permite especificar a Data e Hora para agendar a emissão da Nota Fiscal. Cancelar Agendamento
Formato americano:
YYYY-MM-DD HH:MM:00

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.

Retorno Lote RPS
Parâmetro Tipo Descrição
uuid string Número único de identificação do Lote RPSDeve ser utilizada a UUID para recepcionar o retorno da notificação.
modelo string Modelo do retorno
lote_rps
status string Status do Lote RPS
processando
processado
agendado
reprovado
cancelado
contingencia
motivo string Motivo do status do Lote RPS
Ex.: Lote processado com sucesso
numero_lote string Número do Lote RPS
serie_lote string Série do Lote RPS
quantidade_rps string Quantidade de NFS-e no Lote RPS
protocolo string Protocolo do Lote RPS
info_nfse array Listagem e retorno de todas as notas fiscais do Lote RPS
Os parâmetros são os mesmos do retorno da NFS-e. Saiba mais
log objeto Log de retorno da prefeitura

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_nfse": "https://api.webmaniabr.com/nfse/[uuid]", // PDF da prefeitura da NFS-e (quando disponível)
      "pdf_nfse_status": "processado", // Status do 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_nfse, pdf_nfse_status, pdf_rps e log.

Retorno NFS-e
Parâmetro Tipo Descrição
uuid string Número único de identificação da Nota FiscalDeve ser utilizado a UUID para recepcionar o retorno da notificação.
modelo string Modelo do retorno
nfse
status string Status da Nota Fiscal
processando
aprovado
agendado
reprovado
cancelado
contingencia
motivo string Motivo do status da Nota Fiscal
Ex.: Autorizado o uso da NFS-e
numero string Número da Nota Fiscal
Gerenciado automaticamente pela prefeitura do município.
codigo_verificacao string Código de verificação da Nota Fiscal
serie_rps string Série do RPS
numero_rps string Número do RPS
xml string URL do XML da Nota Fiscal
pdf_nfse string URL do PDF da Nota Fiscal
quando disponibilizado pela prefeitura
pdf_nfse_status string Status do PDF da Nota Fiscal
quando disponibilizado pela prefeitura
status:
processando
processado
indisponivel
pdf_rps string URL do PDF do Recibo Provisório (RPS) da Nota Fiscal
log objeto Log de retorno da prefeitura

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_nfse": "https://api.webmaniabr.com/nfse/[uuid]", // PDF da prefeitura da NFS-e (quando disponível)
  "pdf_nfse_status": "processado", // Status do 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.

Parâmetro NFS-e Tipo Tam. Descrição
servico
objeto --- Informações do Serviço
tomador
objeto --- Informações do Tomador
construcao_civil
objeto --- Informações Construção Civil

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.

Atenção: De acordo com cada provedor, campos adicionais podem ser solicitados no RPS. Verifique o provedor do seu município, ao consultar o status, e verifique os campos adicionais disponíveis e/ou obrigatórios. Saiba mais
Parâmetro NFS-e Tipo Tam. Descrição
discriminacao
string 1-2000 Discriminação do serviço
valor_servicos
string 15v2 Valor total dos serviços prestados
0.00
classe_imposto
objeto --- Definição automática de impostos, informe a referência da classe de imposto cadastrado no painel Webmania®
REF0000
impostos
objeto --- Definição de impostos na API, para operações que demande maior flexibilidade
iss_retido
número 1 *Obrigatório caso não informado a Classe de Imposto
Responsável pela retenção do ISS
1 - Sim
2 - Não
responsavel_retencao_iss
número 1 *Obrigatório caso possua ISS Retido
Responsável pela retenção do ISS
1 - Tomador
2 - Intermediário
deducoes
string 15v2 Valor da dedução da Base de Cálculo
0.00
desconto_incondicionado
string 15v2 Valor do desconto incondicionado
0.00
desconto_condicionado
string 15v2 Valor do desconto condicionado
0.00
outras_retencoes
string 15v2 Valor das outras retenções
0.00
numero_processo
string 1-30 Número do processo judicial ou administrativo de suspensão da exigibilidade do ISS
intermediario
objeto --- Informações do Intermediário do Serviço

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.

Parâmetro NFS-e Tipo Tam. Descrição
classe_imposto
string --- Definição automática de impostos, informe a referência da classe de imposto cadastrado no painel Webmania®
REF0000
iss
string 3v2 Alíquota do ISS
0.00
cst_pis_cofins
string 2 Código de Situação Tributária do PIS/COFINS (CST)
Obs.: Disponível apenas para o Padrão Nacional
00 - Nenhum
01 - Operação Tributável com Alíquota Básica
02 - Operação Tributável com Alíquota Diferenciada
03 - Operação Tributável com Alíquota por Unidade de Medida de Produto
04 - Operação Tributável monofásica - Revenda a Alíquota Zero
05 - Operação Tributável por Substituição Tributária
06 - Operação Tributável a Alíquota Zero
07 - Operação Tributável da Contribuição
08 - Operação sem Incidência da Contribuição
09 - Operação com Suspensão da Contribuição
pis
string 3v2 Alíquota do PIS
0.00
cofins
string 3v2 Alíquota do COFINS
0.00
inss
string 3v2 Alíquota do INSS
0.00
ir
string 3v2 Alíquota do IR
0.00
csll
string 3v2 Alíquota do CSLL
0.00
cp
string 3v2 Alíquota do CP (Contribuição Patronal)
Obs.: Disponível apenas para o Padrão Nacional
0.00

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.

Parâmetro NFS-e Tipo Tam. Descrição
cpf
Pessoa Física
string 11 Número do CPF
000.000.000-00
nome_completo
Pessoa Física
string 2-150 Nome completo
cnpj
Pessoa Jurídica
string 14 Número do CNPJ
00.000.000/0000-00
razao_social
Pessoa Jurídica
string 2-150 Razão social
im
string 1-15 Inscrição municipal
cidade
string 1-40 Cidade do Intermediário.
Obrigatório para o modelo Abrasf versão 2.04
uf
string 2 UF do Intermediário.
Obrigatório para o modelo Abrasf versão 2.04

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.

Parâmetro NFS-e Tipo Tam. Descrição
cpf
Pessoa Física
string 11 Número do CPF
000.000.000-00
nome_completo
Pessoa Física
string 2-150 Nome completo
cnpj
Pessoa Jurídica
string 14 Número do CNPJ
00.000.000/0000-00
razao_social
Pessoa Jurídica
string 2-150 Razão social
im
string 1-15 Inscrição municipal
nif
string 1-40 Número de Identificação Fiscal
endereco
string 1-40 *Obrigatório Pessoa Jurídica
Endereço do tomador
numero
string 1-40 *Obrigatório Pessoa Jurídica
Número do endereço do tomador
complemento
string 1-40 Complemento do endereço do tomador
bairro
string 1-40 *Obrigatório Pessoa Jurídica
Bairro do endereço do tomador
cidade
string 1-40 *Obrigatório Pessoa Jurídica
Cidade do endereço do tomador
uf
string 1-40 *Obrigatório Pessoa Jurídica
Estado do endereço do tomador
cep
string 1-40 *Obrigatório Pessoa Jurídica
CEP do endereço do tomador
email
string 1-40 E-mail do tomador para envio da NFS-e
telefone
string 1-40 Telefone do tomador

Emissão de Nota Fiscal > RPS > Tomador
Estrangeiro

Para as Notas Fiscais de Serviço onde o tomador reside fora do país, é necessário informar os dados do tomador estrangeiro. As informações são montadas dentro do objeto tomador conforme mostrado na tabela Informações do RPS.
Obs.: O tomador estrangeiro só está disponível para o modelo Abrasf versão 2.04

Parâmetro NFS-e Tipo Tam. Descrição
nome_estrangeiro
string 2-150 Nome Completo
id_estrangeiro
string 1-20 Número de Identificação (Passaporte ou outro documento legal)
endereco_completo
string 1-255 Endereço Completo
nome_pais
string 1-40 Nome do País
codigo_pais
string 4 Código do País (padrão BACEN)
Ex: Estados Unidos = 2496
Visualizar tabela do BACEN
email
string 1-40 E-mail do tomador para envio da NFS-e

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. Os parâmetros podem variar conforme o padrão adotado pelo provedor que atende o município, abaixo estão listados os parâmetros para o modelo Abrasf, Padrão Nacional e Sigissweb.

Modelo Abrasf
Parâmetro NFS-e Tipo Tam. Descrição
codigo_obra
string 1-15 Código da obra
art
string 1-15 Código da Anotação de Responsabilidade Técnica

Para o Padrão Nacional é obrigatório informar um dos três parâmetros: inscricao_imobiliaria_fiscal, codigo_obra ou os campos do endereço da obra. Quando um é informado, os outros dois não podem ser informados.

Padrão Nacional
Parâmetro NFS-e Tipo Tam. Descrição
inscricao_imobiliaria_fiscal
string 1-30 Inscrição imobiliária fiscal
Código fornecido pela Prefeitura Municipal para a identificação da obra ou para fins de recolhimento do IPTU
codigo_obra
string 1-30 Número de identificação da obra
Cadastro Nacional de Obras (CNO) ou Cadastro Específico do INSS (CEI)
endereco
string 1-255 Logradouro do endereço da obra
numero
string 1-60 Número do endereço da obra
complemento
string 1-156 Complemento do endereço da obra
bairro
string 1-60 Bairro do endereço da obra
cep
string 8 CEP do endereço da obra

Para o Sigissweb é obrigatório informar os seguintes parâmetros: cno, nome, endereco, cep, numero, bairro.

Sigissweb
Parâmetro NFS-e Tipo Tam. Descrição
cno
string12Cadastro Nacional de Obras
nome
string1-60Nome da obra
endereco
string1-125Endereço da obra
cep
string8Cep da obra
numero
string1-10Numero do endereço da obra
bairro
string1-60Bairro da obra
cidade
string1-60Cidade da obra
uf
string2UF da obra
complemento
string1-60Complemento da obra
inscricao_imobiliaria
string1-30Inscrição imobiliária da obra
exterior
string1Indicador se a obra é exterior
1 - Sim
0 - Não

Emissão de Nota Fiscal > RPS
Atividades em eventos

As informações relativas a atividades em eventos devem ser informadas caso o serviço prestado pertença ao item 12 da lista de serviços, ou seja, o código de serviço seja 12.XX.XX. As informações são montadas dentro do objeto atividades_evento e estão disponíveis somente para os modelos Padrão Nacional e SigissWeb.

Parâmetro NFS-e Tipo Tam. Descrição
descricao_evento
string 1-255 Nome e descrição do evento Artístico, Cultural, Esportivo, etc.
data_inicio
string 10 Data de início da atividade de evento
Formato: YYYY-MM-DD
data_final
string 10 Data do fim da atividade de evento
Formato: YYYY-MM-DD
identificacao
string 1-30 Identificação da Atividade de Evento.
Obrigatório caso não seja informado o endereço do local da atividade de evento.
Código identificador de evento determinado pela Administração Tributária Municipal
endereco
string 1-255 Logradouro do endereço do local da atividade de evento
numero
string 1-60 Número do endereço do local da atividade de evento
complemento
string 1-156 Complemento do endereço do local da atividade de evento
bairro
string 1-60 Bairro do endereço do local da atividade de evento
cep
string 8 CEP do endereço do local da atividade de evento

Além dos parâmetros dispostos acima, o Sigissweb também utiliza os seguintes parâmetros:

Sigissweb
Parâmetro NFS-e Tipo Tam. Descrição
cidade
string1-60Cidade do local da atividade de evento
uf
string2UF da cidade do local da atividade de evento
uf_prestacao
string2UF da prestação do serviço referente ao evento
pais
string1-40País do local da atividade de evento
exterior
string1Indicador se o evento é exterior
1 - Sim
0 - Não

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, 2.03 e 2.04. Os campos específicos para cada versão desse modelo estão listados na tabela abaixo:

Parâmetro Obrigatório Versão Tipo Tam. Descrição
codigo_servico
Todas as versões string 5 Código de serviço
00.00
codigo_cnae
Todas as versões string 7 Código CNAE
codigo_tributacao_municipio
Todas as versões string 1-20 Código de Tributação no município
uf_local_prestacao
Todas as versões string 2 UF do local de prestação do serviço
cidade_local_prestacao
Todas as versões string 1-20 Cidade do local de prestação do serviço
natureza_operacao
1.00 número 1 Código de natureza da operação
1 - Tributação no município
2 - Tributação fora do município
3 - Isenção
4 - Imune
5 - Exigibilidade suspensa por decisão judicial
6 - Exigibilidade suspensa por procedimento administrativo
exigibilidade_iss
2.00 ou superior número 1 Exigibilidade do ISS
1 - Exigível
2 - Não incidência
3 - Isenção
4 - Exportação
5 - Imunidade
6 - Exigibilidade suspensa por decisão judicial
7 - Exigibilidade suspensa por processo administrativo
data_competencia
2.00 ou superior string 10 Data da competência
Formato: YYYY-MM-DD
numero_processo
2.00 ou superior string 1-30 Número do processo judicial ou administrativo de suspensão da exigibilidade do ISS
local_incidencia
2.00 ou superior número 1 Local de incidência do imposto
1 - Município do prestador
2 - Município de prestação do serviço
3 - Município do tomador
codigo_nbs
2.03 string 1-9 Código da Nomenclatura Brasileira de Serviços
informacoes_complementares
2.04 string 1-2000 Informações complementares relacionadas ao serviço prestado.
itens
2.04 array --- Itens dos serviços disponíveis apenas para Uberlândia, MG

Emissão de Nota Fiscal > RPS > Provedores > Abrasf
Itens

As informações dos itens são montadas dentro do objeto itens conforme mostrado na tabela do provedor Abrasf.

Parâmetro NFS-e Tipo Tam. Descrição
descricao
string 1-255 Descrição do item
quantidade
string 13v2 Quantidade de item
00.00
valor_unitario
string 13v2 Valor unitário do item
00.00
item_tributavel
string 1 Se o item é tributável ou não
1 - Sim
2 - Não

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:

Parâmetro Obrigatório Tipo Tam. Descrição
codigo_cnae
string 7 Código CNAE
codigo_servico
string 5 Código de serviço
0000
local_prestacao
string 1 Local de prestação do serviço
1 - Sede do prestador
2 - Imóvel (Construção Civil)
3 - Via pública
4 - Fora do município
cep_local_prestacao
string 9 CEP do local de prestação do serviço
Deve ser utilizado quando a prestação do serviço é realizada fora do município.

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:

Parâmetro Obrigatório Tipo Tam. Descrição
codigo_cnae
string 9 Código CNAE
tipo_operacao
string 1 Tipo da Operação
A - Sem dedução
B - Com dedução/materiais
C - Imune/Isenta de ISS
D - Devolução/Simples remessa
J - Intermediação
tipo_tributacao
string 1 Tipo de Tributação
C - Isenta de ISS
E - Não incidência no município
F - Imune
K - Exigibilidade suspensa por decisão judicial ou processo administrativo
N - Não tributável
T - Tributável
G - Tributável Fixo
H - Tributável Simples Nacional
M - Micro Empreendedor Individual (MEI)

Emissão de Nota Fiscal
Provedor Equiplano

Os campos específicos para emissão de Nota Fiscal de Serviço para o provedor Equiplano estão listados nas tabelas abaixo:

Parâmetro Obrigatório Tipo Tam. Parâmetro Pai Descrição
codigo_servico
string 4-6 servico Código de serviço
"00.00"
justificativa_deducoes
string 1-255 servico Descrição de justificativa do valor das deduções. É obrigatório quando for informado um valor de dedução no documento.
descricao_impostos
string 1-500 impostos Descrição dos valores de impostos aplicados no documento.
ie
string 1-20 tomador Inscrição Estadual do Tomador.
Tomador Estrangeiro
Parâmetro Obrigatório Tipo Tam. Parâmetro Pai Descrição
documento_estrangeiro
string 0-30 tomador Código do documento estrangeiro
cidade_estrangeira
string 0-30 tomador Nome da cidade de residência do estrangeiro.
pais
string 1-500 tomador Nome do país de residência do estrangeiro.

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:

Parâmetro Obrigatório Tipo Tam. Descrição
cfps
string 4 Código Fiscal de Prestação de Serviços
id_cnae
string 4-5 Código Identificador do Serviço Prestado

Obs.: O ID CNAE não é o mesmo que o código CNAE. Consulte a tabela disponibilizada pelo município para encontrar o ID CNAE correspondente ao serviço prestado.
situacao_tributaria
string 2 Código de Situação Tributária
0 - Tributada integralmente
1 - Tributada integralmente e sujeita ao regime do Simples Nacional
2 - Tributada integralmente e com ISS retido na fonte
3 - Tributada integralmente, sujeita ao regime do Simples Nacional e com ISS retido na fonte
4 - Tributada integralmente e sujeita ao regime da substituição tributária
5 - Tributada integralmente e sujeita ao regime da substituição tributária pelo agenciador ou intermediário da prestação de serviço
6 - Tributada integralmente, sujeita ao regime do Simples Nacional e da substituição tributária
7 - Tributada integralmente e com o ISS retido anteriormente pelo substituto tributário
8 - Tributada com redução da base de cálculo ou alíquota
9 - Tributada com redução da base de cálculo ou alíquota e com ISS retido na fonte
10 - Tributada com redução da base de cálculo ou alíquota e sujeita ao regime da substituição tributária
11 - Tributada com redução da base de cálculo ou alíquota e com o ISS retido anteriormente pelo substituto tributário
12 - Isenta ou imune
13 - Não tributada
14 - Tributada por meio do imposto fixo
15 - Não tributada em razão do destino dos bens ou objetos - Mercadorias para industrialização ou comercialização
16 - Não tributada em razão do diferimento da prestação do serviço

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:

Parâmetro Obrigatório Tipo Tam. Descrição
codigo_cnae
string 7-9 Código de serviço
0000000
regime_recolhimento
string 2 Código do Regime de Recolhimento
00 - Movimento
03 - Isento
04 - Imune
07 - Não incidência
08 - Estimativa
09 - Soc. Liberal
11 - Simples Nacional
12 - Microempreendedor individual (MEI)
forma_recolhimento
string 2 Código da Forma de Recolhimento
00 - Normal
01 - Retido na fonte
02 - Recolhimento antecipado
03 - Simples Nacional
04 - Fixo/Anual
05 - Sem recolhimento
06 - Devido a outro município
07 - Fixo/Mensal

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:

Parâmetro Obrigatório Tipo Tam. Descrição
codigo_servico
string 5 Código de serviço
00.00
situacao_tributaria
string 2 Código de Situação Tributária
0 - Tributada integralmente
1 - Tributada integralmente com ISS retido na fonte
2 - Tributada integralmente e sujeita à substituição tributária
3 - Tributada com redução da base de cálculo
4 - Tributada com redução da base de cálculo e ISS retido na fonte
5 - Tributada com redução da base de cálculo e sujeita à substituição tributária
6 - Isenta
7 - Imune
8 - Não tributada - ISS regime fixo
9 - Não tributada - ISS regime estimativa
10 - Não tributada - ISS Construção Civil recolhido antecipadamente
15 - Não tributada - Ato Cooperado
natureza_operacao
string 1 Código da Natureza de Operação
1 - Tributado no município do prestador
2 - Não tributado no município do prestador

Emissão de Nota Fiscal
Provedor Osasco

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

Parâmetro Obrigatório Tipo Tam. Descrição
codigo_servico
string 5 Código de serviço
00.00
endereco_local_prestacao
string 9 Endereço do local de prestação do serviço
Deve ser preenchido para prestação de serviços de construção civil.
cep_local_prestacao
string 9 CEP do local de prestação do serviço
Deve ser preenchido para prestação de serviços de construção civil.
cidade_local_prestacao
string 9 Cidade do local de prestação do serviço
Deve ser preenchido para prestação de serviços de construção civil.
uf_local_prestacao
string 9 UF do local de prestação do serviço
Deve ser preenchido para prestação de serviços de construção civil.

Emissão de Nota Fiscal
Padrão Nacional

Os campos específicos para emissão de Nota Fiscal de Serviço para os municípios conveniados ao Padrão Nacional estão listados na tabela abaixo:

Parâmetro Obrigatório Tipo Tam. Descrição
codigo_servico
string 6 Código de serviço
00.00.00
codigo_tributacao_municipio
string 3 Código de Tributação no município
000
tributacao_iss
numero 1 Tributação do ISSQN sobre o serviço prestado
1 - Operação tributável
2 - Imunidade
4 - Não Incidência
tipo_imunidade
numero 1 Identificação da Imunidade do ISSQN – somente para o caso de Imunidade
0 - Imunidade (tipo não informado na nota de origem)
1 - Patrimônio, renda ou serviços, uns dos outros (CF88, Art 150, VI, a)
2 - Templos de qualquer culto (CF88, Art 150, VI, b)
3 - Patrimônio, renda ou serviços dos partidos políticos, inclusive suas fundações, das entidades sindicais dos trabalhadores, das instituições de educação e de assistência social, sem fins lucrativos, atendidos os requisitos da lei (CF88, Art 150, VI, c)
4 - Livros, jornais, periódicos e o papel destinado a sua impressão (CF88, Art 150, VI, d)
5 - Fonogramas e videofonogramas musicais produzidos no Brasil contendo obras musicais ou literomusicais de autores brasileiros e/ou obras em geral interpretadas por artistas brasileiros bem como os suportes materiais ou arquivos digitais que os contenham, salvo na etapa de replicação industrial de mídias ópticas de leitura a laser. (CF88, Art 150, VI, e)
pis_cofins_retido
numero 1 Retenção dos impostos PIS/COFINS
1 - Retido
2 - Não Retido
data_competencia
string 10 Data da competência
Formato: YYYY-MM-DD
codigo_nbs
string 9 Código da Nomenclatura Brasileira de Serviços
codigo_interno
string 1-20 Código interno do contribuinte
uf_local_prestacao
string 2 UF do local de prestação do serviço
cidade_local_prestacao
string 1-25 Cidade do local de prestação do serviço
informacoes_complementares
string 1-2000 Informações complementares relacionadas ao serviço prestado.

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:

Parâmetro Obrigatório Tipo Tam. Descrição
codigo_servico
string 5 Código de serviço
00.00
natureza_operacao
string 1 Código de natureza da operação
1 - Tributação no município
2 - Tributação fora do município
3 - Isenção
4 - Imune
5 - Exigibilidade suspensa por decisão judicial
6 - Exigibilidade suspensa por procedimento administrativo
notas_deducao
array 0-n Notas para dedução do ISS Contrução Civil.
parcelas
array 0-n Parcelas vinculadas à condição de pagamento.
Notas Dedução
Parâmetro Obrigatório Tipo Tam. Descrição
numero
string --- Número da NFS-e<
valor
string --- Valor da NFS-e
0.00
chave
string --- Chave de validação da NFS-e.
Parcelas
Parâmetro Obrigatório Tipo Tam. Descrição
condicao
string 1 Condição de pagamento da parcela
1 - Á vista
2 - Apresentação
3 - Prazo
4 - Débito
5 - Crédito
valor
string --- Valor da parcela
0.00
data_vencimento
string 10 Data de vencimento da parcela.
Formato: AAAA-MM-DD

Emissão de Nota Fiscal
Provedor Prescon

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

Parâmetro Obrigatório Tipo Tam. Parâmetro Pai Descrição
codigo_servico
string 4-6 servico Código de serviço
"0000"
municipio_incidencia
string 9 servico Código IBGE do município de incidência do imposto.
endereco
objeto --- servico Informações do endereço do local de prestação do serviço.
Endereço do Local de Prestação
Parâmetro NFS-e Tipo Tam. Descrição
endereco
string 1-40 Endereço do local
numero
string 1-40 Número do endereço
complemento
string 1-40 Complemento do endereço
bairro
string 1-40 Bairro do endereço
cidade
string 1-40 Cidade do endereço
uf
string 2 UF do endereço
cep
string 1-40 CEP do endereço

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:

Parâmetro Obrigatório Tipo Tam. Descrição
codigo_servico
string 5 Código de serviço
00.00
valor_recebido
string 13v2 Total do valor recebido em R$ pelo serviço prestado
0.00

Emissão de Nota Fiscal
Provedor SIGISS

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

Parâmetro Obrigatório Tipo Tam. Descrição
codigo_servico
string 3-4 Código de serviço
0000
tributacao
número 1 Tipo de tributação
1 - Tributada no prestador
2 - Tributada no tomador
3 - Isenta
4 - Imune
5 - Não tributada


Provedor Sigissweb

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

Parâmetro NFS-e Tipo Tam. Descrição
codigo_nbs
string9Código da Nomenclatura Brasileira de Serviços
Obrigatório para o município de Valinhos-SP

Além dos parâmetros de intermediário na emissão pode-se também informar os seguintes parâmetros:

Dados do Intermediário
Parâmetro NFS-e Tipo Tam. Descrição
ie
string1-20Inscrição Estadual do intermediário
uf
string2UF do intermediário
endereco
string1-60Endereço do intermediário
cep
string8CEP do intermediário
cidade
string1-40Cidade do intermediário
bairro
string1-40Bairro do intermediário
numero
string1-10Número do endereço do intermediário
complemento
string1-60Complemento do endereço do intermediário

Provedor Thema

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

Parâmetro Obrigatório Tipo Tam. Descrição
codigo_servico
string 5 Código de serviço
00.00
codigo_cnae
string 7 Código CNAE
codigo_tributacao_municipio
string 1-20 Código de Tributação no município
uf_local_prestacao
string 2 UF do local de prestação do serviço
cidade_local_prestacao
string 1-20 Cidade do local de prestação do serviço
natureza_operacao
número 1 Código de natureza da operação
Prestação de Serviços no Município:
1 - Imposto devido no município, com obrigação de retenção na fonte.
2 - Imposto devido no município, sem obrigação de retenção na fonte.
3 - Exigibilidade suspensa por decisão judicial.
4 - Imposto devido no município, com obrigação de retenção na fonte, tributado de acordo com o Regime Único de Arrecadação (Simples Nacional).
5 - Isento.
6 - Imune.
7 - Imposto recolhido pelo Regime Único de Arrecadação (ISSQN fixo).
8 - Não tributável.
9 - Imposto recolhido pelo Regime Único de Arrecadação (Simples Nacional).
10 - Imposto recolhido com valor fixo.
Prestação de Serviços para outros municípios da federação:
11 - Imposto devido no município, com obrigação de retenção na fonte.
12 - Imposto devido no município, sem obrigação de retenção na fonte.
13 - Exigibilidade suspensa por decisão judicial.
14 - Imposto devido fora do município, com obrigação de retenção na fonte.
15 - Isento.
16 - Imune.
17 - Imposto devido fora do município, sem obrigação de retenção na fonte.
18 - Não tributável.
19 - Imposto recolhido pelo Regime Único de Arrecadação (Simples Nacional).
20 - Imposto recolhido com valor fixo.
Prestação de Serviços para o Exterior:
21 - Imposto devido no município.
22 - Imposto recolhido pelo Regime Único de Arrecadação (Simples Nacional).
23 - Não tributável.

Funções
Download XML e PDF da Nota Fiscal

Para os planos MEI, START e PME em vigor para todos os modelos.
Planos Business, Corporate e Enterprise em vigor a partir de 7 de outubro de 2024.

Na Webmania, a segurança da informação é nossa prioridade máxima. Por esse motivo, aplicamos restrições de acesso aos arquivos XML e PDF para garantir a segurança dos documentos fiscais.

O documento fiscal é criptografado com senha, e só pode ser visualizado após a confirmação do CPF/CNPJ do tomador da nota fiscal ou conforme formas de autenticação através do IP emissor, Credenciais de acesso, Token ou Conectado no painel Webmania®.

Atenção! Download e disponibilidade do XML/PDF no seu sistema
A disponibilidade dos documentos fiscais dentro do seu sistema, devem seguir níveis rigorosos de segurança com restrições similares aos adotados pela Webmania. Também não se deve permitir o acesso público de documentos fiscais em seu sistema, que não estejam criptografados por senha.

Segue abaixo as condições de acesso disponibilizados, após as restrições serem aplicadas:

Autenticação Acesso autorizado Exige senha? Descrição
Credenciais de acesso ✅ Não Ao enviar as credenciais de acesso da empresa na HEADER da requisição, podem ser acessados todos os documentos fiscais emitidos pela empresa.
Authorization: Bearer SEU_ACCESS_TOKEN
Token ✅ Não Ao enviar o token criptografado na URL, o documento fiscal pode ser acessado pelo período de 24 horas sem o uso de senha. Ideal para disponibilizar link para compartilhamento.
?token=[TOKEN]
Token não está disponível para documentos fiscais sem tomador.
IP emissor ✅ Não Ao emitir uma nota fiscal o IP do computador/servidor é registrado como autorizado de forma permanente, onde pode acessar todos os documentos fiscais emitidos pelas empresas às quais possui acesso.
IPs autorizados automaticamente
Painel Webmania® ✅ Não Ao realizar o login no painel Webmania® é permitido o acesso para todos os documentos fiscais emitidos pelas empresas da sua conta. O acesso é vinculado ao período que está conectado no painel Webmania®.
Acesso enquanto estiver conectado
Sem autenticação ❌ Sim Ao acessar a URL de forma pública sem autenticação, os documentos fiscais são criptografados com senha. Para acessá-los é necessário informar o CPF/CNPJ do tomador da nota fiscal (somente números).
PDF = Arquivo PDF com senha
XML = ZIP com senha

Acesso sem autenticação não está disponível para documentos fiscais sem tomador.

Funções > Download XML e PDF da Nota Fiscal
Credenciais de acesso

Ao enviar as credenciais de acesso da empresa na HEADER da requisição, podem ser acessados todos os documentos fiscais emitidos pela empresa. Segue abaixo exemplo de como visualizar o PDF, utilizando as credenciais de acesso:

curl -X GET \
-H "Authorization: Bearer SEU_ACCESS_TOKEN" \
https://api.webmaniabr.com/nfse/00000000-0000-0000-0000-000000000000

A resposta do corpo da mensagem será no formato application/pdf ou text/xml, contendo no corpo da requisição o arquivo.

Funções > Download XML e PDF da Nota Fiscal
Token

Atenção: Este recurso não está disponível para documentos fiscais sem tomador. O acesso para esses documentos, devem ser realizados via Credenciais de acesso.

Para disponibilizar o link do PDF e XML com segurança e eliminar a exigência da senha, é necessário a geração do token de forma criptografada utilizando a camada de segurança AES-256-CBC. Após gerar o token, deve ser enviado na URL do arquivo. Segue abaixo exemplo:

https://api.webmaniabr.com/nfse/00000000-0000-0000-0000-000000000000?token=[TOKEN]

Pare gerar o token criptografado, verifique o passo a passo disponibilizado no Github da Webmania juntamente com as funções nas linguagens em PHP, Python, Java, C# e Ruby: https://github.com/webmaniabr/DFeToken.

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, pdf_rps, pdf_nfse, pdf_nfse_status, 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]", // PDF da prefeitura da NFS-e (quando disponível)
  "pdf_nfse_status": "processado",  // processado, processando, indisponivel (quando disponível)
  "xml": "http://api.webmaniabr.com/xmlnfse/[uuid]",
  "log": "{...}", // Log de retorno da prefeitura
  "atualizado_em": "2024-01-01T12:00:00-03:00" // Momento em que ocorreu a última alteração do status
}

Funções
Cancelar Nota Fiscal | Agendamento

Para cancelar uma Nota Fiscal de Serviço ou um agendamento, 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.

Parâmetro NFS-e Tipo Tam. Descrição
uuid
string 36 UUID da NFS-e
motivo
número 1 Motivo do cancelamento
1 - Erro na emissão
2 - Serviço não prestado
4 - Duplicidade da nota

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.

Parâmetro NFS-e Tipo Tam. Descrição
ambiente
número 1 Ambiente de emissão da substituição. 1 - Produção
2 - Homologação
codigo_verificacao
string --- Código de verificação da Nota Fiscal a ser substituída
motivo
número 1 Motivo da substituição
1 - Erro na emissão
2 - Serviço não prestado
4 - Duplicidade da nota
rps
objeto 1 RPS que será convertido em Nota Fiscal de Serviço e irá substituir a nota informada.

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
}

Funções
Manifestar participação

A manifestação da participação na Nota Fiscal de Serviço, disponível somente para o Padrão Nacional, permite ao tomador ou intermediário confirmar ou rejeitar uma nota emitida contra ele.

Para realizar a manifestação, envie a requisição no método POST para URL /2/nfse/manifestar contendo na requisição os parâmetros conforme a tabela abaixo:

Parâmetro NFS-e Tipo Tam. Descrição
ambiente
número 1 Ambiente de emissão da NFS-e. 1 - Produção
2 - Homologação
chave|uuid
string 50|36 Chave ou UUID da NFS-e em que será manifestada a participação
manifestador
numero 1 Participação do manifestador na NFS-e
1 - Tomador
2 - Intermediário
evento
numero 1 Tipo do Evento de Manifestação
1 - Confirmação
2 - Rejeição
motivo_rejeicao
número 1 Motivo da rejeição da participação na NFS-e.
Obrigatório para o evento de rejeição.
1 - NFS-e em duplicidade
2 - NFS-e já emitida pelo tomador
3 - Não ocorrência do fato gerador
4 - Erro quanto a responsabilidade tributária
5 - Erro quanto ao valor do serviço, valor das deduções ou serviço prestado ou data do fato gerador
9 - Outros
justificativa_rejeicao
string 15-255 Justificativa da rejeição da participação na NFS-e.
Obrigatório caso o motivo da rejeição seja 9 - Outros.

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

curl -X POST \
-H "Authorization: Bearer SEU_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
   "ambiente": 1,
   "chave": "00000000000000000000000000000000000000000000000000",
   "manifestador": 1, // Tomador
   "evento": 1 // Confirmação,
}' \
https://api.webmaniabr.com/2/nfse/manifestar

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

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "modelo": "manifestacao_nfse",
  "status": "aprovado",
  "motivo": "Manifestação aprovada com sucesso.",
  "chave": "00000000000000000000000000000000000000000000000000",
  "xml": "https://api.webmaniabr.com/xmlnfse/[uuid]",
  "log": "{...}" // Log de retorno
}

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

Infraestrutura

O servidores da Webmania estão localizados na Amazon AWS, líder global em cloud computing, na região us-east-1 (Leste dos EUA) com ponto de presença em sa-east-1 (São Paulo). Manter a sua estrutura perto de algumas das duas localidades, garante um menor tempo de resposta nas requisições na API.

Utilizamos uma infraestrutura na Amazon AWS anycast de alta disponibilidade, o que significa que ao se comunicar com API da Webmania a requisição será redirecionada para o servidor mais próximo da sua localidade. As requisições dos endpoints são gerenciados através de IPs estáticos, caso necessite autorize no firewall a comunicação com os IPs abaixo.

IPs estáticos de entrada:
  • 13.248.145.90
  • 76.223.17.240
IPs estáticos de saída (notificações):
  • 34.196.69.38
  • 44.219.142.86

Limite de requisições

API da Webmania® é protegida por um firewall que identifica de forma automática os acessos indevidos, suspeitos, credenciais incorretas e a localização da requisição, onde também pode limitar solicitações por segundo e o total de requisições para evitar o mal uso da API e a sobrecarga dos servidores. O uso indevido da API pode gerar mensagens de erro 503 ou 403 no retorno do cabeçalho da requisição. Segue abaixo especificações para uma correta integração:

  • Localização do servidor: O firewall bloqueia por padrão o IP de servidores suspeitos ou de baixa reputação. Caso a sua comunicação via GET no endpoint https://webmaniabr.com/api/ ou https://api.webmaniabr.com retorne 403 Erro Forbidden por engano, por favor, entre em contato para liberarmos o IP do seu servidor.
  • Limite de requisições:
    - GET: 4.500 requisições a cada 5 minutos (15/reqs/s).
    - POST/PUT/DELETE: 10.000 requisições a cada 5 minutos (30/reqs/s).
    Precisa de um volume maior de requisições? Por favor, entre em contato para liberação.
  • Credenciais de acesso: Os endpoints exigem as credenciais de acesso válida e correta na HEADER da requisição, o envio incorreto é atribuído como uso indevido da API.
  • URL de notificação: Realize a integração para obter todos os retornos da API via URL de notificação, dessa forma todos os processos podem ser realizados ao receber o retorno, como atualizar o banco de dados e o download do Danfe e XML.

Soluções

Emissor de Nota Fiscal Consulta de QR Code e Chave

Documentação

API Nota Fiscal de Produto API Nota Fiscal de Serviço API Conhecimento de Transporte API Manifesto Eletrônico API Consulta QR Code e Chave API Gerencial B2B

Webmania

Clientes Sobre nós Blog

Cases

Nordweg Podi App

Transparência

Política de Cookies Política de Privacidade Política Fiscal Política de Segurança Termos de uso

Escritórios

Paraná

Matriz: Av. Água Verde, 1413 - 5º andar, Água Verde, Curitiba - PR

São Paulo

Webmania SP: Alameda Vicente Pinzon, 54 - 10º andar, Vila Olímpia, São Paulo - SP

Santa Catarina

Webmania SC: Av. Afonso Dresch, 663, Centro, Treze Tílias - SC

Fale conosco

Acesso rápido

Painel do Cliente Central de Ajuda 2ª via de Boleto Fale conosco Status Webmania® Monitor Sefaz Monitor Prefeituras Monitor Consultas
Instagram Webmania Linkedin Webmania Twitter Webmania
GitHub Webmania Telegram Webmania Youtube Webmania
Cubo Itaú
Webmania

Copyright © 2009-2025 Webmania®.
Webmania® é uma marca registrada e de uso exclusivo da WMBR SERVICOS EMPRESARIAIS LTDA
CNPJ: 11.290.027/0001-82 sediada na Av. Água Verde, 1413, 5º andar - Curitiba, PR - CEP 80620-200

Voltar para o topo
Usamos cookies para melhorar sua experiência na Webmania®. Consulte mais informações na nossa Política de Privacidade e Política de Cookies .
Entendi e aceito