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.webmania.com.br. 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."
}

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 (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.webmania.com.br/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:

{
  "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:

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.

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.

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": "https://api.webmania.com.br/xmlnfse/[uuid]",
            "pdf_nfse": "https://api.webmania.com.br/nfse/[uuid]",
            "pdf_nfse_status": "processado",
            "pdf_rps": "https://api.webmania.com.br/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": "https://api.webmania.com.br/xmlnfse/[uuid]",
            "pdf_nfse": "https://api.webmania.com.br/nfse/[uuid]",
            "pdf_nfse_status": "processando",
            "pdf_rps": "https://api.webmania.com.br/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.

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": "https://api.webmania.com.br/xmlnfse/[uuid]",
    "pdf_nfse": "https://api.webmania.com.br/nfse/[uuid]",
    "pdf_nfse_status": "indisponivel",
    "pdf_rps": "https://api.webmania.com.br/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.webmania.com.br/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": "https://api.webmania.com.br/xmlnfse/[uuid]", // XML da NFS-e
      "pdf_nfse": "https://api.webmania.com.br/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": "https://api.webmania.com.br/darps/[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.

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": "https://api.webmania.com.br/xmlnfse/[uuid]", // XML da NFS-e
  "pdf_nfse": "https://api.webmania.com.br/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": "https://api.webmania.com.br/darps/[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 > Impostos
IBS/CBS

Para incluir os novos impostos em suas notas fiscais, adicione o array ibs_cbs dentro do campo impostos nas informações do serviço de cada RPS.

A tabela abaixo lista os parâmetros que podem ser enviados dentro do array:

Segue exemplo de como preencher as informações de tributação do IBS e CBS:

{
  "rps": [
    {
      ...
      "tomador": {...},
      "servico": {
        "valor_servicos": "15.00",
        "discriminacao": "Prestação de Serviço referente ao mês X",
        ...
        "impostos": {
          "iss": "2.00",
          "ibs_cbs": {
            "situacao_tributaria": "000",
            "classificacao_tributaria": "000001",
            "ibs_estadual": {...},
            "ibs_municipal": {...},
            "cbs": {...}
          }
        }
      }
    }
  ]
}

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

Para as informações de tributação estadual do IBS, adicione o array ibs_estadual dentro do campo ibs_cbs.

A tabela abaixo lista os parâmetros que podem ser enviados dentro do array:

Segue exemplo de preenchimento do IBS Estadual:

"ibs_estadual": {
  "aliquota_diferimento": "5.00", // Percentual do diferimento
  "valor_devolvido": "10.00" // Valor do tributo devolvido
}

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

Para as informações de tributação municipal do IBS, adicione o array ibs_municipal dentro do campo ibs_cbs.

A tabela abaixo lista os parâmetros que podem ser enviados dentro do array:

Segue exemplo de preenchimento do IBS Municipal:

"ibs_municipal": {
  "aliquota_diferimento": "50.00", // Percentual do diferimento
  "valor_devolvido": "10.00" // Valor do tributo devolvido
}

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

Para as informações do CBS, adicione o array cbs dentro do campo ibs_cbs.

A tabela abaixo lista os parâmetros que podem ser enviados dentro do array:

Segue exemplo de preenchimento do CBS:

"cbs": {
  "aliquota_diferimento": "50.00", // Percentual do diferimento
  "valor_devolvido": "10.00" // Valor do tributo devolvido
}

Emissão de Nota Fiscal > RPS > Serviço > Impostos
Crédito Presumido

O crédito presumido permite o aproveitamento de créditos fiscais em situações específicas. Para utilizá-lo, adicione o array credito_presumido dentro do campo ibs_cbs.

A tabela abaixo lista os parâmetros que podem ser enviados dentro do array:

Segue exemplo de preenchimento do crédito presumido:

"credito_presumido": {
  "classificacao": "5", // Código da classificação
  "aliquota_ibs": "0.10", // Percentual do IBS
  "aliquota_cbs": "0.05" // Percentual do CBS
}

Emissão de Nota Fiscal > RPS > Serviço > Impostos
Transferência de Crédito

Quando houver transferência de créditos do IBS e CBS (situação tributária 800), adicione o array transferencia_credito dentro do campo ibs_cbs:

A tabela abaixo lista os parâmetros que podem ser enviados dentro do array:

Segue exemplo de preenchimento da transferência de crédito:

"transferencia_credito": {
  "valor_ibs": "2.50", // Valor do IBS a transferir
  "valor_cbs": "4.00" // Valor do CBS a transferir
}

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 > Serviço
Ente Governamental

Preencha o bloco ente_governamental quando a prestação de serviço for destinada à administração pública direta e suas autarquias ou fundações. A tabela abaixo lista os parâmetros que podem ser enviados dentro do array:

Emissão de Nota Fiscal > RPS > Serviço
Reembolso/Repasse

O parâmetro reembolso_repasse deve ser enviado nos casos de reembolso, repasse ou ressarcimento que serão considerados na base de cálculo do ISSQN, do IBS e da CBS. A tabela abaixo lista os parâmetros que podem ser enviados dentro do array:

Emissão de Nota Fiscal > RPS > Serviço > Reembolso/Repasse
Documentos

Esta seção apresenta os tipos de documentos que podem ser referenciados para validar a operação de reembolso/repasse.

A tabela abaixo lista os parâmetros que podem ser enviados dentro do array, é obrigatório preencher pelo menos um dos grupos de documentos: dfe_nacional, dfe_outro ou doc_outro.

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

Emissão de Nota Fiscal > RPS
Destinatário

As informações do destinatário do serviço são montadas dentro do objeto destinatario conforme mostrado nas subseções abaixo.

Para destinatários que residem fora do país, informe os dados completos do destinatário estrangeiro:

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.

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.

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

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.

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

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:

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.

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 Equiplano

Os campos específicos para emissão de Nota Fiscal de Serviço para o provedor Equiplano estão listados nas tabelas 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 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:

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:

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

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:

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

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:

Reforma Tributária

📅 Quando começa?

Reforma Tributária
Novos Campos da Reforma Tributária

Com a chegada da Reforma Tributária, novos campos foram adicionados ao layout de emissão de NFS-e. Os novos campos estão listados na tabela abaixo:

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

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

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.webmania.com.br/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": "https://api.webmania.com.br/darps/[uuid]",
  "pdf_nfse": "https://api.webmania.com.br/nfse/[uuid]", // PDF da prefeitura da NFS-e (quando disponível)
  "pdf_nfse_status": "processado",  // processado, processando, indisponivel (quando disponível)
  "xml": "https://api.webmania.com.br/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.

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.webmania.com.br/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.webmania.com.br/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.webmania.com.br/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.webmania.com.br/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:

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.webmania.com.br/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.webmania.com.br/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