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.

Webmania
  • Para sua empresa
  • Para desenvolvedores
  • Sobre nós
  • Contato
  • Área do cliente
  • Para sua empresa

    Emissor de Nota Fiscal
    Consulta de Nota Fiscal
    Consulta de CEP e IBGE
  • Para desenvolvedores

    Documentação
    Comece a integrar com as APIs da Webmania

    Guias

    Nota Fiscal de Produto Nota Fiscal de Serviço Manifesto Eletrônico Consulta Nota Fiscal Consulta CEP

    Comece já

    Teste 30 dias grátis Módulos & Exemplos Guia Loja Virtual Testar sem código
  • Sobre nós

    Notícias
    Quem somos
    Clientes
  • Contato

    WhatsApp
    Fale Conosco
  • Área do cliente

    Entrar
    Acessar painel
    Acesso rápido
    2º via Boleto Central de ajuda Financeiro
    Suporte técnico
    Abrir chamado
    Comercial
    Fale conosco
Entrar
  • REST API Nota Fiscal
  • Guia Rápido
  • Módulos & Exemplos
  • Autenticação
  • Notificações
  • Emissão de Nota Fiscal
    • Informações da Nota Fiscal
      • Informações
      • Datas
      • Nota Fiscal referenciada
      • Comandos
    • Informações do Cliente
      • Cliente
      • Estrangeiro
    • Informações dos Produtos
      • Produtos
      • Exportação
      • Importação
      • Rastreabilidade
      • Combustíveis
      • Medicamento
      • Armamentos
      • Veículos Novos
    • Informações do Pedido
      • Pedido
      • Pagamento
    • Transporte
      • Transportadora
      • Reboque
      • Local de Entrega
      • Local de Retirada
    • Fatura
    • Parcelas
    • Exportação
  • Classe de imposto
    • Cenários
    • Criar/Editar
      • ICMS
      • Alíquota MVA
      • Alíquota ICMS
      • Alíquota ICMS-ST
      • Alíquota FCP
      • Alíquota FCP-ST
      • Benefício fiscal
      • IPI
      • PIS
      • COFINS
      • ISSQN
    • Listar
    • Excluir
  • Impostos na API
    • ICMS
      • Simples Nacional
      • Tributação Normal
      • MVA
      • Pauta Fiscal
      • Valor da Operação
    • IPI
    • PIS
    • COFINS
    • ISSQN
    • Retenção de Tributos
    • Importação
    • Cálculo dos Impostos
  • Modelos de emissão
    • Nota fiscal Devolução/Estorno
    • Nota fiscal Ajuste
    • Nota fiscal Complementar
      • Preço e/ou quantidade
      • Imposto Complementar
    • Carta de Correção (CC-e)
    • Manifestação do Destinatário
  • Funções
    • Status Sefaz
    • Validade Certificado A1
    • Consultar Nota Fiscal
    • Cancelar Nota Fiscal
    • Inutilizar Numeração
    • Exportar Relatórios
  • Atualizar empresa
    • Informações principais
    • Endereço
    • Nota Fiscal
    • Certificado A1
    • Opcionais
  • Informações
    • Notas em Processamento
    • Notas em Contingência
    • Infraestrutura
    • Limite de requisições
⚡ Acompanhe em tempo real: Status Webmania® | Monitor Sefaz | Telegram | Twitter
Versão: 3.8.2

REST API de Nota Fiscal Eletrônica

Documentação para emissão de Nota Fiscal dos modelos NF-e, NFC-e, CC-e e MDe

Utilize a REST API de Nota Fiscal da Webmania®
A partir de R$36,90/mês: Experimente por 30 dias grátis

Utilize a REST API da Webmania®, para emissão de Nota Fiscal Eletrônica (NF-e), Nota Fiscal do Consumidor Eletrônica (NFC-e), Carta de Correção (CC-e) e Manifestação do Destinatário (MDe).

Deseja emitir outros modelos? Ver documentação

Impostos Webmania®
Tributações em constante sincronia com a Secretaria da Fazenda na definição dos cálculos e alíquotas automático, atendendo todos os tributos federais e estaduais.
Disponibilidade e Segurança
Alta disponibilidade, escalonável 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 via JSON. Garantia de baixa latência com mais de 200 pontos de presença na rede Amazon Web Services.
Contingência das Notas Fiscais
Emissão de Notas Fiscais contínuas, através do manuseio automático no ambiente de contingência do SEFAZ. Emissão offline da NFC-e e SVC/SVRS para NF-e.
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 100% online e humano 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://webmaniabr.com/api/. O prefixo /1/ indica que atualmente nós estamos utilizando a versão 1.0 da API.

URL HTTP Verb Função
/1/nfe/emissao/ POST Emissão de Nota Fiscal
/1/nfe/devolucao/ POST Emissão de Nota Fiscal de Devolução/Estorno
/1/nfe/ajuste/ POST Emissão de Nota Fiscal de Ajuste
/1/nfe/complementar/ POST Emissão de Nota Fiscal Complementar
/1/nfe/cartacorrecao/ POST Emissão da Carta de Correção
/1/nfe/manifesta/ POST Manifestação do destinatário
/1/nfe/classe-imposto/ POST Criar/Editar Classe de Imposto
/1/nfe/empresa/ POST Atualizar empresa
/1/nfe/relatorios/ POST Exportar relatórios CSV, XML e Danfe
/1/nfe/consulta/ GET Consulta de Nota Fiscal
/1/nfe/sefaz/ GET Status do Sefaz
/1/nfe/certificado/ GET Validade do Certificado A1
/1/nfe/classe-imposto/ GET Listar Classe de Impostos
/1/nfe/cancelar/ PUT Cancelar Nota Fiscal
/1/nfe/inutilizar/ PUT Inutilizar Numeração
/1/nfe/classe-imposto/ DELETE Excluir Classe de Imposto

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:

{
  "error": "Access Token e Access Token Secret não conferem."
}

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
    • PrestaShop
    • Magento
    • OpenCart
  • Linguagens
    • AngularJS
    • C#
    • Go
    • Java
    • Javascript
    • jQuery Ajax
    • NodeJS
    • Objective-C
    • PHP
    • Python 3.0
    • Python 2.0 ou inferior
    • Ruby
    • Swift

Autenticação

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

A autenticação é realizada através do cabeçalho HTTP (HTTP headers). É necessário o envio do X-Consumer-Key e X-Consumer-Secret da sua aplicação, juntamente com o X-Access-Token e X-Access-Token-Secret do seu usuário.

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

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

Notificações

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

Cada Nota Fiscal possui um número único de identificação chamado de UUID, este número deve ser utilizado para recepcionar e identificar a Nota Fiscal para atualizar as informações no seu banco de dados. A chave da nota fiscal pode sofrer alterações quando emitida em ambiente de contingência.

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 contendo no corpo os parâmetros uuid, status, motivo, nfe, serie, recibo, chave, xml, danfe, log e data.

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.
status string Status da Nota Fiscal
aprovado
reprovado
cancelado
denegado
processamento
contingencia
motivo string Motivo do status
Ex.: Autorizado o uso da NF-e
nfe integer Número de emissão
Gerenciado automaticamente pelo emissor.
serie integer Série de emissão
recibo integer Número do recibo
- Retornado somente quando a Nota Fiscal possui o status aprovado.
- NF-e não é emitido recibo para os estados PE, MG, MT, GO, AC, AL, AP, DF, ES, PB, PI, RJ, RN, RO, RR, SC, SE, TO e PA.
- NFC-e não é emitido recibo para todos os estados.
chave integer Chave de identificação da Nota Fiscal no Sefaz
modelo string Modelo da Nota Fiscal
nfe
nfce
cce
xml string URL do XML da Nota Fiscal
danfe string URL do Danfe da Nota Fiscal
log array Log de retorno do Sefaz
data array Informações enviadas para emissão da Nota Fiscal

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

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

Segue exemplo do retorno via POST:

["uuid"] = "43eace5c-8008-4f6c-b830-b6d52d7ff90c",
["status"] = "aprovado",
["motivo"] = "Autorizado o uso da NF-e",
["nfe"] = "25000",
["serie"] = "1",
["recibo"] = "000000000000000",
["chave"] = "00000000000000000000000000000000000000000000",
["modelo"] = "nfe",
["xml"] = "http://nfe.seudominio.com.br/xmlnfe/[chave|uuid]/",
["danfe"] = "http://nfe.seudominio.com.br/danfe/[chave|uuid]/",
["log"] = "[...]"
["data"] = "[...]"

Emissão de Nota Fiscal

Para emitir uma Nota Fiscal Eletrônica, envie a requisição no método POST para a URL /1/nfe/emissao/ contendo no corpo da requisição os objetos no formato JSON.

  curl -X POST \
  -H "X-Consumer-Key: SEU_CONSUMER_KEY" \
  -H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
  -H "X-Access-Token: SEU_ACCESS_TOKEN" \
  -H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "ID":1337,
    "modelo":"1",
    "natureza_operacao":"Venda de produção do estabelecimento", 
    ...
  }' \
  https://webmaniabr.com/api/1/nfe/emissao/

Segue abaixo exemplo de como Emitir Nota Fiscal de venda para Pessoa Física:

{
  "ID": 1137,
  "url_notificacao": "http://meudominio.com/retorno.php",
  "operacao": 1,
  "natureza_operacao": "Venda de produção do estabelecimento",
  "modelo": 1,
  "finalidade": 1,
  "ambiente": 1,
  "cliente": {
    "cpf": "000.000.000-00",
    "nome_completo": "Nome do Cliente",
    "endereco": "Av. Brg. Faria Lima",
    "complemento": "Escritório",
    "numero": 1000,
    "bairro": "Itaim Bibi",
    "cidade": "São Paulo",
    "uf": "SP",
    "cep": "00000-000",
    "telefone": "(00) 0000-0000",
    "email": "nome@email.com"
  },
  "produtos": [
  {
    "nome": "Nome do produto",
    "codigo": "nome-do-produto",
    "ncm": "6109.10.00",
    "cest": "28.038.00",
    "quantidade": 3,
    "unidade": "UN",
    "peso": "0.800",
    "origem": 0,
    "subtotal": "44.90",
    "total": "134.70",
    "classe_imposto": "REF1000"
  },
  {
    "nome": "Nome do produto",
    "codigo": "nome-do-produto",
    "ncm": "6109.10.00",
    "cest": "28.038.00",
    "quantidade": "1",
    "unidade": "UN",
    "peso": "0.200",
    "origem": 0,
    "subtotal": "29.90",
    "total": "29.90",
    "classe_imposto": "REF1000"
  }
  ],
  "pedido": {
    "pagamento": 0,
    "presenca": 2,
    "modalidade_frete": 0,
    "frete": "12.56",
    "desconto": "10.00",
    "total": "174.60"
  }
}

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos uuid,status, motivo, nfe, serie, recibo, chave, xml, danfe e log:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "aprovado", // aprovado, reprovado, cancelado, denegado, processamento ou contingencia
  "motivo": "Autorizado o uso da NF-e", // Motivo do status
  "nfe": "25000", // Número da NF-e
  "serie": "1", // Número de série
  "modelo": "nfe", // Modelo da Nota Fiscal (nfe, nfce, cce)
  "recibo": "000000000000000", // Número do recibo
  "chave": "00000000000000000000000000000000000000000000", // Número da chave de acesso
  "xml": "http://nfe.seudominio.com.br/xmlnfe/[chave|uuid]/",
  "danfe": "http://nfe.seudominio.com.br/danfe/[chave|uuid]/",
  "danfe_simples": "http://nfe.seudominio.com.br/danfe/simples/[chave|uuid]/", // Danfe Simplificada
  "danfe_etiqueta": "http://nfe.seudominio.com.br/danfe/etiqueta/[chave|uuid]/", // Danfe Simplificada - Etiqueta
  "log": "{...}" // Log de retorno do SEFAZ
}

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

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 saída, entrada, exportação ou importaçã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 NF-e NFC-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
operacao
integer 1 Tipo de Operação da Nota Fiscal
1 - Saída
0 - Entrada
natureza_operacao
string 1-60 Natureza da Operação
modelo
string 1 Modelo da Nota Fiscal
1 - NF-e
2 - NFC-e
finalidade
integer 1 Finalidade de emissão da Nota Fiscal. Nota Fiscal de Ajuste e Complementar possuem endpoints de emissão separados.
1 - NF-e normal
3 - Ajuste/Estorno
4 - Devolução
ambiente
integer 1 Identificação do Ambiente do Sefaz
1 - Produção
2 - Homologação
url_notificacao
string --- URL de notificação para todas as atualizações de status da Nota Fiscal
cliente
array --- Informações do cliente
produtos
array (objetos) 1-990 Informações de todos os produtos adquiridos
pedido
array --- Informações do pedido
transporte
array --- Informações do transporte
fatura
array --- Fatura referente a Nota Fiscal
parcelas
array (objetos) 0-120 Parcelas referentes a Nota Fiscal
exportacao
array --- Informações da exportação

Informe as datas da Nota Fiscal caso necessário. Os valores são preenchidos automaticamente, mas podem ser editados conforme necessidade:

Datas
Parâmetro NF-e NFC-e Tipo Tam. Descrição
data_emissao
string 19 Informar data e hora da emissão.
Formato americano:
YYYY-MM-DD HH:MM:SS
data_entrada_saida
string 19 Informar data e hora de Entrada ou Saída diferente da data de emissão.
Formato americano:
YYYY-MM-DD HH:MM:SS
data_servico
string 10 Informar data da prestação do serviço nas operações com ISSQN
Formato americano:
YYYY-MM-DD
{
  "operacao": 1,
  "natureza_operacao": "Venda de produção do estabelecimento",
  "modelo": 1,
  "finalidade": 1,
  "ambiente": 1,
  "data_emissao": "0000-00-00 00:00:00", // Emissão com data retroativa
  "data_entrada_saida": "0000-00-00 00:00:00",
  "cliente": { ... },
  "produtos": [ ... ],
  "pedido": { ... }
}

Para referenciar uma Nota Fiscal emitida anteriormente informe a chave da NF-e de 44 dígitos, para referenciar uma NF de Produtor Rural informe todos os parâmetros obrigatórios.

Nota Fiscal Referenciada
Parâmetro NF-e NFC-e Tipo Tam. Descrição
nfe_referenciada
string
array
44 Chave de acesso da NF-e emitida anteriormente.
Pode ser informado mais de uma NF-e referenciada através de uma array.
cte_referenciada
string
array
44 Chave de acesso do CT-e referenciada.
Pode ser informado mais de uma CT-e referenciada através de uma array.
ecf_referenciada
string
array
--- Informações do Cupom Fiscal (ECF)
nf_rural_referenciada
string
array
--- Informações da NF de Produtor Rural
{
  "operacao": 1,
  "natureza_operacao": "Venda de produção do estabelecimento",
  "modelo": 1,
  "finalidade": 1,
  "ambiente": 1,
  "nfe_referenciada": [
    "00000000000000000000000000000000000000000000",
    "00000000000000000000000000000000000000000000"
  ],
  "cliente": { ... },
  "produtos": [ ... ],
  "pedido": { ... }
}
Cupom Fiscal (ECF) referenciado
Parâmetro NF-e NFC-e Tipo Tam. Descrição
modelo
string 2 Modelo do Documento Fiscal
2B = Cupom Fiscal emitido por máquina registradora (não ECF)
2C = Cupom Fiscal PDV
2D = Cupom Fiscal (emitido por ECF)
n_ecf
integer 3 Número de ordem sequencial do ECF
Informar o número de ordem sequencial do ECF que emitiu o Cupom Fiscal vinculado à NF-e
n_coo
integer 6 Número do Contador de Ordem da Operação (COO)
Informar o Número do Contador de Ordem de Operação (COO) vinculado à NF-e
{
"operacao": 1,
"natureza_operacao": "Venda de produção do estabelecimento",
"modelo": 1,
"finalidade": 1,
"ambiente": 1,
"ecf_referenciada": [
  {
    "modelo": "2D",
    "n_ecf": 000,
    "n_coo": 000000
  }
],
"cliente": { ... },
"produtos": [ ... ],
"pedido": { ... }
}
NF de produtor rural referenciada
Parâmetro NF-e NFC-e Tipo Tam. Descrição
uf
string 2 Estado do produtor rural
XX
data
string 10 Informar data da emissão da NF do produtor
Formato americano:
YYYY-MM-DD
cpf
string 11 Número do CPF do emitente
000.000.000-00
cnpj
string 14 Número do CNPJ do emitente
00.000.000/0000-00
ie
string 2-14 Número da Inscrição Estadual do emitente
Mais informações: sintegra.gov.br
modelo
string 2 Modelo do Documento Fiscal
04 = NF de Produtor
01 = NF
serie
integer 1-3 Série do Documento Fiscal
numero
integer 1-9 Número do Documento Fiscal
{
  "operacao": 1,
  "natureza_operacao": "Venda de produção do estabelecimento",
  "modelo": 1,
  "finalidade": 1,
  "ambiente": 1,
  "nf_rural_referenciada": [
    {
      "uf": "PR",
      "data": "2020-01-12",
      "cnpj": "00.000.000/0000-00",
      "ie": "000000",
      "modelo": "04",
      "serie": "1",
      "numero": "100"
    }
  ],
  "cliente": { ... },
  "produtos": [ ... ],
  "pedido": { ... }
}

Os comandos acionam funcionalidades que podem auxiliar o seu ERP e sistema financeiro, como obter o cálculo de impostos antes do cliente efetuar o pagamento, obter a prévia do Danfe e emissões em larga escala.

Comandos
Parâmetro NF-e NFC-e Tipo Tam. Descrição
calculo_impostos
boolean --- Retorna os totais da Nota Fiscal antes da emissão
previa_danfe
boolean --- Retorna a URL do Danfe antes da emissão da Nota Fiscal
assincrono
boolean --- Envio assíncrono da Nota Fiscal com rápido tempo de resposta.
Destinado para grandes volumes de emissão, onde o processo é realizado em background com retorno na URL de notificação.
{
  "operacao": 1,
  "natureza_operacao": "Venda de produção do estabelecimento",
  "modelo": 1,
  "finalidade": 1,
  "ambiente": 1,
  "previa_danfe": true, // Obter prévia do Danfe antes da emissão
  "cliente": { ... },
  "produtos": [ ... ],
  "pedido": { ... }
}

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

As informações do cliente são montados dentro da array cliente conforme mostrado na tabela Informações da Nota Fiscal. Para notas fiscais de importação e exportação é necessário informar o cliente estrangeiro.

Parâmetro NF-e NFC-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-60 Nome completo
cnpj
Pessoa Jurídica
string 14 Número do CNPJ
00.000.000/0000-00
razao_social
Pessoa Jurídica
string 2-60 Razão social
ie
Pessoa Jurídica
Pessoa Física
string 2-14 *Obrigatório caso possua Inscrição Estadual
Número da Inscrição Estadual
Mais informações: sintegra.gov.br
suframa
Pessoa Jurídica
string 8-9 Inscrição SUFRAMA
substituto_tributario
Pessoa Jurídica
Pessoa Física
string 2-14 Inscrição Estadual do Substituto Tributário da UF de destino da mercadoria, quando houver retenção do ICMS-ST para a UF de destino.
Mais informações: sintegra.gov.br
consumidor_final
Pessoa Jurídica
Pessoa Física
integer 1 Indicador de operação com Consumidor final. Definido automaticamente pelo emissor Webmania®, podendo ser alterado manualmente conforme preferência.
0 - Normal
1 - Consumidor final
contribuinte
Pessoa Jurídica
Pessoa Física
integer 1 Indicador de contribuinte do ICMS. Definido automaticamente pelo emissor Webmania®, podendo ser alterado manualmente conforme preferência.
1 - Contribuinte ICMS
2 - Contribuinte isento de Inscrição no cadastro de Contribuintes do ICMS
9 - Não Contribuinte, que pode ou não possuir Inscrição Estadual no Cadastro de Contribuintes do ICMS.
microcervejaria
boolean --- Indicador de Microcervejaria.
Destinado para empresas classificadas como Microcervejaria, onde possui benefícios fiscais específicos para cada estado. Saiba mais.
endereco
string 2-60 Endereço do cliente
complemento
string 1-60 Complemento do endereço do cliente
numero
string 1-60 Número do endereço do cliente
bairro
string 2-60 Bairro do endereço do cliente
cidade
string 2-60 Cidade do endereço do cliente
uf
string 2 Pessoa Física / Pessoa Jurídica
Estado do endereço do cliente
XX
cep
string 8 CEP do endereço do cliente
00000-000
telefone
string 6-14 Telefone do cliente
email
string 1-60 E-mail do cliente para envio da NF-e
Para inserir mais de um e-mail a divisão deve ser com vírgula.

Ex: nome@email.com, nome@email.com

Segue abaixo exemplo de como informar cliente Pessoa Física ao emitir uma Nota Fiscal:

{
  ...
  "cliente": {
     "cpf": "000.000.000-00",
     "nome_completo": "Nome do Cliente",
     "endereco": "Av. Brg. Faria Lima",
     "complemento": "Escritório",
     "numero": 1000,
     "bairro": "Itaim Bibi",
     "cidade": "São Paulo",
     "uf": "SP",
     "cep": "00000-000",
     "telefone": "(00) 0000-0000",
     "email": "nome@email.com"
  },
  ...
}

Emissão de Nota Fiscal > Informações do Cliente
Estrangeiro

Para notas fiscais de importação e exportação é necessário informar o cliente estrangeiro. As informações do cliente estrangeiro são montados dentro da array cliente.

Parâmetro NF-e Tipo Tam. Descrição
id_estrangeiro
string 5-20 Identificação do destinatário no caso de comprador estrangeiro
Número do passaporte ou outro documento legal para identificar pessoa estrangeira.
nome_estrangeiro
string 2-60 Nome do destinatário
cod_pais
string 2-4 Código do País (padrão BACEN)
Ex: Estados Unidos = 2496
Visualizar tabela do BACEN
nome_pais
string 2-60 Nome do País
endereco
string 2-60 Endereço do cliente
bairro
string 2-60 Bairro do endereço do cliente
numero
string 1-60 Número do endereço do cliente
complemento
string 1-60 Complemento do endereço do cliente

Segue abaixo exemplo de como informar o cliente estrangeiro ao emitir uma Nota Fiscal:

{
  ...
  "cliente": {
     "nome_estrangeiro": "Nome do Cliente", 
     "cod_pais": "2496", // Código BACEN
     "nome_pais": "Estados Unidos", // Nome do país
     "endereco": "Endereço do cliente",
     "bairro": "Bairro do cliente"
  }
  ...
}

Emissão de Nota Fiscal > Informações dos Produtos
Produtos

As informações dos produtos são montados dentro da array produtos como objeto para cada produto, conforme mostrado na tabela Informações da Nota Fiscal. Para notas fiscais de importação e exportação é necessário preencher campos adicionais no produto.

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
ID
integer 1-15 Número do pedido de compra por produto
OBS.: Tag xPed do XML
item
integer 6 Número do item no pedido de compra
Informação de interesse do emissor para controle do B2B.
nome
string 1-120 Nome do produto
codigo
string 1-60 Código do produto
OBS.: Tag cProd do XML
ncm
string 8 Código NCM
quantidade
integer 11v4 Quantidade de itens
quantidade_tributavel
integer 11v4 Quantidade tributável do produto
unidade
string 1-6 Unidade comercial/tributável do produto
Exemplo:
UN - Unidade
KG - Kilograma
unidade_tributavel
string 1-6 Unidade tributável do produto
Exemplo:
UN - Unidade
KG - Kilograma
peso
string 12v3 Peso do produto
Peso em quilograma (KG)
Ex: 0.800 = 800 gramas
origem
integer 1 Origem do produto
0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8
1 - Estrangeira - Importação direta, exceto a indicada no código 6
2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7
3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%
4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes
5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%
6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural
7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural
8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%
desconto
string 13v2 Valor do desconto individual do produto
0.00

Por padrão o desconto deve ser informado na array pedido, porém havendo necessidade pode ser aplicado o desconto individual em cada produto.
subtotal
string 11v10 Preço unitário do produto
0.00 (valor integral sem descontos)
subtotal_tributavel
string 11v10 Preço unitário tributável do produto
0.00 (valor integral sem descontos)
total
string 13v2 Preço total (quantidade x preço unitário)
0.00 (valor integral sem descontos)
ind_valor_total NOVO
integer 1 Indica se o valor do item compõe o valor total da Nota Fiscal
0 - Valor do item não compõe o valor total
1 - Valor do item compõe o valor total
classe_imposto
string --- Definição automática de impostos, informe a referência da classe de imposto cadastrado no painel Webmania®
REF0000
impostos
array --- Definição de impostos na API, para operações específicas como ICMS-ST ou que demande maior flexibilidade
cest
string --- Código CEST
beneficio_fiscal
string 8 Código de benefício fiscal na UF
Deve ser utilizado o mesmo código adotado na EFD e outras declarações, nas UF que exigem.
informacoes_adicionais
string 1-500 Informações adicionais do produto.
ind_escala
string 1 Indicador de escala relevante
S - Produzido em Escala Relevante
N - Produzido em Escala NÃO Relevante

OBS.: Preenchimento obrigatório para produtos com NCM relacionado no Anexo XXVII do Convênio 52/2017
cnpj_fabricante
string 14 CNPJ do fabricante da mercadoria
00.000.000/0000-00

OBS.: CNPJ do Fabricante da Mercadoria, obrigatório para produto em escala NÃO relevante
gtin
string 8-14 GTIN do produto, antigo código EAN ou código de barras
gtin_tributavel
string 8-14 GTIN tributável do produto, antigo código EAN ou código de barras
cod_barras
string 3-30 Código de barras próprio ou de terceiros que seja diferente do padrão GTIN
cod_barras_tributavel
string 8-14 Código de barras tributável próprio ou de terceiros que seja diferente do padrão GTIN
nve
string 6 Código NVE
Obrigatório somente para produtos importados em que o NCM exija o NVE. Consulte o seu contador.
nrecopi
string 20 Número do grupo Reconhecimento e Controle das Operações com Papel Imune
Somente para NFC-e
ativo_permanente
boolean --- Identificar produto como ativo permanente ou ao uso ou consumo do cliente.
Utilizado em operações de ICMS-ST (substituição tributária) para identificar entrada de mercadoria no estabelecimento do contribuinte que não esteja vinculada à operação ou prestação subsequente.
veiculo_usado
string 13v2 Campo exclusivo para venda de veículos usados, sendo necessário informar o valor do veículo usado da nota fiscal de compra.
0.00
ex_ipi
string 2-3 Exceção do código NCM caso esteja enquadrado na alíquota do IPI diferenciada.
000
combustiveis
array --- Detalhamento específico de Combustíveis.
Saiba mais
medicamento
array --- Detalhamento Específico de Medicamento e de matérias-primas farmacêutica.
Saiba mais
armamentos
array --- Detalhamento Específico de Armamentos.
Saiba mais
veiculos_novos
array --- Detalhamento Específico de Veículos Novos.
Saiba mais

Emissão de Nota Fiscal > Informações dos Produtos
Exportação

Existem três modelos de exportação: direta, indireta e drawback. A forma de exportação indireta exige informar o registro e a chave de acesso da NF-e de exportação, a drawback exige informar o número do ato concessório, enquanto a exportação direta - aquela que não teve intermediadores - não é necessário o preenchimento de campos adicionais no produto.

As informações de exportação são montados como complemento de cada produto dentro da array produtos.

Parâmetro NF-e Tipo Tam. Descrição
drawback
string 1-20/td> Exportação Drawback
Número do ato concessório de Drawback
O número do Ato Concessório de Suspensão deve ser preenchido com 11 dígitos (AAAANNNNNND) e o número do Ato Concessório de Drawback Isenção deve ser preenchido com 9 dígitos (AANNNNNND).
reg_exportacao
string 12 Exportação Indireta
Número do Registro de Exportação
nfe_exportacao
string 44 Exportação Indireta
Chave de Acesso da NF-e recebida para exportação
NF-e recebida com fim específico de exportação. No caso de operação com CFOP 3.503, informar a chave de acesso da NF-e que efetivou a exportação.
qtd_exportacao
string 11v4 Exportação Indireta
Quantidade do item realmente exportado
A unidade de medida desta quantidade é a unidade de comercialização deste item. No caso de operação com CFOP 3.503, informar a quantidade de mercadoria devolvida.

Segue abaixo exemplo de como acrescentar as informações da exportação indireta em cada produto:

{
  ...
  "produtos": [
     {
        ...
          "exportacao": [
             {
                "reg_exportacao": "000000000",
                "nfe_exportacao": "00000000000000000000000000000000000000000000",
                "qtd_exportacao": "5"
             },
             {
                "reg_exportacao": "00000000",
                "nfe_exportacao": "00000000000000000000000000000000000000000000",
                "qtd_exportacao": "5"
             }
          ]
     }
  ],
  ...
}

Emissão de Nota Fiscal > Informações dos Produtos
Importação

Ao realizar uma importação é obrigatório informar o documento de importação, local de desembaraço e adição. Essas informações devem ser obtidas na DI (Declaração de Importação).

As informações de importação são montados como complemento de cada produto dentro da array produtos.

Parâmetro NF-e Tipo Tam. Descrição
subtotal
string 11v10 Preço unitário do produto
0.00 (valor integral sem descontos)

Observação
Para produtos de importação informar o preço subtotal Aduaneiro (valor produto + frete + seguro).
total
string 13v2 Preço total (quantidade x preço unitário)
0.00 (valor integral sem descontos)

Observação
Para produtos de importação informar o preço total Aduaneiro (valor total produto + frete + seguro).
ndoc_importacao
string 1-15 Número do Documento de Importação (DI, DSI, DIRE, DUImp)
ddoc_importacao
string 10 Data de Registro do documento
Formato americano: YYYY-MM-DD
local_desembaraco
string 1-60 Local de desembaraço
uf_desembaraco
string 2 Sigla da UF onde ocorreu o Desembaraço Aduaneiro
data_desembaraco
string 10 Data do Desembaraço Aduaneiro
Formato americano: YYYY-MM-DD
via_transporte
string 1-2 Via de transporte internacional informada na Declaração de Importação (DI) ou na Declaração Única de Importação (DUImp)
1 - Marítima
2 - Fluvial
3 - Lacustre
4 - Aérea
5 - Postal
6 - Ferroviária
7 - Rodoviária
8 - Conduto / Rede Transmissão
9 - Meios Próprios
10 - Entrada / Saída ficta
11 - Courier
12 - Em mãos
13 - Por reboque
intermediacao
string 1 Forma de importação quanto a intermediação
1 - Importação por conta própria
2 - Importação por conta e ordem
3 - Importação por encomenda
adicao
string 1-3 Número da Adição
seq_adicao
string 1-5 Número sequencial do item
fabricante
string 1-60 Código do fabricante estrangeiro
Número determinado pelo importador, verificar junto ao ERP/Sistema o número de cadastro do fabricante.
desc_di
string 13v2 Valor do desconto do item.
afrmm
string 13v2 Valor da AFRMM - Adicional ao Frete para Renovação da Marinha Mercante
Deve ser informada no caso da via de transporte marítima.
cnpj_terceiro
string 14 CNPJ do adquirente ou do encomendante
Obrigatória a informação no caso de importação por conta e ordem ou por encomenda. Informar os zeros não significativos.
uf_terceiro
string 2 Sigla da UF do adquirente ou do encomendante
Obrigatória a informação no caso de importação por conta e ordem ou por encomenda. Não aceita o valor "EX".
cod_exportador
string 1-60 Código do Exportador
Número determinado pelo importador, verificar junto ao ERP/Sistema o número de cadastro do exportador.
nfci
string 36 Número de controle da FCI - Ficha de Conteúdo de Importação.
Informação relacionada com a Resolução 13/2012 do Senado Federal. Formato: Algarismos, letras maiúsculas de "A" a "F" e o caractere hífen. Exemplo: B01F70AF-10BF-4B1F-848C-65FF57F616FE.

Segue abaixo exemplo de como acrescentar as informações de importação em cada produto:

{
  ...
  "produtos": [
     {
        ...
        "ndoc_importacao": "000000001",
        "ddoc_importacao": "2018-06-01",
        "local_desembaraco": "Aeroporto Internacional de São Paulo",
        "uf_desembaraco": "SP",
        "data_desembaraco": "2018-06-01",
        "via_transporte": "4",
        "intermediacao": "1",
        "adicao": "1",
        "seq_adicao": "1",
        "fabricante": "000000001",
     }
  ],
  ...
}

Emissão de Nota Fiscal > Informações dos Produtos
Rastreabilidade de produto

Informe a rastreabilidade de produtos sujeitos a regulações sanitárias, casos de recolhimento/recall, além de defensivos agrícolas, produtos veterinários, odontológicos, medicamentos, bebidas, águas envasadas, embalagens, etc. Obrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos.

As informações são montadas dentro da array rastro conforme mostrado na tabela Informações dos Produtos.

Parâmetro NF-e Tipo Tam. Descrição
lote
string 1-20 Número do Lote do produto
quantidade
integer 8v3 Quantidade de produto no Lote
data_fabricacao
string 10 Data de fabricação/produção
Formato americano:
YYYY-MM-DD
data_validade
string 10 Data de validade
Formato americano:
YYYY-MM-DD
codigo_agregacao
integer --- Código de Agregação

Segue abaixo exemplo de como acrescentar as informações de rastreabilidade em cada produto:

{
  ...
  "produtos": [
     {
        ...
        "rastro": {
           "lote": "000001", 
           "quantidade": "100",
           "data_fabricacao": "2018-01-01",
           "data_validade": "2020-01-01"
        }
     }
  ],
  ...
}

Emissão de Nota Fiscal > Informações dos Produtos
Combustíveis

Detalhamento específico de Combustíveis. As informações são montadas dentro da array combustiveis conforme mostrado na tabela Informações dos Produtos.

Parâmetro NF-e Tipo Tam. Descrição
codigo_anp
integer 9 Código de produto da ANP
descricao_anp
integer --- Descrição do produto conforme ANP
uf_consumo
string 2 Estado de consumo
XX
percentual_glp
integer 3v2 Percentual do GLP derivado do petróleo no produto GLP
0.00
percentual_gnn
integer 3v2 Percentual de Gás Natural Nacional (GLGNn) para o produto GLP
0.00
percentual_gni
integer 3v2 Percentual de Gás Natural Importado (GLGNi) para o produto GLP
0.00
partida
integer 13v2 Valor de partida
Deve ser informado neste campo o valor por quilograma sem ICMS
codif
integer 1-21 Código de autorização/registro do CODIF
qtd_temperatura
integer 12v4 Quantidade de combustível faturada à temperatura ambiente
Somente caso a quantidade do produto informada no parâmetro quantidade tenha sido ajustada para uma temperatura diferente da ambiente.
bc_cide
integer 12v4 Base de cálculo da CIDE em quantidade
0.00
valor_cide
integer 13v2 Valor da alíquota em reais da CIDE
0.00
bico
integer --- Número de identificação do bico utilizado no abastecimento
Disponibilizado por hardware específico acoplado à bomba de combustível, definido no controle da venda do Posto.
bomba
integer --- Número de identificação da bomba ao qual o bico está interligado
Disponibilizado por hardware específico acoplado à bomba de combustível, definido no controle da venda do Posto.
tanque
integer --- Número de identificação do tanque ao qual o bico está interligado
Disponibilizado por hardware específico acoplado à bomba de combustível, definido no controle da venda do Posto.
encerrante_inicio
integer --- Valor do encerrante no início do abastecimento
Disponibilizado por hardware específico acoplado à bomba de combustível, definido no controle da venda do Posto.
encerrante_final
integer --- Valor do encerrante no final do abastecimento
Disponibilizado por hardware específico acoplado à bomba de combustível, definido no controle da venda do Posto.

Segue abaixo exemplo de como acrescentar o detalhamento específico de combustíveis em cada produto:

{
  ...
  "produtos": [
     {
        ...
        "combustiveis": {
           "codigo_anp": "000001", 
           "descricao_anp": "Descrição do produto conforme ANP",
           "uf_consumo": "SP"
        }
     }
  ],
  ...
}

Emissão de Nota Fiscal > Informações dos Produtos
Medicamento

Detalhamento específico de Medicamento e de matérias-primas farmacêuticas.As informações são montadas dentro da array medicamento conforme mostrado na tabela Informações dos Produtos.

Parâmetro NF-e Tipo Tam. Descrição
codigo_anvisa
string --- Código de Produto da ANVISA
pmc
integer 13v2 Preço máximo consumidor
0.00

Segue abaixo exemplo de como acrescentar o detalhamento específico de medicamento em cada produto:

{
  ...
  "produtos": [
     {
        ...
        "medicamento": {
           "codigo_anvisa": "000001", 
           "pmc": "20.00"
        },
        "rastro": {
           "lote": "000001", 
           "quantidade": "100",
           "data_fabricacao": "2018-01-01",
           "data_validade": "2020-01-01"
        }
     }
  ],
  ...
}

Emissão de Nota Fiscal > Informações dos Produtos
Armamentos

Detalhamento específico de Armamentos. As informações são montadas dentro da array armamentos conforme mostrado na tabela Informações dos Produtos.

Parâmetro NF-e Tipo Tam. Descrição
tipo
integer 1 Indicador do tipo de arma de fogo
0 - Uso permitido
1 - Uso restrito
serie_arma
string 1-15 Número de série da arma
serie_cano
string 1-15 Número de série do cano
descricao
string 1-256 Descrição completa da arma
Calibre, marca, capacidade, tipo de funcionamento, comprimento e demais elementos que permitam a sua perfeita identificação.

Segue abaixo exemplo de como acrescentar o detalhamento específico de armamentos em cada produto:

{
  ...
  "produtos": [
     {
        ...
        "armamentos": {
           "tipo": "0", 
           "serie_arma": "00000001",
           "serie_cano": "00000001",
           "descricao": "Descrição completa da arma"
        }
     }
  ],
  ...
}

Emissão de Nota Fiscal > Informações dos Produtos
Veículos Novos

Detalhamento específico de Veículos Novos. As informações são montadas dentro da array veiculos_novos conforme mostrado na tabela Informações dos Produtos.

Parâmetro NF-e Tipo Tam. Descrição
tipo_operacao
integer 1 Tipo da operação
1 - Venda concessionária
2 - Faturamento direto para consumidor final
3 - Venda direta para grandes consumidores (frotista, governo)
0 - Outros
chassi
string 17 Chassi do Veículo
cor
string 1-4 Cor
Código de cada montadora
cor_descricao
string 1-40 Descrição da Cor
cv
string 1-4 Potência Motor (CV).
cilindrada
string 1-4 Cilindradas.
peso_liquido
integer 1-9 Peso líquido
0.0000 (em toneladas com 4 casas decimais)
peso_bruto
integer 1-9 Peso bruto total
0.0000 (em toneladas com 4 casas decimais)
serie
string 1-9 Serial (série)
tipo_combustivel
integer 1-2 Tipo de combustível
Utilizar tabela RENAVAM (v2.0)
01 - Álcool
02 - Gasolina
03 - Diesel
16 - Álcool/Gasolina
17 - Gasolina/Álcool/GNV
18 - Gasolina/Elétrico
numero_motor
string 1-21 Número de motor
cmt
integer 1-9 Capacidade Máxima de Tração
0.0000 (em toneladas com 4 casas decimais)
dist
string 1-4 Distância entre eixos
ano_modelo
string 4 Ano Modelo de Fabricação
XXXX
ano_fabricacao
string 4 Ano de Fabricação
XXXX
tipo_pintura
string 1 Tipo de Pintura
tipo_veiculo
integer 1-2 Tipo de Veículo
Utilizar tabela RENAVAM, conforme exemplos abaixo:
02 - Ciclomoto
03 - Motoneta
04 - Motociclo
05 - Triciclo
06 - Automóvel
07 - Microônibus
08 - Ônibus
10 - Reboque
11 - Semirreboque
13 - Caminhoneta
14 - Caminhão
17 - C. Trator
22 - Esp/Ônibus
23 - Misto/Cam
24 - Carga/Cam
especie_veiculo
integer 1 Espécie de Veículo
Utilizar tabela RENAVAM
1 - Passageiro
2 - Carga
3 - Misto
4 - Corrida
5 - Tração
6 - Especial
vin
string 1 Condição do VIN
Informa-se o veículo tem VIN (chassi) remarcado.
R - Remarcado
N - Normal
condicao_veiculo
integer 1 Condição do veículo
1 - Acabado
2 - Inacabado
3 - Semiacabado
marca_modelo
integer 1-6 Código Marca Modelo
Utilizar tabela RENAVAM
cor_denatran
integer 1-2 Código da Cor do DENETRAN
01 - Amarelo
02 - Azul
03 - Bege
04 - Branca
05 - Cinza
06 - Dourada
07 - Grená
08 - Laranja
09 - Marrom
10 - Prata
11 - Preta
12 - Rosa
13 - Roxa
14 - Verde
15 - Vermelha
16 - Fantasia
lotacao
integer 1-3 Capacidade máxima de lotação
restricao
integer 1 Restrição
0 - Não há
1 - Alienação Fiduciária
2 - Arrendamento Mercantil
3 - Reserva de domínio
4 - Penhor de veículos
9 - Outras

Segue abaixo exemplo de como acrescentar o detalhamento específico de veículos novos em cada produto:

{
  ...
  "produtos": [
     {
        ...
        "veiculos_novos": {
           "tipo_operacao": "1", 
           "chassi": "0000000000000000000000",
           "cor": "A1",
           "cor_descricao": "Descrição da Cor",
           "cv": "100",
           "cilindrada": "1000",
           "peso_liquido": "2.5000",
           "peso_bruto": "2.5000",
           "serie": "00001",
           "tipo_combustivel": "16",
           "numero_motor": "00001",
           "cmt": "2.000",
           "dist": "150",
           "ano_modelo": "2019",
           "ano_fabricacao": "2018",
           "tipo_pintura": "Tipo de Pintura",
           "tipo_veiculo": "06",
           "especie_veiculo": "1",
           "vin": "N",
           "condicao_veiculo": "1",
           "marca_modelo": "00001",
           "cor_denatran": "04",
           "lotacao": "5",
           "restricao": "0"
        }
     }
  ],
  ...
}

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

As informações do pedido são montados dentro da array pedido conforme mostrado na tabela Informações da Nota Fiscal.

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
presenca
integer 1 Indicador de presença do comprador no estabelecimento comercial no momento da operação
0 - Não se aplica (por exemplo, Nota Fiscal complementar ou de ajuste)
1 - Operação presencial
2 - Operação não presencial, pela Internet
3 - Operação não presencial, Teleatendimento
4 - NFC-e em operação com entrega a domicílio
5 - Operação presencial, fora do estabelecimento
9 - Operação não presencial, outros
intermediador
integer 1 Indicador de intermediador/marketplace
0 - Operação sem intermediador (em site ou plataforma própria)
1 - Operação em site ou plataforma de terceiros (intermediadores/marketplace)
cnpj_intermediador
integer 14 *Obrigatório para operação com intermediador
CNPJ do Intermediador da Transação
Agenciador, plataforma de delivery, marketplace e similar de serviços e de negócios.
id_intermediador
string --- *Obrigatório para operação com intermediador
Identificador cadastrado no intermediador
Nome do usuário ou identificação do perfil do vendedor no site do intermediador.
modalidade_frete
integer 1 Modalidade do frete
0 - Contratação do Frete por conta do Remetente (CIF)
1 - Contratação do Frete por conta do Destinatário (FOB)
2 - Contratação do Frete por conta de Terceiros
3 - Transporte Próprio por conta do Remetente
4 - Transporte Próprio por conta do Destinatário
9 - Sem Ocorrência de Transporte
frete
string 13v2 Total do frete
0.00

NF-E DE IMPORTAÇÃO
Para nota fiscal de importação não inserir o valor do frete. Podendo ser informado o valor somente no campo Informações ao Fisco.
desconto
string 13v2 Total do desconto
0.00
total
string 13v2 Valor total do pedido pago pelo cliente
Cálculo: Total produtos + Frete - Descontos
0.00

AUTOMÁTICO
O valor total da NF-e é calculado automaticamente, porém pode ser substituído caso informado.
despesas_acessorias
string 13v2 Outras despesas acessórias
0.00
despesas_aduaneiras
string 13v2 Obrigatório para nota fiscal de importação:
Valor despesas aduaneiras (Siscomex)
0.00
informacoes_fisco
string 1-2000 Informações ao Fisco
informacoes_complementares
string 1-5000 Informações Complementares ao Consumidor
observacoes_contribuinte
array --- Observações de uso livre do contribuinte
OBS.: Na array deve possuir os parâmetros campo e texto.

Segue abaixo exemplo de como acrescentar as informações do pedido:

{
  ...
  "pedido": {
     "pagamento": 0,
     "presenca": 2,
     "modalidade_frete": 0,
     "frete": "12.56",
     "desconto": "10.00",
     "total": "174.60"
  }
}

Emissão de Nota Fiscal > Informações do Pedido
Pagamento

A partir da NF-e 4.00 é obrigatório informar a forma de pagamento da Nota Fiscal em todas as emissões. As informações de pagamento são montados como complemento dentro da array pedido.

Os parâmetros abaixo podem ser informados como string ou array, caso deseja informar mais de uma forma de pagamento na Nota Fiscal.

Parâmetro NF-e NFC-e Tipo Tam. Descrição
pagamento
número ou array 1 Indicador da forma de pagamento
0 - Pagamento à vista
1 - Pagamento a prazo
forma_pagamento
string ou array 2 Meio de pagamento
01 - Dinheiro
02 - Cheque
03 - Cartão de Crédito
04 - Cartão de Débito
05 - Crédito Loja
10 - Vale Alimentação
11 - Vale Refeição
12 - Vale Presente
13 - Vale Combustível
14 - Duplicata Mercantil
15 - Boleto Bancário
16 - Depósito Bancário
17 - Pagamento Instantâneo (PIX)
18 - Transferência bancária, Carteira Digital
19 - Programa de fidelidade, Cashback, Crédito Virtual
90 - Sem pagamento
99 - Outros
desc_pagamento
string ou array --- *Obrigatório para 99 - Outros
Descrição do Meio de pagamento
tipo_integracao
número ou array 1 Tipo de integração para pagamento
1 - Pagamento integrado com o sistema de automação da empresa (Ex: equipamento TEF, Comércio eletrônico)
2 - Pagamento não integrado com o sistema de automação da empresa (Ex: equipamento POS)

Padrão: 2
valor_pagamento
número ou array 13v2 *Obrigatório para pagamento via Dinheiro: Valor do pagamento
0.00
cnpj_credenciadora
string ou array 14 *Obrigatório para pagamento via Cartão de Crédito ou Débito para Pagamento Integrado (TEF):
CNPJ da instituição de pagamento
CNPJ da instituição de pagamento, adquirente ou subadquirente. Caso o pagamento seja processado pelo intermediador da transação, informar o CNPJ do intermediador.
bandeira
string ou array 2 *Obrigatório para pagamento via Cartão de Crédito ou Débito para Pagamento Integrado (TEF):
Bandeira da operadora do cartão de crédito e/ou débito
01 - Visa
02 - Mastercard
03 - American Express
04 - Sorocred
05 - Diners Club
06 - Elo
07 - Hipercard
08 - Aura
09 - Cabal
10 - Alelo
11 - Banes Card
12 - CalCard
13 - Credz
14 - Discover
15 - GoodCard
16 - GreenCard
17 - Hiper
18 - JCB
19 - Mais
20 - MaxVan
21 - Policard
22 - RedeCompras
23 - Sodexo
24 - ValeCard
25 - Verocheque
26 - VR
27 - Ticket
99 - Outros
autorizacao
string ou array 1-20 *Obrigatório para pagamento via Cartão de Crédito ou Débito para Pagamento Integrado (TEF):
Número da autorização da operadora de cartão de crédito/débito (NSU).

Exemplo de um cliente que efetuou a compra com duas formas de pagamento, sendo a primeira em dinheiro e a segunda por cartão de crédito:

{
    "pedido" {
        ...
        ...
        "forma_pagamento": ["01","03"], // dinheiro e cartão de crédito
        "valor_pagamento": ["25.00","50.00"] // valor total de R$75,00
    }
}

Emissão de Nota Fiscal
Transporte

As informações do transporte são montados dentro da array transporte conforme mostrado na tabela Informações da Nota Fiscal.

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
volume
string 1-15 Quantidade de volumes transportados
especie
string 1-60 Espécie dos volumes transportados
peso_bruto
string 12v3 Peso bruto dos volumes transportados
Peso em quilograma (KG)
Ex: 50.210 = 50,210KG
peso_liquido
string 12v3 Peso líquido dos volumes transportados
Peso em quilograma (KG)
Ex: 50.210 = 50,210KG
marca
string 1-60 Marca dos volumes transportados
numeracao
string 1-60 Numeração dos volumes transportados
lacres
string 1-60 Número dos Lacres dos volumes transportados

Segue abaixo exemplo de como acrescentar as informações do transporte:

{
  ...
  "pedido": {
     ...
  },
  "transporte": {
     "volume": "2",
     "especie": "CAIXA",
     "peso_bruto": "2.500",
     "peso_liquido": "2.500"
  }
}

Emissão de Nota Fiscal > Transporte
Transportadora

Identifique a transportadora que irá efetuar o transporte dos produtos. As informações da transportadora são montados como complemento dentro da array transporte.

Importante: não é necessário informar a transportadora para envio realizado pelos Correios.
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
cnpj
integer 14 Pessoa Jurídica
CNPJ
00.000.000/0000-00
razao_social
string 2-60 Pessoa Jurídica
Razão Social
ie
string 2-14 Pessoa Jurídica
Número da Inscrição Estadual
0 - Isento ou Nº da Inscrição Estadual
cpf
integer 11 Pessoa Física
CPF
000.000.00-00
nome_completo
string 2-60 Pessoa Física
Nome Completo
endereco
string 1-60 Endereço completo da empresa
uf
string 2 Sigla UF do estado
A UF deve ser informada se informado uma IE. Informar "EX" para Exterior.
cidade
string 1-60 Cidade
cep
string 8 CEP
00000-000
placa
string 7 Placa do Veículo
Informar em um dos seguintes formatos: XXX9999, XXX999, XX9999 ou XXXX999.
uf_veiculo
string 2 Sigla UF do estado onde o veículo foi emplacado
Informar "EX" para Exterior.
rntc
string 1-20 Registro Nacional de Transportador de Carga (ANTT)
seguro
string 13v2 Valor do seguro
0.00

Segue abaixo exemplo de como acrescentar as informações da transportadora:

{
  ...
  "pedido": {
     ...
  },
  "transporte": {
     "volume": "2",
     "especie": "CAIXA",
     "peso_bruto": "2.500",
     "peso_liquido": "2.500",
     "cnpj": "00.000.000/0000-00",
     "razao_social": "Nome da empresa LTDA",
     "ie": "00000000",
     "endereco": "Av. Brg. Faria Lima",
     "uf": "SP",
     "cidade": "São Paulo",
     "cep": "00000-000"
  }
}

Emissão de Nota Fiscal > Transporte
Reboque

As informações da reboque são montados na array reboque como complemento da array transporte.

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
placa
integer 7 Placa do Veículo
Informar em um dos seguintes formatos: XXX9999, XXX999, XX9999 ou XXXX999.
uf_veiculo
string 2 Sigla UF do estado onde o veículo foi emplacado
Informar "EX" para Exterior.
rntc
string 1-20 Registro Nacional de Transportador de Carga (ANTT)
vagao
integer 1-20 Identificação do vagão
balsa
string 1-20 Identificação da balsa

Segue abaixo exemplo de como acrescentar as informações do reboque:

{
  ...
  "pedido": {
     ...
  },
  "transporte": {
     ...
     "reboque": [
       {
         "placa": "AAA000",
         "uf_veiculo": "SP",
         "rntc": "0000000000000000",
       }
     ]
  }
}

Emissão de Nota Fiscal > Transporte
Local de Entrega

As informações de identificação do local de entrega devem ser montados na array entrega como complemento da array transporte.

Parâmetro NF-e Tipo Tam. Descrição
cnpj
Pessoa Jurídica
integer 14 Número do CNPJ
00.000.000/0000-00
razao_social
Pessoa Jurídica
string 2-60 Razão Social
ie
Pessoa Jurídica
integer 2-14 Número da Inscrição Estadual
cpf
Pessoa Física
string 11 Número do CPF
000.000.000-00
nome_completo
Pessoa Física
string 2-60 Nome completo
nome_estrangeiro
Estrangeiro
string 2-60 Nome do destinatário
cod_pais
Estrangeiro
string 4 Código do País (padrão BACEN)
Ex: Estados Unidos = 2496
Visualizar tabela do BACEN
pais
Estrangeiro
string 1-60 Nome do país de entrega
uf
Pessoa Jurídica
Pessoa Física
Estrangeiro
string 2 Estado do endereço de entrega
Informar "EX" para exterior
cep
Pessoa Jurídica
Pessoa Física
integer 8 CEP do endereço de entrega
endereco
string 2-60 Endereço de entrega dos produtos
numero
string 1-60 Número de entrega dos produtos
complemento
string 1-60 Complemento do endereço de entrega
bairro
string 2-60 Bairro do endereço de entrega
cidade
string 2-60 Cidade do endereço de entrega
telefone
integer 6-14 Telefone
email
string 1-60 E-mail

Segue abaixo exemplo de como acrescentar as informações do local de entrega:

{
  ...
  "pedido": {
     ...
  },
  "transporte": {
     ...
     "entrega": {
         "cnpj": "00.000.000/0000-00",
         "razao_social": "Nome da empresa LTDA",
         "ie": "0000000000",
         "endereco": "Av. Brg. Faria Lima",
         "numero": "1000",
         "complemento": "Escritório",
         "bairro": "Itaim Bibi",
         "cidade": "São Paulo",
         "cep": "00000-000",
         "uf": "SP",
         "telefone": "(00) 0000-0000",
         "email": "nome@email.com",
     }
  }
}

Emissão de Nota Fiscal > Transporte
Local de Retirada

As informações de identificação do local de entrega devem ser montados na array retirada como complemento da array transporte.

Parâmetro NF-e Tipo Tam. Descrição
cnpj
Pessoa Jurídica
integer 14 Número do CNPJ
00.000.000/0000-00
razao_social
Pessoa Jurídica
string 2-60 Razão Social
ie
Pessoa Jurídica
integer 2-14 Número da Inscrição Estadual
cpf
Pessoa Física
string 11 Número do CPF
000.000.000-00
nome_completo
Pessoa Física
string 2-60 Nome completo
nome_estrangeiro
Estrangeiro
string 2-60 Nome do expedidor
cod_pais
Estrangeiro
string 4 Código do País (padrão BACEN)
Ex: Estados Unidos = 2496
Visualizar tabela do BACEN
pais
Estrangeiro
string 1-60 Nome do país de retirada
uf
Pessoa Jurídica
Pessoa Física
Estrangeiro
string 2 Estado do endereço de retirada
Informar "EX" para exterior
cep
Pessoa Jurídica
Pessoa Física
integer 8 CEP do endereço de retirada
endereco
string 2-60 Endereço de retirada dos produtos
numero
string 1-60 Número de retirada dos produtos
complemento
string 1-60 Complemento de retirada dos produtos
bairro
string 2-60 Bairro de retirada dos produtos
cidade
string 2-60 Cidade de retirada dos produtos
telefone
integer 6-14 Telefone
email
string 1-60 E-mail

Segue abaixo exemplo de como acrescentar as informações do local de retirada:

{
  ...
  "pedido": {
     ...
  },
  "transporte": {
     ...
     "retirada": {
         "cnpj": "00.000.000/0000-00",
         "razao_social": "Nome da empresa LTDA",
         "ie": "0000000000",
         "endereco": "Av. Brg. Faria Lima",
         "numero": "1000",
         "complemento": "Escritório",
         "bairro": "Itaim Bibi",
         "cidade": "São Paulo",
         "cep": "00000-000",
         "uf": "SP",
         "telefone": "(00) 0000-0000",
         "email": "nome@email.com",
     }
  }
}

Emissão de Nota Fiscal
Fatura

A fatura referente a Nota Fiscal é montada dentro da array fatura conforme mostrado na tabela Informações da Nota Fiscal, é necessário informar os campos numero, valor, desconto e valor_liquido.

Parâmetro NF-e Tipo Tam. Descrição
numero
string 1-60 Número da Fatura
Ex: 12345
valor
string 13v2 Valor Original da Fatura
0.00
desconto
string 13v2 Valor do desconto
0.00
valor_liquido
string 13v2 Valor Líquido da Fatura
0.00

Segue abaixo exemplo de como acrescentar as informações da fatura:

{
  ...
  "pedido": {
     ...
  },
  "fatura": {
     "numero": "000001",
     "valor": "100.00",
     "desconto": "0.00",
     "valor_liquido": "100.00",
  }
}

Emissão de Nota Fiscal
Parcelas

As duplicatas foram substituídas na versão 4.00 por parcelas, sendo montado dentro da array parcelas como objeto para cada parcela. Para cada objeto é necessário informar os campos vencimento e valor, sendo que a numeração da parcela é gerada automaticamente seguindo o padrão 001, 002 e assim por diante. A partir de 03/09/2018 é obrigatório informar os dados da fatura junto com as parcelas.

Parâmetro NF-e Tipo Tam. Descrição
vencimento
string 10 Data de vencimento
Formato americano: YYYY-MM-DD
valor
string 13v2 Valor da parcela
0.00

Segue abaixo exemplo de como acrescentar as informações das parcelas:

{
  ...
  "pedido": {
     ...
  },
  "fatura": {
     "numero": "000001",
     "valor": "100.00",
     "desconto": "0.00",
     "valor_liquido": "100.00",
  },
  "parcelas": [
     {
        "vencimento": "2018-06-01",
        "valor": "50.00"
     },
     {
        "vencimento": "2018-07-01",
        "valor": "50.00"
     }
  ]
}

Emissão de Nota Fiscal
Exportação

As informações da exportação são montados dentro da array exportacao conforme mostrado na tabela Informações da Nota Fiscal.

Parâmetro NF-e Tipo Tam. Descrição
uf_embarque
string 2 Sigla da UF de Embarque ou de transposição de fronteira
local_embarque
string 1-60 Descrição do Local de Embarque ou de transposição de fronteira
local_despacho
string 1-60 Descrição do local de despacho (Informação do Recinto Alfandegado)

Segue abaixo exemplo de como acrescentar as informações da exportação:

{
  ...
  "pedido": {
     ...
  },
  "exportacao": {
     "uf_embarque": "SP",
     "local_embarque": "Aeroporto Internacional de São Paulo"
  }
}

Classe de Imposto

Existem duas formas de definir impostos para emissão da Nota Fiscal, através do cadastro da Classe de Imposto ou diretamente na API.

A classe de imposto reúne informações fiscais do ICMS, IPI, PIS, COFINS e ISS para que seja realizado o cálculo automático dos impostos. É um procedimento simples, configurado uma única vez, que facilita emissões das notas fiscais para MEI, Simples Nacional, Lucro Presumido e Normal.

Antes disponível somente pelo painel Webmania®, agora é possível criar, editar e listar através da API de nota fiscal. Ao criar a classe de imposto, basta informar o código de referência para emitir a nota fiscal:

{
  "produtos": [
    {
      "nome": "Nome do produto",
      "codigo": "nome-do-produto",
      "classe_imposto": "REF000000" // Classe de imposto
    },
    {
      "nome": "Nome do produto",
      "codigo": "nome-do-produto",
      "classe_imposto": "REF000000" // Classe de imposto
    }
  ]
}

Classe de imposto
Cenários

Cada classe de imposto possui um número único de referência para utilização (Ex: REF00000) e abrange até 4 cenários de emissão de nota fiscal.

Recomendamos que para cada classe de imposto os cenários compreendam a mesma natureza de operação, como saídas estaduais e interestaduais para destinatários pessoas físicas e pessoas jurídicas.

Segue abaixo a explicação sobre cada cenário:

Cenário Destinatário Descrição
padrao Pessoa Física
Pessoa Jurídica
Estrangeiro
Cenário padrão para todas as variações de entrada/saída e destinatário Pessoa Física/Jurídica/Estrangeiro.
Cenário não disponível para ICMS
saida_dentro_estado Pessoa Física
Pessoa Jurídica
Cenário para operações internas de saída.
saida_fora_estado Pessoa Física
Pessoa Jurídica
Cenário para interestaduais de saída.
entrada_dentro_estado Pessoa Física
Pessoa Jurídica
Cenário para operações internas de entrada.
entrada_fora_estado Pessoa Física
Pessoa Jurídica
Cenário para operações interestaduais de entrada.
saida_exterior Estrangeiro Cenário para operação de exportação.
entrada_exterior Pessoa Física
Pessoa Jurídica
Cenário de operação de importação.

Classe de imposto
Criar/Editar

Para criar ou editar classes de impostos, envie a requisição no método POST para a URL /1/nfe/classe-imposto/ contendo no corpo da requisição os parâmetros no formato JSON.

Caso o parâmetro referencia seja enviado, a classe de imposto correspondente será atualizada com os novos dados, caso contrário será criado uma nova classe de imposto.

Os parâmetros icms, ipi, pis, cofins, issqn, devem ser enviados como array, sendo que cada objeto corresponse à um cenário específico de tributação.

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
referencia
string --- Referência de uma classe de imposto já existente.
Caso informado, a classe de imposto correspondente será substituída com os novos parâmetros.
descricao
string --- Descrição da classe de imposto
icms
array (objetos) --- Cenários de tributação do ICMS
ipi
array (objetos) --- Cenários de tributação do IPI
pis
array (objetos) --- Cenários de tributação do PIS
cofins
array (objetos) --- Cenários de tributação do COFINS
issqn
array (objetos) --- Cenários de tributação do ISSQN
informacoes_fisco
string --- Informações ao Fisco
informacoes_complementares
string --- Informações complementares ao consumidor

Segue exemplo de classe de imposto, para Simples Nacional, na saída de produtos de revenda:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "referencia" : "REF000000", // Informar somente para edição
  "descricao": "Classe de impostos para Saída de produtos de revenda",
  "icms": [
      {
        "tipo_tributacao": "simples_nacional",
        "cenario": "saida_dentro_estado",
        "tipo_pessoa": "fisica",
        "codigo_cfop": "5102",
        "situacao_tributaria": "102"
      },
      {
        "tipo_tributacao": "simples_nacional",
        "cenario": "saida_fora_estado",
        "tipo_pessoa": "fisica",
        "codigo_cfop": "6102",
        "situacao_tributaria": "102"
      },
      {
        "tipo_tributacao": "simples_nacional",
        "cenario": "saida_dentro_estado",
        "tipo_pessoa": "juridica",
        "codigo_cfop": "5102",
        "situacao_tributaria": "102"
      },
      {
        "tipo_tributacao": "simples_nacional",
        "cenario": "saida_fora_estado",
        "tipo_pessoa": "juridica",
        "codigo_cfop": "6102",
        "situacao_tributaria": "102"
      }
    ],
    "ipi": [
      {
        "cenario": "padrao",
        "tipo_pessoa": "fisica",
        "situacao_tributaria": "99",
        "codigo_enquadramento": "999",
        "aliquota": "0.00"
      },
      {
        "cenario": "padrao",
        "tipo_pessoa": "juridica",
        "situacao_tributaria": "99",
        "codigo_enquadramento": "999",
        "aliquota": "0.00"
      }
    ],
    "pis": [
      {
        "cenario": "padrao",
        "tipo_pessoa": "fisica",
        "situacao_tributaria": "99",
        "aliquota": "0.00"
      },
      {
        "cenario": "padrao",
        "tipo_pessoa": "juridica",
        "situacao_tributaria": "99",
        "aliquota": "0.00"
      }
    ],
    "cofins": [
      {
        "cenario" : "padrao",
        "tipo_pessoa": "fisica",
        "situacao_tributaria": "99",
        "aliquota": "0.00"
      },
      {
        "cenario" : "padrao",
        "tipo_pessoa": "juridica",
        "situacao_tributaria": "99",
        "aliquota": "0.00"
      }
    ]
}' \
https://webmaniabr.com/api/1/nfe/classe-imposto/

A resposta do corpo da mensagem será no formato objeto JSON, contendo o campo referencia, descricao e data da classe de imposto criada ou alterada:

{
  "referencia": "REF0000000", // Referência da classe de imposto
  "descricao": "Classe de impostos para Saída de produtos de revenda", // Descrição
  "data": "0000-00-00 00:00:00" // Data de criação
}
ICMS
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
tipo_tributacao
string --- Tipo de tributação do ICMS
simples_nacional
simples_nacional_sublimite
tributacao_normal
cenario
string --- Cenário de tributação
saida_dentro_estado
saida_fora_estado
saida_exterior
entrada_dentro_estado
entrada_fora_estado
entrada_exterior
tipo_pessoa
string --- Tipo de pessoa
fisica
juridica
estrangeira
nao_contribuinte
boolean --- Informar como true caso o cenário seja específico para Pessoa Jurídica não contribuinte do ICMS ou Consumidor final.
codigo_cfop
string 4 Código Fiscal de Operações e Prestações (CFOP)
0.000
situacao_tributaria
string 3 Código da situação tributária
Simples Nacional:
101 - Tributada com permissão de crédito
102 - Tributada sem permissão de crédito
103 - Isenção do ICMS para faixa de receita bruta
201 - Tributada com permissão de crédito e com cobrança do ICMS por substituição tributária
202 - Tributada sem permissão de crédito e com cobrança do ICMS por substituição tributária
203 - Isenção do ICMS para faixa de receita bruta e com cobrança do ICMS por substituição tributária
300 - Imune
400 - Não tributada
500 - ICMS cobrado anteriormente por substituição tributária (substituído) ou por antecipação
900 - Outros

Tributação Normal:
00 - Tributada integralmente
10 - Tributada e com cobrança do ICMS por substituição tributária
20 - Com redução da base de cálculo
30 - Isenta ou não tributada e com cobrança do ICMS por substituição tributária
40 - Isenta
41 - Não tributada
50 - Suspensão
51 - Diferimento
60 - ICMS cobrado anteriormente por substituição tributária
70 - Com redução de base de cálculo e cobrança do ICMS por substituição tributária
90 - Outros
aliquota_importacao
string 3v2 *Obrigatório para Nota Fiscal de importação:
Alíquota do ICMS de importação.
0.00
aliquota_credito
string 3v2 *Obrigatório para CST 101 ou 201:
Alíquota aplicável de cálculo de crédito.
0.00
aliquota_mva
array (objetos) --- Percentual da Margem de Valor Agregado Original (MVA/IVA Original) para cálculo do ICMS-ST, deve ser informado para cada estado separadamente. A definição da MVA Ajustada é realizada automaticamente.
aliquota_icms
array (objetos) --- (Opcional) Na Webmania® o ICMS e a base de cálculo são automáticos.
aliquota_icms_st
array (objetos) --- (Opcional) Na Webmania® o ICMS-ST e a base de cálculo são automáticos.
aliquota_fcp
array (objetos) --- (Opcional) Na Webmania® o FCP e a base de cálculo são automáticos.
aliquota_fcp_st
array (objetos) --- (Opcional) Na Webmania® o FCP-ST e a base de cálculo são automáticos.
aliquota_diferimento
string 3v2 Percentual do diferimento
0.00
aliquota_diferimento_fcp
string 3v2-4 Percentual do diferimento do ICMS relativo ao Fundo de Combate à Pobreza (FCP)
0.00
aliquota_reducao
string 3v4 Alíquota da redução da base de cálculo ICMS
0.0000
aliquota_reducao_st
string 3v4 Alíquota da redução da base de cálculo ICMS-ST
0.0000
motivo_desoneracao
string 1-2 Código do motivo da desoneração caso houver
3 - Uso na agropecuária
9 - Outros
12 - Órgão de fomento e desenvolvimento agropecuário
motivo_desoneracao_st
string 1-2 Código do motivo da desoneração do ICMS-ST caso houver
3 - Uso na agropecuária
9 - Outros
12 - Órgão de fomento e desenvolvimento agropecuário
beneficio_fiscal
array (objetos) --- Código de benefício fiscal na UF. Deve ser informado separadamente para cada UF exigente.
Deve ser utilizado o mesmo código adotado na EFD e outras declarações, nas UF que exigem.
{
  "icms": [
    {
      "tipo_tributacao": "simples_nacional",
      "cenario": "saida_dentro_estado",
      "tipo_pessoa": "juridica",
      "codigo_cfop": "5102",
      "situacao_tributaria": "101",
      "aliquota_credito": "2.00"
    },
    {
      "tipo_tributacao": "simples_nacional",
      "cenario": "saida_fora_estado",
      "tipo_pessoa": "juridica",
      "codigo_cfop": "6102",
      "situacao_tributaria": "101",
      "aliquota_credito": "2.00"
    }
  ]
}
ICMS > Alíquota MVA
Parâmetro Obrigatório Tipo Tam. Descrição
estado
string 2 Sigla da UF
Ex: PR
valor
string 3v2 Valor da alíquota
0.00
{
  "icms": [
    {
      ...
      "aliquota_mva" : [
        {
          "estado" : "PR",
          "aliquota" : "32.00"
        },
        {
          "estado" : "SC",
          "aliquota" : "32.00"
        },
        {
          "estado" : "RS",
          "aliquota" : "32.00"
        }
      ]
    }
  ]
}
ICMS > Alíquota ICMS
Parâmetro Obrigatório Tipo Tam. Descrição
estado
string 2 Sigla da UF
Ex: PR
valor
string 3v2 Valor da alíquota
0.00
{
  "icms": [
    {
      ...
      "aliquota_icms" : [
        {
          "estado" : "PR",
          "aliquota" : "32.00"
        },
        {
          "estado" : "SC",
          "aliquota" : "32.00"
        },
        {
          "estado" : "RS",
          "aliquota" : "32.00"
        }
      ]
    }
  ]
}
ICMS > Alíquota ICMS-ST
Parâmetro Obrigatório Tipo Tam. Descrição
estado
string 2 Sigla da UF
Ex: PR
valor
string 3v2 Valor da alíquota
0.00
{
  "icms": [
    {
      ...
      "aliquota_icms_st" : [
        {
          "estado" : "PR",
          "aliquota" : "32.00"
        },
        {
          "estado" : "SC",
          "aliquota" : "32.00"
        },
        {
          "estado" : "RS",
          "aliquota" : "32.00"
        }
      ]
    }
  ]
}
ICMS > Alíquota FCP
Parâmetro Obrigatório Tipo Tam. Descrição
estado
string 2 Sigla da UF
Ex: PR
valor
string 3v2 Valor da alíquota
0.00
{
  "icms": [
    {
      ...
      "aliquota_fcp" : [
        {
          "estado" : "PR",
          "aliquota" : "32.00"
        },
        {
          "estado" : "SC",
          "aliquota" : "32.00"
        },
        {
          "estado" : "RS",
          "aliquota" : "32.00"
        }
      ]
    }
  ]
}
ICMS > Alíquota FCP-ST
Parâmetro Obrigatório Tipo Tam. Descrição
estado
string 2 Sigla da UF
Ex: PR
valor
string 3v2 Valor da alíquota
0.00
{
  "icms": [
    {
      ...
      "aliquota_fcp_st" : [
        {
          "estado" : "PR",
          "aliquota" : "32.00"
        },
        {
          "estado" : "SC",
          "aliquota" : "32.00"
        },
        {
          "estado" : "RS",
          "aliquota" : "32.00"
        }
      ]
    }
  ]
}
ICMS > Benefício Fiscal
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
estado
string 2 Sigla da UF
Ex: PR
codigo
string --- Código de benefício fiscal
{
  "icms": [
    {
      "tipo_tributacao": "normal",
      "cenario": "saida_dentro_estado",
      "tipo_pessoa": "juridica",
      "codigo_cfop": "5102",
      "situacao_tributaria": "20",
      "beneficio_fiscal" : [
        {
          "estado" : "PR",
          "codigo" : "AA0000"
        },
        {
          "estado" : "SC",
          "codigo" : "AA0000"
        },
        {
          "estado" : "RS",
          "codigo" : "AA0000"
        }
      ]
    }
  ]
}
IPI
Parâmetro Obrigatório Tipo Tam. Descrição
cenario
string --- Cenário de tributação
padrao
saida_dentro_estado
saida_fora_estado
saida_exterior
entrada_dentro_estado
entrada_fora_estado
entrada_exterior
tipo_pessoa
string --- Tipo de pessoa
fisica
juridica
estrangeira
situacao_tributaria
string 3 Código da situação tributária
00 - Entrada com recuperação de crédito
01 - Entrada tributada com alíquota zero
02 - Entrada isenta
03 - Entrada não-tributada
04 - Entrada imune
05 - Entrada com suspensão
49 - Outras entradas
50 - Saída tributada
51 - Saída tributada com alíquota zero
52 - Saída isenta
53 - Saída não-tributada
54 - Saída imune
55 - Saída com suspensão
99 - Outras saídas
codigo_enquadramento
string 1-3 Código de enquadramento
aliquota
string 3v2 Alíquota do IPI
0.00
{
  "ipi": [
    {
      "cenario": "padrao",
      "tipo_pessoa": "fisica",
      "situacao_tributaria": "99",
      "codigo_enquadramento": "999",
      "aliquota": "0.00"
    },
    {
      "cenario": "padrao",
      "tipo_pessoa": "juridica",
      "situacao_tributaria": "99",
      "codigo_enquadramento": "999",
      "aliquota": "0.00"
    }
  ]
}
PIS
Parâmetro Obrigatório Tipo Tam. Descrição
cenario
string --- Cenário de tributação
padrao
saida_dentro_estado
saida_fora_estado
saida_exterior
entrada_dentro_estado
entrada_fora_estado
entrada_exterior
tipo_pessoa
string --- Tipo de pessoa.
fisica
juridica
estrangeira
situacao_tributaria
string 3 Código da situação tributária
01 - Operação Tributável - Base de Cálculo = Valor da Operação Alíquota Normal (Cumulativo/Não cumulativo)
02 - Operação Tributável - Base de Cálculo = Valor da Operação (Alíquota diferenciada)
03 - Operação Tributável - Base de Cálculo = Quantidade Vendida X Alíquota por Unidade de Produto
04 - Operação Tributável - Tributação Monofásica - (Alíquota Zero)
05 - Operação Tributável - (Substituição Tributária)
06 - Operação Tributável (Alíquota Zero)
07 - Operação Isenta de Contribuição
08 - Operação sem Incidência da Contribuição
09 - Operação com Suspensão da Contribuição
49 - Outras Operações de Saída
50 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Tributada no Mercado Interno
51 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Não Tributada no Mercado Interno
52 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita de Exportação
53 - Operação com Direito a Crédito - Vinculado a Receitas Tributadas e Não-Tributadas no Mercado Interno
54 - Operação com Direito a Crédito - Vinculada a Receitas Tributadas no Mercado Interno e de Exportação
55 - Operação com Direito a Crédito - Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação
56 - Operação com Direito a Crédito - Vinculado a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação
60 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Tributada no Mercado Interno
61 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Não-Tributada no Mercado Interno
62 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita de Exportação
63 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno
64 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas no Mercado Interno e de Exportação
65 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação
66 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação
67 - Crédito Presumido - Outras Operações
70 - Operação de Aquisição sem Direito a Crédito
71 - Operação de Aquisição com Isenção
72 - Operação de Aquisição com Suspensão
73 - Operação de Aquisição a Alíquota Zero
74 - Operação de Aquisição sem Incidência da Contribuição
75 - Operação de Aquisição por Substituição Tributária
98 - Outras Operações de Entrada
99 - Outras Operações
aliquota
string 3v2 Alíquota do PIS
0.00
{
  "pis": [
    {
      "cenario": "padrao",
      "tipo_pessoa": "fisica",
      "situacao_tributaria": "99",
      "aliquota": "0.00"
    },
    {
      "cenario": "padrao",
      "tipo_pessoa": "juridica",
      "situacao_tributaria": "99",
      "aliquota": "0.00"
    }
  ]
}
COFINS
Parâmetro Obrigatório Tipo Tam. Descrição
cenario
string --- Cenário de tributação
padrao
saida_dentro_estado
saida_fora_estado
saida_exterior
entrada_dentro_estado
entrada_fora_estado
entrada_exterior
tipo_pessoa
string --- Tipo de pessoa
fisica
juridica
estrangeira
situacao_tributaria
string 3 Código da situação tributária
01 - Operação Tributável - Base de Cálculo = Valor da Operação Alíquota Normal (Cumulativo/Não cumulativo)
02 - Operação Tributável - Base de Cálculo = Valor da Operação (Alíquota diferenciada)
03 - Operação Tributável - Base de Cálculo = Quantidade Vendida X Alíquota por Unidade de Produto
04 - Operação Tributável - Tributação Monofásica - (Alíquota Zero)
05 - Operação Tributável - (Substituição Tributária)
06 - Operação Tributável (Alíquota Zero)
07 - Operação Isenta de Contribuição
08 - Operação sem Incidência da Contribuição
09 - Operação com Suspensão da Contribuição
49 - Outras Operações de Saída
50 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Tributada no Mercado Interno
51 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Não Tributada no Mercado Interno
52 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita de Exportação
53 - Operação com Direito a Crédito - Vinculado a Receitas Tributadas e Não-Tributadas no Mercado Interno
54 - Operação com Direito a Crédito - Vinculada a Receitas Tributadas no Mercado Interno e de Exportação
55 - Operação com Direito a Crédito - Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação
56 - Operação com Direito a Crédito - Vinculado a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação
60 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Tributada no Mercado Interno
61 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Não-Tributada no Mercado Interno
62 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita de Exportação
63 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno
64 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas no Mercado Interno e de Exportação
65 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação
66 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação
67 - Crédito Presumido - Outras Operações
70 - Operação de Aquisição sem Direito a Crédito
71 - Operação de Aquisição com Isenção
72 - Operação de Aquisição com Suspensão
73 - Operação de Aquisição a Alíquota Zero
74 - Operação de Aquisição sem Incidência da Contribuição
75 - Operação de Aquisição por Substituição Tributária
98 - Outras Operações de Entrada
99 - Outras Operações
aliquota
string 3v2 Alíquota do COFINS
0.00
{
  "cofins": [
    {
      "cenario": "padrao",
      "tipo_pessoa": "fisica",
      "situacao_tributaria": "99",
      "aliquota": "0.00"
    },
    {
      "cenario": "padrao",
      "tipo_pessoa": "juridica",
      "situacao_tributaria": "99",
      "aliquota": "0.00"
    }
  ]
}
ISSQN
Parâmetro Obrigatório Tipo Tam. Descrição
cenario
string --- Cenário de tributação
padrao
saida_dentro_estado
saida_fora_estado
saida_exterior
entrada_dentro_estado
entrada_fora_estado
entrada_exterior
tipo_pessoa
string --- Tipo de pessoa
fisica
juridica
estrangeira
codigo_cfop
string 4 Código Fiscal de Operações e Prestações (CFOP)
0.000
exigibilidade
string 1 Indicador da 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
item_servico
string 5 Item da lista de serviços em que se classifica o serviço no padrão ABRASF
00.00
incentivo_fiscal
string 1 Indicador de incentivo Fiscal
1 - Sim
2 - Não
aliquota
string 3v2 Alíquota do ISSQN
0.00
municipio
string --- Município de incidência do imposto
codigo_servico
string 1-20 Código do serviço prestado dentro do município
{
  "issqn": [
    {
      "cenario": "padrao",
      "tipo_pessoa": "fisica",
      "codigo_cfop": "5.933",
      "exigibilidade": "1",
      "item_servico": "00.00",
      "incentivo_fiscal": "0",
      "aliquota": "5.00"
    },
    {
      "cenario": "padrao",
      "tipo_pessoa": "juridica",
      "codigo_cfop": "5.933",
      "exigibilidade": "1",
      "item_servico": "00.00",
      "incentivo_fiscal": "0",
      "aliquota": "5.00"
    },
  ]
}

Classe de imposto
Listar

Para listar classes de impostos, envie a requisição no método GET para a URL /1/nfe/classe-imposto/.

  curl -X GET \
  -H "X-Consumer-Key: SEU_CONSUMER_KEY" \
  -H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
  -H "X-Access-Token: SEU_ACCESS_TOKEN" \
  -H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
  -H "Content-Type: application/json" \
  https://webmaniabr.com/api/1/nfe/classe-imposto/

A resposta do corpo da mensagem será no formato JSON, contendo todas as informações de cada classe de imposto cadastrada:

[
  {
    "referencia": "REF12352465",
    "descricao": "Saída de produtos",
    "data": "2023-04-01 14:45:00",
    "icms": [],
    "ipi": [],
    "pis": [],
    "cofins": []
  },
  {
    "referencia": "REF43673367",
    "descricao": "Entrada de produtos",
    "data": "2023-04-01 15:02:21",
    "icms": [],
    "ipi": [],
    "pis": [],
    "cofins": []
  }
]

Classe de imposto
Excluir

Para excluir classes de impostos, envie a requisição no método DELETE para a URL /1/nfe/classe-imposto/, contendo no corpo da requisição o parâmetro referencia no formato JSON.

Parâmetro Obrigatório Tipo Tam. Descrição
referencia
string | array --- Referência da classe de imposto
Informe array para excluír mais de uma classes de imposto ao mesmo tempo.

Segue exemplo de JSON para excluir classes de impostos:

  curl -X DELETE \
  -H "X-Consumer-Key: SEU_CONSUMER_KEY" \
  -H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
  -H "X-Access-Token: SEU_ACCESS_TOKEN" \
  -H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "referencia":["REF0000000", "REF0000000"]
  }' \
  https://webmaniabr.com/api/1/nfe/classe-imposto/

A resposta do corpo da mensagem será no formato JSON, contendo os parâmetros referencia e msg:

[
  {
    "referencia": "REF12352465",
    "msg": "Classe de imposto excluída com sucesso."
  },
  {
    "referencia": "REF43673367",
    "msg": "Classe de imposto excluída com sucesso."
  }
]

Impostos na API

Existem duas formas de definir impostos para emissão da Nota Fiscal, através do cadastro da Classe de Imposto ou diretamente na API.

Informar os impostos diretamente na API é recomendado para operações que a Classe de Imposto não abrange ou para maior flexibilidade de personalização.

Os parâmetros dos impostos ICMS, ICMS-ST, IPI, PIS, COFINS e ISSQN são enviados a cada emissão de nota fiscal e devem ser montados no parâmetro impostos.

Segue abaixo a tabela dos impostos na definição do parâmetro impostos:

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
icms
array --- Informações do imposto ICMS
ipi
array --- Informações do imposto IPI
pis
array --- Informações do imposto PIS
cofins
array --- Informações do imposto COFINS
issqn
array --- Informações do imposto ISSQN
retencao_tributos
array --- Retenção de Tributos
importacao
array --- Informações do imposto de Importação

Segue abaixo exemplo do preenchimento dos impostos diretamente na API para uma empresa de tributação Simples Nacional:

{
  ...
  "produtos": [
     {
        "nome": "Camisetas Night Run",
        "codigo": "camiseta-night-run",
        "ean": "0789602015376",
        "ncm": "6109.10.00",
        "cest": "28.038.00",
        "quantidade": 3,
        "unidade": "UN",
        "peso": "0.800",
        "origem": 0,
        "subtotal": "44.90",
        "total": "134.70",
        "impostos": {
          "icms": {
             "codigo_cfop": "5.102",
             "situacao_tributaria": "102"
          },
          "ipi": {
             "situacao_tributaria": "99",
             "codigo_enquadramento": 999,
             "aliquota": "0.00"
          },
          "pis": {
             "situacao_tributaria": "99",
             "aliquota": "0.00"
          },
          "cofins": {
             "situacao_tributaria": "99",
             "aliquota": "0.00"
          }
        }
     }
  ],
  ...
}

ICMS
Simples Nacional

Parâmetros e códigos de situação tributária exclusivos para empresas do Simples Nacional. As informações do ICMS são informados dentro da array icms.

Segue abaixo os parâmetros específicos para cada situação tributária, listando os campos obrigatórios e opcionais de cada uma.

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
aliquota
string 3v2 Alíquota do ICMS (opcional)
Na Webmania® o ICMS e a base de cálculo é automático! Saiba mais
0.00
Somos especialistas em tributação. Atualmente são mais de 5.000 regras e legislações, atualizadas constantemente pelo time de Experts Contábeis da Webmania para todos os estados brasileiros. Evite erros na alíquota e cálculos do ICMS, garanta as suas operações com a tecnologia da Webmania.
aliquota_fcp NOVO
string 3v2 Alíquota do FCP (opcional)
Na Webmania® o FCP e a base de cálculo é automático! Saiba mais
codigo_cfop
string 4 Código Fiscal de Operações e Prestações (CFOP)
0.000
situacao_tributaria
string 3 Código da situação tributária
101 - Tributada com permissão de crédito
102 - Tributada sem permissão de crédito
103 - Isenção do ICMS para faixa de receita bruta
201 - Tributada com permissão de crédito e com cobrança do ICMS por substituição tributária
202 - Tributada sem permissão de crédito e com cobrança do ICMS por substituição tributária
203 - Isenção do ICMS para faixa de receita bruta e com cobrança do ICMS por substituição tributária
300 - Imune
400 - Não tributada
500 - ICMS cobrado anteriormente por substituição tributária (substituído) ou por antecipação
900 - Outros
Padrão: 102
aliquota_importacao
string 3v2 *Obrigatório para Nota Fiscal de importação:
Alíquota do ICMS de importação
0.00
industria
string 1 Informe caso a venda do produto seja destinada a uma indústria para o uso e consumo final. Caso a venda seja destinada para uma indústria para uso no processo industrial ou não tenha nenhuma relação, mantenha valor nulo.
0 - Não
1 - Sim
majoracao
string 13v2 A majoração é a elevação do valor da prestação tributária, opera-se por meio da manipulação da base de cálculo.
0.00
Simples Nacional: ICMS 101
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
aliquota_credito
string 3v2 Alíquota aplicável de cálculo de crédito
0.00
"impostos": {
   "icms": {
     "codigo_cfop": "5.102",
     "situacao_tributaria": "101",
     "aliquota_credito": "10.00"
   }
 }
Simples Nacional: ICMS 201
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
aliquota_st
string 3v2 Alíquota do ICMS-ST (opcional)
Na Webmania® o ICMS-ST e a base de cálculo é automático! Saiba mais
0.00
Somos especialistas em tributação. Atualmente são mais de 5.000 regras e legislações, atualizadas constantemente pelo time de Experts Contábeis da Webmania para todos os estados brasileiros. Evite erros na alíquota e cálculos do ICMS-ST, garanta as suas operações com a tecnologia da Webmania.
aliquota_fcp_st NOVO
string 3v2 Alíquota do FCP-ST (opcional)
Na Webmania® o FCP-ST e a base de cálculo é automático! Saiba mais
aliquota_mva
string 3v2 Percentual da Margem de Valor Agregado Original (MVA/IVA Original) para cálculo do ICMS-ST. A definição da MVA Ajustada é realizada automaticamente.
0.00
aliquota_credito
string 3v2 Alíquota aplicável de cálculo de crédito
0.00
aliquota_reducao
string 3v4 Alíquota da redução da base de cálculo ICMS
0.0000
aliquota_reducao_st
string 3v4 Alíquota da redução da base de cálculo ICMS-ST
0.0000
"impostos": {
   "icms": {
     "codigo_cfop": "5.402",
     "situacao_tributaria": "201",
     "aliquota_credito": "10.00",
     "aliquota_mva": "20.00"
   }
 }
Simples Nacional: ICMS 202 e 203
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
aliquota_st
string 3v2 Alíquota do ICMS-ST (opcional)
Na Webmania® o ICMS-ST e a base de cálculo é automático! Saiba mais
0.00
Somos especialistas em tributação. Atualmente são mais de 5.000 regras e legislações, atualizadas constantemente pelo time de Experts Contábeis da Webmania para todos os estados brasileiros. Evite erros na alíquota e cálculos do ICMS-ST, garanta as suas operações com a tecnologia da Webmania.
aliquota_fcp_st NOVO
string 3v2 Alíquota do FCP-ST (opcional)
Na Webmania® o FCP-ST e a base de cálculo é automático! Saiba mais
aliquota_mva
string 3v2 Percentual da Margem de Valor Agregado Original (MVA/IVA Original) para cálculo do ICMS-ST. A definição da MVA Ajustada é realizada automaticamente.
0.00
aliquota_reducao
string 3v4 Alíquota da redução da base de cálculo ICMS
0.0000
aliquota_reducao_st
string 3v4 Alíquota da redução da base de cálculo ICMS-ST
0.0000
"impostos": {
   "icms": {
     "codigo_cfop": "5.402",
     "situacao_tributaria": "202",
     "aliquota_mva": "20.00"
   }
 }
Simples Nacional: ICMS 500
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
bc_st_retido
string 13v2 Valor da BC do ICMS-ST retido (cobrado anteriormente por ST).
O valor pode ser omitido quando a legislação não exigir a sua informação.
aliquota_st_retido
string 3v2 Alíquota do ICMS-ST retido (cobrado anteriormente por ST), incluso o FCP caso incida sobre a mercadoria.
Exemplo: alíquota da mercadoria na venda ao consumidor final = 18% e 2% de FCP, a alíquota a ser informada deve ser 20%.

O valor pode ser omitido quando a legislação não exigir a sua informação.
valor_st_retido
string 13v2 Valor do ICMS-ST retido (cobrado anteriormente por ST).
O valor pode ser omitido quando a legislação não exigir a sua informação.
valor_icms_substituto
string 13v2 Valor do ICMS próprio do Substituto (cobrado anteriormente).
O valor pode ser omitido quando a legislação não exigir a sua informação.
valor_fcp_retido
string 13v2 Valor da Base de Cálculo do FCP retido anteriormente por ST.
O valor pode ser omitido quando a legislação não exigir a sua informação.
aliquota_fcp_retido
string 3v2 Alíquota do Fundo de Combate à Pobreza (FCP) retido anteriormente por ST.
O valor pode ser omitido quando a legislação não exigir a sua informação.
aliquota_bc_efetivo
string 3v2 Percentual de redução da base de cálculo efetivo
Percentual de redução, caso estivesse submetida ao regime comum de tributação, para obtenção da base de cálculo efetiva. (opcional a critério da UF)
aliquota_icms_efetivo
string 3v2 Alíquota do ICMS efetivo
Alíquota do ICMS na operação a consumidor final, caso estivesse submetida ao regime comum de tributação. (opcional a critério da UF)
"impostos": {
   "icms": {
     "codigo_cfop": "5.102",
     "situacao_tributaria": "500",
     "bc_st_retido": "1000.00",
     "aliquota_st_retido": "20.00",
     "valor_st_retido": "200.00",
     ...
   }
 }

ICMS
Tributação Normal

Parâmetros e códigos de situação tributária exclusivos para empresas do Lucro Normal e Presumido. As informações do ICMS são informados dentro da array icms.

Segue abaixo os parâmetros específicos para cada situação tributária, listando os campos obrigatórios e opcionais de cada uma.

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
aliquota
string 3v2 Alíquota do ICMS (opcional)
Na Webmania® o ICMS e a base de cálculo é automático! Saiba mais
0.00
Somos especialistas em tributação. Atualmente são mais de 5.000 regras e legislações, atualizadas constantemente pelo time de Experts Contábeis da Webmania para todos os estados brasileiros. Evite erros na alíquota e cálculos do ICMS, garanta as suas operações com a tecnologia da Webmania.
aliquota_fcp NOVO
string 3v2 Alíquota do FCP (opcional)
Na Webmania® o FCP e a base de cálculo é automático! Saiba mais
codigo_cfop
string 4 Código Fiscal de Operações e Prestações (CFOP)
0.000
situacao_tributaria
string 2 Código da situação tributária
00 - Tributada integralmente
10 - Tributada e com cobrança do ICMS por substituição tributária
20 - Com redução da base de cálculo
30 - Isenta ou não tributada e com cobrança do ICMS por substituição tributária
40 - Isenta
41 - Não tributada
50 - Suspensão
51 - Diferimento
60 - ICMS cobrado anteriormente por substituição tributária
70 - Com redução de base de cálculo e cobrança do ICMS por substituição tributária
90 - Outros
Padrão: 00
aliquota_importacao
string 3v2 *Obrigatório para Nota Fiscal de importação:
Alíquota do ICMS de importação
0.00
industria
string 1 Informe caso a venda do produto seja destinada a uma indústria para o uso e consumo final. Caso a venda seja destinada para uma indústria para uso no processo industrial ou não tenha nenhuma relação, mantenha valor nulo.
0 - Não
1 - Sim
majoracao
string 13v2 A majoração é a elevação do valor da prestação tributária, opera-se por meio da manipulação da base de cálculo.
0.00
Tributação Normal: ICMS 10 e 30
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
aliquota_st
string 3v2 Alíquota do ICMS-ST (opcional)
Na Webmania® o ICMS-ST e a base de cálculo é automático! Saiba mais
0.00
Somos especialistas em tributação. Atualmente são mais de 5.000 regras e legislações, atualizadas constantemente pelo time de Experts Contábeis da Webmania para todos os estados brasileiros. Evite erros na alíquota e cálculos do ICMS-ST, garanta as suas operações com a tecnologia da Webmania.
aliquota_fcp_st NOVO
string 3v2 Alíquota do FCP-ST (opcional)
Na Webmania® o FCP-ST e a base de cálculo é automático! Saiba mais
aliquota_mva
string 3v2 Percentual da Margem de Valor Agregado Original (MVA/IVA Original) para cálculo do ICMS-ST. A definição da MVA Ajustada é realizada automaticamente.
0.00
aliquota_reducao_st
string 3v4 Alíquota da redução da base de cálculo ICMS-ST
0.0000
motivo_desoneracao_st
string 1-2 Motivo da desoneração do ICMS-ST.
3 - Uso na agropecuária
9 - Outros
12 - Órgão de fomento e desenvolvimento agropecuário
"impostos": {
   "icms": {
     "codigo_cfop": "5.402",
     "situacao_tributaria": "10",
     "aliquota_mva": "20.00"
   }
 }
Tributação Normal: ICMS 20
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
aliquota_reducao
string 3v4 Alíquota da redução da base de cálculo ICMS
0.0000
motivo_desoneracao
string 1-2 Motivo da desoneração do ICMS. O desconto tributário é aplicado automaticamente no valor total da NF-e.
3 - Uso na agropecuária
9 - Outros
12 - Órgão de fomento e desenvolvimento agropecuário
"impostos": {
   "icms": {
     "codigo_cfop": "5.102",
     "situacao_tributaria": "20",
     "aliquota_reducao": "20.00"
   }
 }
Tributação Normal: ICMS 40 e 41
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
motivo_desoneracao
string 1-2 Motivo da desoneração do ICMS. O desconto tributário é aplicado automaticamente no valor total da NF-e.
3 - Uso na agropecuária
9 - Outros
12 - Órgão de fomento e desenvolvimento agropecuário
"impostos": {
   "icms": {
     "codigo_cfop": "5.102",
     "situacao_tributaria": "40",
     "motivo_desoneracao": "9"
   }
 }
Tributação Normal: ICMS 51
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
aliquota_diferimento
string 3v2 Percentual do diferimento
0.00
aliquota_diferimento_fcp
string 3v2 Percentual do diferimento do ICMS relativo ao Fundo de Combate à Pobreza (FCP)
0.00
motivo_desoneracao
string 1-2 Motivo da desoneração do ICMS. O desconto tributário é aplicado automaticamente no valor total da NF-e.
3 - Uso na agropecuária
9 - Outros
12 - Órgão de fomento e desenvolvimento agropecuário
"impostos": {
   "icms": {
     "codigo_cfop": "5.102",
     "situacao_tributaria": "51",
     "aliquota_diferimento": "20.00"
   }
 }
Tributação Normal: ICMS 60
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
bc_st_retido
string 13v2 Valor da BC do ICMS-ST retido (cobrado anteriormente por ST).
O valor pode ser omitido quando a legislação não exigir a sua informação.
aliquota_st_retido
string 3v2 Alíquota do ICMS-ST retido (cobrado anteriormente por ST), incluso o FCP caso incida sobre a mercadoria.
Exemplo: alíquota da mercadoria na venda ao consumidor final = 18% e 2% de FCP, a alíquota a ser informada deve ser 20%.

O valor pode ser omitido quando a legislação não exigir a sua informação.
valor_st_retido
string 13v2 Valor do ICMS-ST retido (cobrado anteriormente por ST).
O valor pode ser omitido quando a legislação não exigir a sua informação.
bc_st_dest
string 13v2 Valor da BC do ICMS-ST da UF Destino.
O valor pode ser omitido quando a legislação não exigir a sua informação.
valor_st_dest
string 13v2 Valor do ICMS-ST da UF Destino.
O valor pode ser omitido quando a legislação não exigir a sua informação.
valor_fcp_retido
string 13v2 Valor da Base de Cálculo do FCP retido anteriormente por ST.
O valor pode ser omitido quando a legislação não exigir a sua informação.
aliquota_fcp_retido
string 3v2 Alíquota do Fundo de Combate à Pobreza (FCP) retido anteriormente por ST.
O valor pode ser omitido quando a legislação não exigir a sua informação.
aliquota_bc_efetivo
string 3v2 Percentual de redução da base de cálculo efetivo
Percentual de redução, caso estivesse submetida ao regime comum de tributação, para obtenção da base de cálculo efetiva. (opcional a critério da UF)
aliquota_icms_efetivo
string 3v2 Alíquota do ICMS efetivo
Alíquota do ICMS na operação a consumidor final, caso estivesse submetida ao regime comum de tributação. (opcional a critério da UF)
"impostos": {
   "icms": {
     "codigo_cfop": "5.102",
     "situacao_tributaria": "60",
     "bc_st_retido": "1000.00",
     "aliquota_st_retido": "20.00",
     "valor_st_retido": "200.00",
     ...
   }
 }
Tributação Normal: ICMS 70
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
aliquota_st
string 3v2 Alíquota do ICMS-ST (opcional)
Na Webmania® o ICMS-ST e a base de cálculo é automático! Saiba mais
0.00
Somos especialistas em tributação. Atualmente são mais de 5.000 regras e legislações, atualizadas constantemente pelo time de Experts Contábeis da Webmania para todos os estados brasileiros. Evite erros na alíquota e cálculos do ICMS-ST, garanta as suas operações com a tecnologia da Webmania.
aliquota_fcp_st NOVO
string 3v2 Alíquota do FCP-ST (opcional)
Na Webmania® o FCP-ST e a base de cálculo é automático! Saiba mais
aliquota_mva
string 3v2 Percentual da Margem de Valor Agregado Original (MVA/IVA Original) para cálculo do ICMS-ST. A definição da MVA Ajustada é realizada automaticamente.
0.00
aliquota_reducao
string 3v4 Alíquota da redução da base de cálculo ICMS
0.0000
aliquota_reducao_st
string 3v4 Alíquota da redução da base de cálculo ICMS-ST
0.0000
motivo_desoneracao
string 1-2 Motivo da desoneração do ICMS. O desconto tributário é aplicado automaticamente no valor total da NF-e.
3 - Uso na agropecuária
9 - Outros
12 - Órgão de fomento e desenvolvimento agropecuário
motivo_desoneracao_st
string 1-2 Motivo da desoneração do ICMS-ST.
3 - Uso na agropecuária
9 - Outros
12 - Órgão de fomento e desenvolvimento agropecuário
"impostos": {
   "icms": {
     "codigo_cfop": "5.402",
     "situacao_tributaria": "51",
     "aliquota_reducao": "10.00",
     "aliquota_mva": "20.00"
   }
 }

ICMS
MVA

O cálculo da Substituição Tributária através do MVA (Margem de Valor Agregado) é o modelo mais adotado pelos estados, este modelo está disponível para Simples Nacional e Normal.

A alíquota varia de acordo com o produto (NCM) e o destino da mercadoria (Estado), sendo que este deve ser informado pelo contador. Para situações tributárias com ICMS-ST deve ser informado o parâmetro aliquota_mva dentro da array icms.

Parâmetro Tipo Tam. Descrição
aliquota_mva string 3v2 Percentual da Margem de Valor Agregado Original (MVA/IVA Original) para cálculo do ICMS-ST. A definição da MVA Ajustada é realizada automaticamente.
0.00

Segue exemplo de preenchimento do MVA dentro da array icms:

"impostos": {
   "icms": {
     "codigo_cfop": "5.402",
     "situacao_tributaria": "10",
     "aliquota_mva": "20.00"
   }
 }

ICMS
Pauta Fiscal

O cálculo da Substituição Tributária através da Pauta Fiscal é um modelo usado por alguns estados e para determinados tipos de produto, que busca fixar a obrigação tributária através de um valor pré-fixado.

O valor da Pauta varia de acordo com o produto (NCM) e o destino da mercadoria (Estado), sendo que este deve ser informado pelo contador. Para situações tributárias com ICMS-ST deve ser informado o parâmetro pauta_fiscal em substituição da aliquota_mva dentro da array icms.

Parâmetro Tipo Tam. Descrição
pauta_fiscal string 13v2 Valor em reais da Pauta para cálculo do ICMS-ST. O cálculo do ICMS baseado no valor da Pauta é realizado automaticamente.
0.00

Segue exemplo de preenchimento da Pauta Fiscal dentro da array icms:

"impostos": {
   "icms": {
     "codigo_cfop": "5.402",
     "situacao_tributaria": "10",
     "pauta_fiscal": "15.00"
   }
 }

ICMS
Valor da Operação

O cálculo da Substituição Tributária através do Valor da Operação viabiliza, entre outras necessidades, o preenchimento da NF-e em operações realizadas por contribuintes substitutos tributários responsáveis pelo pagamento.

Para situações tributárias com ICMS-ST deve ser informado o parâmetro valor_operacao em substituição da aliquota_mva dentro da array icms.

Parâmetro Tipo Tam. Descrição
valor_operacao string 13v2 Valor em reais do Valor da Operação para cálculo do ICMS-ST. O cálculo do ICMS baseado no valor da operação é realizado automaticamente.
0.00

Segue exemplo de preenchimento da Pauta Fiscal dentro da array icms:

"impostos": {
   "icms": {
     "codigo_cfop": "5.402",
     "situacao_tributaria": "10",
     "valor_operacao": "150.00"
   }
 }

Informações dos Produtos > Impostos
IPI

As informações do imposto IPI são montados dentro da array IPI conforme mostrado na tabela impostos. Segue abaixo os parâmetros do imposto IPI:

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
situacao_tributaria
string 2 Código da situação tributária
00 - Entrada com recuperação de crédito
01 - Entrada tributada com alíquota zero
02 - Entrada isenta
03 - Entrada não-tributada
04 - Entrada imune
05 - Entrada com suspensão
49 - Outras entradas
50 - Saída tributada
51 - Saída tributada com alíquota zero
52 - Saída isenta
53 - Saída não-tributada
54 - Saída imune
55 - Saída com suspensão
99 - Outras saídas
Padrão: 99
codigo_enquadramento
integer 1-3 Código de enquadramento
Padrão: 999
aliquota
string 3v2 Alíquota do IPI
0.00
percentual_devolvido
string 3v2 Percentual da mercadoria devolvida (tributos devolvidos)
0.00
ipi_devolvido
string 13v2 Valor do IPI devolvido (tributos devolvidos)
0.00
codigo_selo
string 1-60 Código do selo de controle IPI
Preenchimento conforme Anexo II-A da Instrução Normativa RFB No 770/2007
qtd_selo
string 1-12 Quantidade de selo de controle
Preenchimento conforme Anexo XIV da Nota Técnica 2015.002

Segue exemplo de preenchimento do IPI dentro da array impostos:

"impostos": {
   "ipi": {
     "situacao_tributaria": "99",
     "codigo_enquadramento": "999",
     "aliquota": "10.00"
   }
 }

Informações dos Produtos > Impostos
PIS

As informações do imposto PIS são montados dentro da array pis conforme mostrado na tabela impostos. Segue abaixo os parâmetros do imposto PIS:

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
situacao_tributaria
string 2 Código da situação tributária
01 - Operação Tributável - Base de Cálculo = Valor da Operação Alíquota Normal (Cumulativo/Não cumulativo)
02 - Operação Tributável - Base de Cálculo = Valor da Operação (Alíquota diferenciada)
03 - Operação Tributável - Base de Cálculo = Quantidade Vendida X Alíquota por Unidade de Produto
04 - Operação Tributável - Tributação Monofásica - (Alíquota Zero)
05 - Operação Tributável - (Substituição Tributária)
06 - Operação Tributável - (Alíquota Zero)
07 - Operação Isenta de Contribuição
08 - Operação sem Incidência da Contribuição
09 - Operação com Suspensão da Contribuição
49 - Outras Operações de Saída
50 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Tributada no Mercado Interno
51 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Não Tributada no Mercado Interno
52 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita de Exportação
53 - Operação com Direito a Crédito - Vinculado a Receitas Tributadas e Não-Tributadas no Mercado Interno
54 - Operação com Direito a Crédito - Vinculada a Receitas Tributadas no Mercado Interno e de Exportação
55 - Operação com Direito a Crédito - Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação
56 - Operação com Direito a Crédito - Vinculado a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação
60 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Tributada no Mercado Interno
61 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Não-Tributada no Mercado Interno
62 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita de Exportação
63 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno
64 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas no Mercado Interno e de Exportação
65 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação
66 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação
67 - Crédito Presumido - Outras Operações
70 - Operação de Aquisição sem Direito a Crédito
71 - Operação de Aquisição com Isenção
72 - Operação de Aquisição com Suspensão
73 - Operação de Aquisição a Alíquota Zero
74 - Operação de Aquisição sem Incidência da Contribuição
75 - Operação de Aquisição por Substituição Tributária
98 - Outras Operações de Entrada
99 - Outras Operações
Padrão: 99
aliquota
string 3v2 Alíquota do PIS
0.00
majoracao
string 13v2 A majoração é a elevação do valor da prestação tributária, opera-se por meio da manipulação da base de cálculo.
0.00

Segue exemplo de preenchimento do PIS dentro da array impostos:

"impostos": {
   "pis": {
     "situacao_tributaria": "99",
     "aliquota": "0.65"
   }
 }

Informações dos Produtos > Impostos
COFINS

As informações do imposto COFINS são montados dentro da array cofins conforme mostrado na tabela impostos. Segue abaixo os parâmetros do imposto COFINS:

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
situacao_tributaria
string 2 Código da situação tributária
01 - Operação Tributável - Base de Cálculo = Valor da Operação Alíquota Normal (Cumulativo/Não cumulativo)
02 - Operação Tributável - Base de Cálculo = Valor da Operação (Alíquota diferenciada)
03 - Operação Tributável - Base de Cálculo = Quantidade Vendida X Alíquota por Unidade de Produto
04 - Operação Tributável - Tributação Monofásica - (Alíquota Zero)
05 - Operação Tributável - (Substituição Tributária)
06 - Operação Tributável - (Alíquota Zero)
07 - Operação Isenta de Contribuição
08 - Operação sem Incidência da Contribuição
09 - Operação com Suspensão da Contribuição
49 - Outras Operações de Saída
50 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Tributada no Mercado Interno
51 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Não Tributada no Mercado Interno
52 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita de Exportação
53 - Operação com Direito a Crédito - Vinculado a Receitas Tributadas e Não-Tributadas no Mercado Interno
54 - Operação com Direito a Crédito - Vinculada a Receitas Tributadas no Mercado Interno e de Exportação
55 - Operação com Direito a Crédito - Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação
56 - Operação com Direito a Crédito - Vinculado a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação
60 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Tributada no Mercado Interno
61 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Não-Tributada no Mercado Interno
62 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita de Exportação
63 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno
64 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas no Mercado Interno e de Exportação
65 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação
66 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação
67 - Crédito Presumido - Outras Operações
70 - Operação de Aquisição sem Direito a Crédito
71 - Operação de Aquisição com Isenção
72 - Operação de Aquisição com Suspensão
73 - Operação de Aquisição a Alíquota Zero
74 - Operação de Aquisição sem Incidência da Contribuição
75 - Operação de Aquisição por Substituição Tributária
98 - Outras Operações de Entrada
99 - Outras Operações
Padrão: 99
aliquota
string 3v2 Alíquota do COFINS
0.00
majoracao
string 13v2 A majoração é a elevação do valor da prestação tributária, opera-se por meio da manipulação da base de cálculo.
0.00

Segue exemplo de preenchimento do COFINS dentro da array impostos:

"impostos": {
   "cofins": {
     "situacao_tributaria": "99",
     "aliquota": "3.00"
   }
 }

Informações dos Produtos > Impostos
ISSQN

Através do imposto ISSQN é possível emitir a NF-e conjugada, também conhecida como NF-e mista, para registrar a prestação de serviço juntamente com a venda de produtos na mesma operação. É necessário que o município tenha um convênio com a Sefaz do estado, para que a Sefaz faça arrecadação dos impostos e repasse aos municípios.

As informações do imposto ISSQN são montados dentro da array issqn, juntamente com a definição dos impostos pis e cofins. Segue abaixo os parâmetros do imposto ISSQN:

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
codigo_cfop
string 4 Código Fiscal de Operações e Prestações (CFOP)
0.000
exigibilidade
integer 1 Indicador da 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
item_servico
string 5 Item da lista de serviços em que se classifica o serviço no padrão ABRASF
00.00
incentivo_fiscal
string 1 Indicador de incentivo Fiscal
1 - Sim
2 - Não
aliquota
string 3v2 Alíquota do ISSQN
0.00
deducao
string 13v2 Valor da dedução da Base de Cálculo
0.00
retencoes
string 13v2 Valor de outras retenções
0.00
desconto_incondicionado
string 13v2 Valor do desconto incondicionado
0.00
desconto_condicionado
string 13v2 Valor do desconto condicionado
0.00
iss_retido
string 13v2 Valor da retenção ISS
0.00
municipio
string --- Município de incidência do imposto
Ex.: Brasília

Padrão: Cidade da empresa
codigo_servico
string 1-20 Código do serviço prestado dentro do município
processo
string 1-30 Número do processo judicial ou administrativo de suspensão da exigibilidade
Informar somente quando declarada a suspensão da exigibilidade do ISSQN

Segue exemplo de preenchimento do ISSQN dentro da array impostos:

"impostos": {
   "issqn": {
     "codigo_cfop": "5.933",
     "exigibilidade": 1,
     "codigo_servico": "10.1",
     "incentivo_fiscal": 2,
     "aliquota": "5.00",
     "deducao": "19058.70"
   },
   "ipi": {
     "situacao_tributaria": "02",
     "aliquota": "0.65"
   },
   "cofins": {
     "situacao_tributaria": "02",
     "aliquota": "4.00"
   }
 }

Informações dos Produtos > Impostos
Retenção de Tributos

As informações da Retenção de Tributos são montados dentro da array retencao_tributos conforme mostrado na tabela impostos. Segue abaixo os parâmetros:

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
valor_pis
string 13v2 Valor Retido do PIS
0.00
valor_cofins
string 13v2 Valor Retido do COFINS
0.00
valor_csll
string 13v2 Valor Retido do CSLL
0.00
bc_irrf
string 13v2 Base de Cálculo do IRRF
0.00
valor_irrf
string 13v2 Valor Retido do IRRF
0.00
bc_previdencia
string 13v2 Base de Cálculo da Retenção da Previdência Social
0.00
valor_previdencia
string 13v2 Valor da Retenção da Previdência Social
0.00

Segue exemplo de preenchimento da Retenção de Tributos dentro da array impostos:

"impostos": {
   "retencao_tributos": {
     "valor_pis": "12.58",
     "valor_cofins": "45.62",
     "valor_csll": "20.42"
   }
 }

Informações dos Produtos > Impostos
Importação

As informações do imposto de Importação são montados dentro da array importacao conforme mostrado na tabela Impostos.

Parâmetro NF-e / NFC-e Tipo Tam. Descrição
aliquota
integer 3v2 Alíquota do imposto de Importação
0.00
iof
string 3v2 Alíquota do IOF
0.00

Segue exemplo de preenchimento da Importação dentro da array impostos:

"impostos": {
   "importacao": {
     "aliquota": "18.00"
   }
 }

Impostos
Cálculo dos Impostos

O somatório do valor total da Nota Fiscal é composto por impostos como ICMS-ST, FCP-ST e PIS. Empresas que operam com Substituição Tributária (ICMS-ST) podem obter os valores totais dos impostos, antes da emissão da Nota Fiscal, para fins de faturamento e auditoria.

Para solicitar o cálculo dos impostos deve ser informado o parâmetro calculo_impostos conforme mostrado na tabela Informações da Nota Fiscal, seguindo o mesmo procedimento da emissão de Nota Fiscal.

A resposta do corpo da mensagem será no formato objeto JSON, contendo os parâmetros impostos e pedido:

{
  "impostos": {
      "pis": "0.00", // Valor Total PIS
      "icms_st": "0.00", // Valor Total ICMS-ST
      "fcp_st": "0.00", // Valor Total FCP-ST
      "issqn": "0.00" // Valor Total ISSQN
  },
  "aliquotas": {
      "icms": [ "0.00" ], // Alíquota do ICMS por produto
      "icms_st": [ "0.00" ] // Alíquota do ICMS-ST por produto
  },
  "pedido": {
      "produtos": "0.00", // Valor Total dos produtos e serviços
      "frete": "0.00", // Valor Total do Frete
      "seguro": "0.00", // Valor Total do Seguro
      "desconto": "0.00", // Valor Total do Desconto
      "despesas_acessorias": "0.00", // Outras despesas acessórias
      "total": "1000.00" // Valor Total da Nota Fiscal
  }
}

Emissão de Nota Fiscal de Devolução/Estorno

A Webmania desenvolveu um modo simplificado para emitir Notas Fiscais de Devolução de mercadorias ou NF-e de estorno para anular os efeitos fiscais de um nota fiscal emitida anteriormente. Para emitir a Nota fiscal de Devolução/Estorno, envie a requisição no método POST para a URL /1/nfe/devolucao/ contendo no corpo da requisição os objetos chave, natureza_operacao, ambiente, codigo_cfop, produtos e quantidade no formato JSON.

Parâmetro NF-e Tipo Tam. Descrição
chave | uuid
string 44 | 36 Chave ou UUID da NF-e emitida anteriormente
natureza_operacao
string 1-60 Natureza da Operação
ambiente
integer 1 Identificação do Ambiente do Sefaz
1 - Produção
2 - Homologação
classe_imposto
string --- Classe de imposto de devolução/estorno.
codigo_cfop
string 4 Código CFOP de devolução/estorno.
CFOP de devolução ou CFOP inverso para operação de estorno.
produtos
array --- Obrigatório para devolução parcial:
Número sequencial dos produtos
Para a devolução parcial dos produtos é necessário informar quais produtos serão devolvidos, indique por ordem sequencial.

Por exemplo, caso os produtos devolvidos sejam o segundo e o terceiro da nota fiscal indique o número 2 e 3 na array.
quantidade
array --- Opcional para devolução parcial:
Número da quantidade de unidades devolvidas na devolução parcial.
Indique na ordem correspondente da array produtos.
volume
string 1-15 Quantidade de volumes transportados
informacoes_fisco
string 1-2000 Informações ao Fisco
informacoes_complementares
string 1-5000 Informações Complementares ao Consumidor
url_notificacao
string --- URL de notificação para todas as atualizações de status da NF-e de devolução

Segue abaixo exemplo da emissão de uma Nota Fiscal de Devolução:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "chave":"00000000000000000000000000000000000000000000",
  "natureza_operacao":"Devolução de venda de produção do estabelecimento",
  "codigo_cfop":"1.202", // Código CFOP de devolução
  "produtos": [ 2, 3 ], // Número sequencial dos produtos
  "quantidade": [ 5, 1 ], // Ex.: Produto 2 = 5 unidades / Produto 3 = 1 unidade
  "ambiente":"1", // 1 - Produção ou 2 - Homologação
  "volume":"1" // Quantidade de volumes transportados
}' \
https://webmaniabr.com/api/1/nfe/devolucao/

Segue abaixo exemplo da emissão de uma Nota Fiscal de Estorno:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "chave":"00000000000000000000000000000000000000000000",
  "natureza_operacao":"999 - Estorno de NF-e não cancelada no prazo legal",
  "codigo_cfop":"1.102" // CFOP inverso da operação 5.102
}' \
https://webmaniabr.com/api/1/nfe/devolucao/

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos uuid, status, nfe, serie, recibo, chave, xml, danfe e log:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "aprovado", // aprovado, reprovado, cancelado, denegado, processamento ou contingencia
  "nfe": "25000", // Número da NF-e
  "serie": "1", // Número de série
  "recibo": "000000000000000", // Número do recibo
  "chave": "00000000000000000000000000000000000000000000", // Número da chave de acesso
  "xml": "http://nfe.seudominio.com.br/xmlnfe/[chave|uuid]/",
  "danfe": "http://nfe.seudominio.com.br/danfe/[chave|uuid]/",
  "log": "{...}" // Log de retorno do SEFAZ
}

Emissão de Nota Fiscal de Ajuste

A Nota Fiscal de Ajuste é destinada somente para fins específicos de escrituração contábil para empresas de Lucro Normal ou Presumido, não representando saída ou entrada de produtos. Utilizado para nota de crédito de ICMS como transferência, ressarcimento ou restituição do ICMS.

Para emitir a Nota Fiscal de Ajuste, envie a requisição no método POST para a URL /1/nfe/ajuste/ contendo no corpo da requisição os objetos operacao, natureza_operacao, codigo_cfop, valor_icms, ambiente e cliente no formato JSON.

A nota fiscal de estorno da Sefaz SC e ES, emitidas com a finalidade de ajuste para cancelar notas fiscais com prazo superior a 24 horas, devem ser emitidas no endpoint /1/nfe/devolucao/.
Parâmetro NF-e Tipo Tam. Descrição
operacao
integer 1 Tipo de Operação da Nota Fiscal
0 - Entrada
1 - Saída
natureza_operacao
string 1-60 Natureza da Operação
codigo_cfop
string 4 Código CFOP de ajuste
valor_icms
string 13v2 Valor do ICMS a ser ajustado
0.00
valor_icms_st
string 13v2 Valor do ICMS ST a ser ajustado
0.00
ambiente
integer 1 Identificação do Ambiente do Sefaz
1 - Produção
2 - Homologação
cliente
array --- Informações do cliente
situacao_tributaria
string 3-4 Código da situação tributária
Informar a situação tributária da operação do ICMS de ajuste
informacoes_fisco
string 1-2000 Informações ao Fisco
informacoes_complementares
string 1-5000 Informações Complementares ao Consumidor

Segue abaixo exemplo da emissão de uma Nota Fiscal de Ajuste:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "operacao": 1,
  "natureza_operacao": "CREDITO ICMS S/ ESTOQUE",
  "codigo_cfop": "2.949",
  "valor_icms": "1000.00", // Valor do ICMS a ser ajustado
  "ambiente": "1",
  "cliente": {
    "cpf": "000.000.000-00",
    "nome_completo": "Nome do Cliente",
    "endereco": "Av. Brg. Faria Lima",
    "complemento": "Escritório",
    "numero": 1000,
    "bairro": "Itaim Bibi",
    "cidade": "São Paulo",
    "uf": "SP",
    "cep": "00000-000",
    "telefone": "(00) 0000-0000",
    "email": "nome@email.com"
  }
}' \
https://webmaniabr.com/api/1/nfe/ajuste/

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos uuid,status, nfe, serie, recibo, chave, xml, danfe e log:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "aprovado", // aprovado, reprovado, cancelado, denegado, processamento ou contingencia
  "nfe": "25000", // Número da NF-e
  "serie": "1", // Número de série
  "recibo": "000000000000000", // Número do recibo
  "chave": "00000000000000000000000000000000000000000000", // Número da chave de acesso
  "xml": "http://nfe.seudominio.com.br/xmlnfe/[chave|uuid]/",
  "danfe": "http://nfe.seudominio.com.br/danfe/[chave|uuid]/",
  "log": "{...}" // Log de retorno do SEFAZ
}

Emissão de Nota Fiscal Complementar

A Nota Fiscal Complementar é destinada para acrescentar dados e valores não informados no documento fiscal original. Utilizado para acréscimo no preço e quantidade da mercadoria ou somar valores faltantes dos impostos ICMS, ICMS-ST, IPI e ISSQN.

Para emitir a Nota Fiscal Complementar, envie a requisição no método POST para a URL /1/nfe/complementar/ contendo no corpo da requisição os objetos chave, operacao, natureza_operacao, codigo_cfop, ambiente, cliente, produtos e impostos no formato JSON.

Parâmetro NF-e Tipo Tam. Descrição
chave | uuid
string 44 | 36 Chave ou UUID da NF-e emitida anteriormente.
operacao
integer 1 Tipo de Operação da Nota Fiscal
0 - Entrada
1 - Saída
natureza_operacao
string 1-60 Natureza da Operação
ambiente
integer 1 Identificação do Ambiente do Sefaz
1 - Produção
2 - Homologação
cliente
array --- Informações do cliente
produtos
array (objetos) --- Obrigatório para complemento de preço e/ou quantidade:
Informações somente dos produtos complementares
0.00
impostos
array --- Obrigatório para complemento do ICMS, ICMS-ST, IPI e ISSQN:
Informações somente dos impostos complementares
0.00
informacoes_fisco
string 1-2000 Informações ao Fisco
informacoes_complementares
string 1-5000 Informações Complementares ao Consumidor

Segue abaixo exemplo da emissão de uma Nota Fiscal Complementar:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "chave": "00000000000000000000000000000000000000000000",
  "operacao": 1,
  "natureza_operacao": "COMPLEMENTAR",
  "ambiente": "1",
  "cliente": {
    "cpf": "000.000.000-00",
    "nome_completo": "Nome do Cliente",
    "endereco": "Av. Brg. Faria Lima",
    "complemento": "Escritório",
    "numero": 1000,
    "bairro": "Itaim Bibi",
    "cidade": "São Paulo",
    "uf": "SP",
    "cep": "00000-000",
    "telefone": "(00) 0000-0000",
    "email": "nome@email.com"
  },
  "produtos": [{ ... }], // Complementar preço e/ou quantidade
  "impostos": [ ... ], // Complementar impostos
}' \
https://webmaniabr.com/api/1/nfe/complementar/

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos uuid,status, nfe, serie, recibo, chave, xml, danfe e log:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "aprovado", // aprovado, reprovado, cancelado, denegado, processamento ou contingencia
  "nfe": "25000", // Número da NF-e
  "serie": "1", // Número de série
  "recibo": "000000000000000", // Número do recibo
  "chave": "00000000000000000000000000000000000000000000", // Número da chave de acesso
  "xml": "http://nfe.seudominio.com.br/xmlnfe/[chave|uuid]/",
  "danfe": "http://nfe.seudominio.com.br/danfe/[chave|uuid]/",
  "log": "{...}" // Log de retorno do SEFAZ
}

Emissão de Nota Fiscal Complementar
Preço e/ou quantidade

As informações dos produtos são montados dentro da array produtos como objeto para cada produto, conforme mostrado na tabela Nota Fiscal Complementar.

Deve ser identificado o produto seguindo o padrão da tabela dos Produtos e informar os parâmetros conforme necessidade de complemento do preço e/ou quantidade. Em todas as situações é necessário informar os parâmetros codigo_cfop e situacao_tributaria referente ao ICMS complementar.

Parâmetro NF-e Tipo Tam. Descrição
quantidade
integer 11v4 Obrigatório para complementar quantidade:
Quantidade de itens
subtotal
string 11v10 Obrigatório para complementar preço:
Preço unitário do produto
0.00
total
string 13v2 Obrigatório para complementar preço:
Preço total (quantidade x preço unitário)
0.00
codigo_cfop
string 4 Código Fiscal de Operações e Prestações (CFOP)
Informar o código CFOP da operação do ICMS complementar
situacao_tributaria
string 3-4 Código da situação tributária
Informar a situação tributária da operação do ICMS complementar
beneficio_fiscal
string 8 Código de benefício fiscal na UF
Deve ser utilizado o mesmo código adotado na EFD e outras declarações, nas UF que exigem.
gtin
string 8-14 GTIN do produto, antigo código EAN ou código de barras
gtin_tributavel
string 8-14 GTIN tributável do produto, antigo código EAN ou código de barras
cod_barras
string 3-30 Código de barras próprio ou de terceiros que seja diferente do padrão GTIN
cod_barras_tributavel
string 8-14 Código de barras tributável próprio ou de terceiros que seja diferente do padrão GTIN

Segue abaixo exemplo da emissão de uma Nota Fiscal Complementar de preço e/ou quantidade:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "nfe_referenciada": "00000000000000000000000000000000000000000000",
  "operacao": 1,
  "natureza_operacao": "COMPLEMENTAR",
  "ambiente": "1",
  "cliente": {
    "cpf": "000.000.000-00",
    "nome_completo": "Nome do Cliente",
    "endereco": "Av. Brg. Faria Lima",
    "complemento": "Escritório",
    "numero": 1000,
    "bairro": "Itaim Bibi",
    "cidade": "São Paulo",
    "uf": "SP",
    "cep": "00000-000",
    "telefone": "(00) 0000-0000",
    "email": "nome@email.com"
  },
  "produtos": [
    {
      "nome": "Camisetas Night Run",
      "codigo": "camiseta-night-run",
      "ncm": "6109.10.00",
      "cest": "28.038.00",
      "quantidade": 3, // Complementar quantidade
      "unidade": "UN",
      "origem": 0,
      "subtotal": "44.90", // Complementar preço
      "total": "134.70", // Complementar preço
      "beneficio_fiscal": "PR000000", // Código do benefício fiscal (opcional)
      "impostos": {
        "icms": {
          "codigo_cfop": "6.102",
          "situacao_tributaria": "101"
        }
      }
    }
  ]
}' \
https://webmaniabr.com/api/1/nfe/complementar/

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos uuid,status, nfe, serie, recibo, chave, xml, danfe e log:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "aprovado", // aprovado, reprovado, cancelado, denegado, processamento ou contingencia
  "nfe": "25000", // Número da NF-e
  "serie": "1", // Número de série
  "recibo": "000000000000000", // Número do recibo
  "chave": "00000000000000000000000000000000000000000000", // Número da chave de acesso
  "xml": "http://nfe.seudominio.com.br/xmlnfe/[chave|uuid]/",
  "danfe": "http://nfe.seudominio.com.br/danfe/[chave|uuid]/",
  "log": "{...}" // Log de retorno do SEFAZ
}

Emissão de Nota Fiscal Complementar
Imposto Complementar

As informações dos impostos são montados dentro da array impostos, conforme mostrado na tabela Nota Fiscal Complementar, onde deve ser informado os parâmetros do imposto que deseja complementar.

Segue abaixo exemplo de emissão do Imposto Complementar ICMS:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "nfe_referenciada": "00000000000000000000000000000000000000000000",
  "operacao": 1,
  "natureza_operacao": "COMPLEMENTAR",
  "ambiente": "1",
  "cliente": {
    "cpf": "000.000.000-00",
    "nome_completo": "Nome do Cliente",
    "endereco": "Av. Brg. Faria Lima",
    "complemento": "Escritório",
    "numero": 1000,
    "bairro": "Itaim Bibi",
    "cidade": "São Paulo",
    "uf": "SP",
    "cep": "00000-000",
    "telefone": "(00) 0000-0000",
    "email": "nome@email.com"
  },
  "impostos": {
    "codigo_cfop": "6.102", // Código CFOP
    "situacao_tributaria": "900", // Situação tributária do ICMS
    "bc_icms": "100.00", // Base de cálculo do complemento do ICMS
    "valor_icms": "18.00", // Valor do complemento do ICMS
    "beneficio_fiscal": "PR000000" // Código do benefício fiscal (opcional)
  }
}' \
https://webmaniabr.com/api/1/nfe/complementar/

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos uuid,status, nfe, serie, recibo, chave, xml, danfe e log:

{
    "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
    "status": "aprovado", // aprovado, reprovado, cancelado, denegado, processamento ou contingencia
    "nfe": "25000", // Número da NF-e
    "serie": "1", // Número de série
    "recibo": "000000000000000", // Número do recibo
    "chave": "00000000000000000000000000000000000000000000", // Número da chave de acesso
    "xml": "http://nfe.seudominio.com.br/xmlnfe/[chave|uuid]/",
    "danfe": "http://nfe.seudominio.com.br/danfe/[chave|uuid]/",
    "log": "{...}" // Log de retorno do SEFAZ
}
Imposto Complementar: ICMS
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
codigo_cfop
string 4 Código Fiscal de Operações e Prestações (CFOP)
Informar o código CFOP da operação do ICMS complementar
situacao_tributaria
string 3-4 Código da situação tributária
Informar a situação tributária da operação do ICMS complementar
bc_icms
string 13v2 Base de cálculo do complemento do ICMS
0.00
valor_icms
string 13v2 Valor do complemento do ICMS
0.00
beneficio_fiscal
string 8 Código de benefício fiscal na UF
Deve ser utilizado o mesmo código adotado na EFD e outras declarações, nas UF que exigem.
"impostos": {
    "codigo_cfop": "6.102",
    "situacao_tributaria": "900",
    "bc_icms": "100.00",
    "valor_icms": "18.00"
 }
Imposto Complementar: ICMS-ST
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
codigo_cfop
string 4 Código Fiscal de Operações e Prestações (CFOP)
Informar o código CFOP da operação do ICMS complementar
situacao_tributaria
string 3-4 Código da situação tributária
Informar a situação tributária da operação do ICMS complementar
bc_icms_st
string 13v2 Base de cálculo do complemento do ICMS-ST
0.00
valor_icms_st
string 13v2 Valor do complemento do ICMS-ST
0.00
aliquota_mva
string 3v2 Percentual da Margem de Valor Agregado Original (MVA/IVA)
0.00
beneficio_fiscal
string 8 Código de benefício fiscal na UF
Deve ser utilizado o mesmo código adotado na EFD e outras declarações, nas UF que exigem.
"impostos": {
    "codigo_cfop": "6.102",
    "situacao_tributaria": "10",
    "bc_icms_st": "100.00",
    "valor_icms_st": "18.00",
    "aliquota_mva": "35.12"
 }
Imposto Complementar: IPI
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
codigo_cfop
string 4 Código Fiscal de Operações e Prestações (CFOP)
Informar o código CFOP da operação
bc_ipi
string 13v2 Base de cálculo do complemento do IPI
0.00
valor_ipi
string 13v2 Valor do complemento do IPI
0.00
"impostos": {
    "codigo_cfop": "6.102",
    "bc_ipi": "100.00",
    "valor_ipi": "18.00"
 }
Imposto Complementar: ISSQN
Parâmetro NF-e / NFC-e Tipo Tam. Descrição
codigo_cfop
string 4 Código Fiscal de Operações e Prestações (CFOP)
Informar o código CFOP da operação do ISSQN complementar
exigibilidade
integer 1 Indicador da 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
item_servico
string 5 Item da lista de serviços em que se classifica o serviço no padrão ABRASF
00.00
incentivo_fiscal
string 1 Indicador de incentivo Fiscal
1 - Sim
2 - Não
bc_issqn
string 13v2 Base de cálculo do complemento do ISSQN
0.00
valor_issqn
string 13v2 Valor do complemento do ISSQN
0.00
"impostos": {
    "codigo_cfop": "6.102",
    "exigibilidade": 1,
    "item_servico": "10.01",
    "incentivo_fiscal": 2,
    "bc_issqn": "100.00",
    "valor_issqn": "18.00"
 }

Emissão da Carta de Correção (CC-e)

A Carta de Correção Eletrônica (CC-e) é um evento legal e tem por objetivo corrigir algumas informações da NF-e que já foi emitida. Para emitir a Carta de Correção, envie a requisição no método POST para a URL /1/nfe/cartacorrecao/ contendo no corpo da requisição os objetos chave, correcao e ambiente no formato JSON.

O que NÃO é permitido corrigir com a carta de correção?
- Valores como base de cálculo, alíquota, diferença de preço e quantidade.
- Dados cadastrais que implique mudança do remetente ou do destinatário.
- A data de emissão ou de saída.
- Série e número da nota fiscal.
A sua alteração não se enquadra na carta de correção?
Emita uma nota fiscal de devolução para anular os efeitos fiscais da NF-e emitida anteriormente, logo após emita uma nova Nota Fiscal normalmente.
Parâmetro NF-e Tipo Tam. Descrição
chave | uuid
string 44 | 36 Chave ou UUID da NF-e
correcao
string 15-1000 Correções a serem consideradas
Entre 15 e 1000 caracteres
ambiente
integer 1 Identificação do Ambiente do Sefaz
1 - Produção
2 - Homologação
evento
integer 1-2 Número do evento
1 a 20
url_notificacao
string --- URL de notificação para todas as atualizações de status da Carta de Correção

Segue abaixo exemplo da emissão da Carta de Correção:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "chave":"00000000000000000000000000000000000000000000", // Chave da NF-e
  "correcao":"O CFOP correto é 5.102 referente a revenda tributada no mesmo estado.", // Justificativa
}' \
https://webmaniabr.com/api/1/nfe/cartacorrecao/

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos status, xml, dacce e log:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "aprovado", // aprovado ou reprovado
  "evento": "1", // Número do evento
  "modelo": "cce", // Modelo da Nota Fiscal
  "xml": "http://nfe.seudominio.com.br/xmlcce/[uuid]/", // XML
  "dacce": "http://nfe.seudominio.com.br/dacce/[uuid]/", // Danfe
  "log": "{...}" // Log de retorno do SEFAZ
}

Manifestação do Destinatário

A Manifestação do Destinatário é um conjunto de eventos que permitem que o destinatário da NFe possa apontar a sua participação comercial descrita no documento fiscal, confirmando e controlando as operações e informações prestadas pelo seu fornecedor, que é o emissor do documento. Para realizar uma manifestação do destinatário, envie a requisição no método POST para a URL /1/nfe/manifesta/ contendo no corpo da requisição os parâmetros chave, ambiente, evento e justificativa no formato JSON.

Parâmetro NF-e Tipo Tam. Descrição
chave
string 44 Chave da nota fiscal em que o destinatário irá manifestar sua participação
ambiente
integer 1 Identificação do Ambiente da Sefaz
1 - Produção
2 - Homologação
evento
string 5 Evento correspondente a participação comercial do destinatário na nota fiscal.
210200 – Confirmação da Operação
210210 – Ciência da Operação
210220 – Desconhecimento da Operação
210240 – Operação não Realizada
justificativa
string 15-255 *Obrigatório caso o Evento seja 210240 - Operação não Realizada

Segue abaixo exemplo da manifestação do destinatário:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "chave": "00000000000000000000000000000000000000000000", // Chave da NF-e
  "ambiente": 1, // 1 - Produção ou 2 - Homologação
  "evento": "210200", // Evento 210200, 210210, 210220 ou 210240
  "justificativa": "", // Justificativa
}' \
https://webmaniabr.com/api/1/nfe/manifesta/

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos uuid, status, evento, modelo, xml, e log:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "aprovado", // aprovado ou reprovado
  "evento": "210200", // Evento da MDe
  "modelo": "mde",
  "xml": "http://nfe.seudominio.com.br/xmlmde/[uuid]/",
  "log": "{...}",
}

Status Sefaz

Para verificar se o Sefaz está Online ou Offline, envie a requisição no método GET para a URL /1/nfe/sefaz/.

  curl -X GET \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
https://webmaniabr.com/api/1/nfe/sefaz/

A resposta do corpo da mensagem será no formato objeto JSON, contendo o campo status com o retorno online ou offline:

{
  "status": "online"
}

Validade Certificado A1

Para verificar os dias que falta para expirar o Certificado A1, envie a requisição no método GET para a URL /1/nfe/certificado/.

  curl -X GET \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
https://webmaniabr.com/api/1/nfe/certificado/

A resposta do corpo da mensagem será no formato objeto JSON, contendo o campo expiration com o retorno dos dias restantes:

{
  "expiration": 25
}

Consulta de Nota Fiscal

Para consultar o status de emissão da Nota Fiscal, envie a requisição no método GET para a URL /1/nfe/consulta/ contendo na requisição o parâmetro uuid ou chave da Nota Fiscal.

Deseja consultar a Nota Fiscal e fazer download do XML de outro emissor?
Conheça API de Consulta de Nota Fiscal da Webmania®
Parâmetro NF-e Tipo Tam. Descrição
chave | uuid
string 44 | 36 Chave ou UUID da NF-e

Segue abaixo exemplo da consulta de uma Nota Fiscal:

curl -X GET \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "uuid":"43eace5c-8008-4f6c-b830-b6d52d7ff90c"
}' \
https://webmaniabr.com/api/1/nfe/consulta/

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos uuid, status, motivo, nfe, serie, xml, danfe e log:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "aprovado", // aprovado, reprovado, cancelado, denegado, processamento ou contingencia,
  "motivo": "Autorizado o uso da NF-e", // Motivo do status
  "nfe": "25000", // Número da NF-e
  "serie": "1", // Número de série
  "recibo": "000000000000000", // Número do recibo
  "chave": "00000000000000000000000000000000000000000000", // Número da chave de acesso
  "modelo": "nfe", // Modelo da Nota Fiscal (nfe, nfce, cce)
  "xml": "http://nfe.seudominio.com.br/xmlnfe/[chave|uuid]/",
  "danfe": "http://nfe.seudominio.com.br/danfe/[chave|uuid]/",
  "danfe_simples": "http://nfe.seudominio.com.br/danfe/simples/[chave|uuid]/", // Danfe Simplificada
  "danfe_etiqueta": "http://nfe.seudominio.com.br/danfe/etiqueta/[chave|uuid]/", // Danfe Simplificada - Etiqueta
  "log": "{...}" // Log de retorno do SEFAZ
}

Cancelar Nota Fiscal

Para cancelar uma Nota Fiscal, envie a requisição no método PUT para a URL /1/nfe/cancelar/.

Atenção: Somente poderá ser cancelada uma NF-e cujo uso tenha sido previamente autorizado pelo Fisco e desde que não tenha ainda ocorrido o fato gerador, ou seja, ainda não tenha ocorrido a saída da mercadoria do estabelecimento. Atualmente o prazo máximo para cancelamento de uma NF-e é de 24 horas (1 dia), contado a partir da autorização de uso. Caso já tenha passado o prazo de 24 horas ou já tenha ocorrido a circulação da mercadoria, emita uma NF-e de devolução para anular a NF-e anterior.
Parâmetro NF-e/NFC-e Tipo Tam. Descrição
chave | uuid
string 44 | 36 Chave ou UUID da NF-e
motivo
string 15-255 Motivo do cancelamento
Entre 15 e 255 caracteres

Segue abaixo exemplo de cancelamento da Nota Fiscal:

curl -X PUT \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
   "chave":"00000000000000000000000000000000000000000000",
   "motivo":"Cancelamento por motivos administrativos."
}' \
https://webmaniabr.com/api/1/nfe/cancelar/

A resposta do corpo da mensagem será no formato objeto JSON, contendo o campo xml com o protocolo XML da NF-e de cancelamento:

{
  "status": "cancelado",
  "xml": "http://nfe.seudominio.com.br/xmlnfe/[chave|uuid]/?cancelado=1",
  "log": "{...}" // Log de retorno do SEFAZ
}

Inutilizar Numeração

Para inutilizar uma sequência de numeração de Nota Fiscal, envie a requisição no método PUT para a URL /1/nfe/inutilizar/.

Atenção: A inutilização de número de NF-e tem a finalidade de permitir que o emissor comunique à SEFAZ, até o décimo dia do mês subsequente, os números de NF-e que não serão utilizados em razão de ter ocorrido uma quebra de sequência da numeração da NF-e. A inutilização de número só é possível caso a numeração ainda não tenha sido utilizada em nenhuma NF-e (autorizada, cancelada ou denegada). Exemplo: a NF-e nº 100 e a nº 110 foram emitidas, mas a faixa 101 a 109, por motivo de ordem técnica, não foi utilizada antes da emissão da nº 110.
Parâmetro NF-e Tipo Tam. Descrição
sequencia
string 3-19 Sequência da numeração
Ex.: 101-109
motivo
string 15-255 Justificativa da inutilização
ambiente
integer 1 Identificação do Ambiente do Sefaz
1 - Produção
2 - Homologação
serie
string 1-3 Série da numeração
modelo
string 1 Modelo da numeração
1 - NF-e
2 - NFC-e

Segue abaixo exemplo de inutilização da numeração:

curl -X PUT \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "sequencia":"101-109",
  "motivo":"Inutilização por problemas técnicos.",
  "ambiente":"1", // 1 - Produção ou 2 - Homologação
  "serie":"99", // Série da numeração
  "modelo":"1" // 1 - NF-e ou 2 - NFC-e
}'
https://webmaniabr.com/api/1/nfe/inutilizar/

A resposta do corpo da mensagem será no formato objeto JSON, contendo o campo xml com o protocolo XML de inutilização:

{
  "xml": "http://nfe.seudominio.com.br/xmlnfe/04abc819-2dfa-4810-a60e-5a0b53310e48/",
  "log": "{...}" // Log de retorno do SEFAZ
}

Exportar Relatórios

Os relatórios de Nota Fiscal podem ser exportados nos formatos CSV, XML e Danfe da mesma forma como é realizado no painel Webmania®. Para exportar um relatório, envie a requisição no método POST para a URL /1/nfe/relatorios/ contendo no corpo da requisição os parâmetros data_inicio, data_final, modelo e relatorio no formato JSON.

Os relatórios são exportados no modo assíncrono, verifique abaixo como acompanhar o status da exportação através da requisição e o parâmetro url_notificacao.

Parâmetro Todos modelos Tipo Tam. Descrição
data_inicio
string 10 Filtro por Data e Hora
Formato americano:
YYYY-MM-DD HH:MM:SS
data_final
string 10 Filtro por Data e Hora
Formato americano:
YYYY-MM-DD HH:MM:SS
numero_inicio
string 10 Filtro por Numeração
Disponível para Danfe e XML
numero_final
string 10 Filtro por Numeração
Disponível para Danfe e XML
modelo
string 3-4 Modelo da Nota Fiscal
nfe
nfce
cce
relatorio
string 3-14 Relatório a ser exportado
csv
excel
xml
danfe
danfe_simples
danfe_etiqueta
status
string 8-12 Filtrar status das Notas Fiscais
emitidas
canceladas
denegadas
inutilizadas
ordem
string --- Ordenação das notas no relatório
data_emissao
numeracao
ordem_alfabetica
id_pedido

Obs.: Disponível apenas para Danfe
url_notificacao
string --- URL de notificação com retorno da URL para download do Relatório

Segue abaixo exemplo da exportação do relatório do XML:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "data_inicio":"2020-01-01", // Date de início
  "data_final":"2020-01-31", // Data final
  "modelo":"nfe", // Modelo da Nota Fiscal
  "relatorio":"xml", // Relatório a ser exportado
  "status":"emitidas", // Filtrar status das Notas Fiscais
  "url_notificacao":"http://meudominio.com/retorno.php" // URL de notificação
}' \
https://webmaniabr.com/api/1/nfe/relatorios/

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos uuid, status, data_inicio, data_final, modelo, relatorio, total e processado:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "processando", // processando ou concluido
  "data_inicio": "2020-01-01",
  "data_final": "2020-01-31",
  "modelo": "xml",
  "relatorio": "danfe",
  "total": 50, // Total de resultados encontrados
  "processado": 0 // Progresso da exportação
}

Ao executar a mesma requisição na API o parâmetro processado é alterado para que seja acompanhado o progresso da exportação, recomendamos que as requisições sejam realizadas em um intervalo de no mínimo 5 segundos. Caso tenha informado o parâmetro url_notificacao, ao concluir a exportação, será enviado o retorno no formato POST para a URL especificada.

Ao concluir a exportação, o parâmetro status é alterado para concluido junto com o parâmetro url para download do relatório. Segue abaixo o retorno no formato JSON:

{
  "uuid": "43eace5c-8008-4f6c-b830-b6d52d7ff90c", // Número único de identificação
  "status": "concluido", // Exportação concluída
  "data_inicio": "2020-01-01",
  "data_final": "2020-01-31",
  "modelo": "xml",
  "relatorio": "danfe",
  "total": 50, // Total de resultados encontrados
  "url": "https://nfe.webmaniabr.com/relatorio/000000000-0000-0000-0000-000000000000/", // URL de download
  "expira": "2020-08-14" // Data de expiração do relatório
}

Atualizar empresa

As atualizações dos dados da empresa emissora podem ser feitas no painel Webmania® e via REST API para melhor gerenciamento. Para atualizar os dados da empresa via REST API, envie a requisição no método POST para a URL /1/nfe/empresa/.

As informações da sua empresa devem ser igual
ao Cadastro Nacional da Pessoa Jurídica da Receita Federal.
Parâmetro Todos modelos Tipo Tam. Descrição
tipo_tributacao
string 12, 16 Tipo de tributação
mei
simples_nacional
simples_nacional_sublimite
lucro_normal
cnpj
Pessoa Jurídica
string 14 Número do CNPJ da empresa emissora
00.000.000/0000-00
razao_social
Pessoa Jurídica
string 2-60 Razão Social da empresa
cpf
Pessoa Física
string 11 Número do CPF da pessoa física emissora
000.000.000-00
nome_completo
Pessoa Física
string 2-60 Nome completo da pessoa física
nome_fantasia
string 1-60 Nome fantasia do emissor
ie
string 2-14 Número da Inscrição Estadual
im
string 1-15 Número da Inscrição Municipal
unidade_empresa
string 6 Tipo da unidade
matriz
filial
email
string 1-60 E-mail de atendimento
telefone
string 6-14 Telefone de atendimento
contabilidade
string 14 CPF/CNPJ do contador
subdominio
string --- Subdomínio personalizado para visualização de Danfe e XML. Saiba mais
nfe.meudominio.com.br
url_notificacao
string --- URL de notificação
logomarca
string --- URL da logomarca
Formato permitido JPEG. Tamanho máximo 1MB.

Segue abaixo exemplo para atualizar os dados principais da empresa:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "tipo_tributacao": "simples_nacional",
  "cnpj": "00.000.000/0000-00",
  "razao_social": "Nome da empresa LTDA",
  "nome_fantasia": "Nome da empresa",
  "ie": "0000000000",
  "unidade_empresa": "matriz",
  "email": "email",
  "subdominio": "nfe.meudominio.com.br",
  "url_notificacao": "http://meudominio.com/retorno.php",
  "logomarca": "http://meudominio.com.br/logomarca.jpg",
}' \
https://webmaniabr.com/api/1/nfe/empresa/

A resposta do corpo da mensagem será no formato objeto JSON, contendo o campo success com a mensagem de sucesso:

{
  "success": "Empresa atualizada com sucesso."
}

Atualizar empresa
Endereço

Para atualizar o endereço da empresa, envie a requisição no método POST para a URL /1/nfe/empresa/.

As informações da sua empresa devem ser igual
ao Cadastro Nacional da Pessoa Jurídica da Receita Federal.
Parâmetro Todos modelos Tipo Tam. Descrição
cep
string 8 CEP da empresa
00000-000
endereco
string 2-60 Endereço da empresa
numero
string 1-60 Número do endereço
Caso não possua informar S/N
complemento
string 1-60 Complemento do endereço
bairro
string 2-60 Bairro do endereço
cidade
string 2-60 Cidade do endereço
uf
string 2 Estado do endereço
XX

Segue abaixo exemplo para atualizar o endereço da empresa:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "cep": "00000-000",
  "endereco": "Av. Brg. Faria Lima",
  "numero": 1000,
  "complemento": "Nome da empresa",
  "bairro": "Itaim Bibi",
  "cidade": "São Paulo",
  "uf": "SP"
}' \
https://webmaniabr.com/api/1/nfe/empresa/

Atualizar empresa
Nota Fiscal

Para atualizar as informações de numeração e série da Nota Fiscal, envie a requisição no método POST para a URL /1/nfe/empresa/.

A numeração da Nota Fiscal é gerenciada de forma automática pela Webmania, não há necessidade de alteração em cada emissão. Por esse motivo, realize a configuração inicial ou a correção da numeração caso necessário ou indicado pelo seu contador.
Parâmetro NF-e NFC-e NFS-e Tipo Tam. Descrição
cnae
string 7 CNAE da atividade principal
regime_tributacao
string 1 Regime de tributação
1 - Microempresa Municipal
2 - Estimativa
3 - Sociedade de Profissionais
4 - Cooperativa
5 - Microempresário Individual (MEI)
6 - Microempresário e Empresa de Pequeno Porte (ME/EPP)
informacoes_fisco
string 1-2000 Informações ao Fisco
Informação expressa em todas as emissões. Exemplo: Documento emitido por ME ou EPP optante pelo Simples Nacional. Não gera direito a crédito fiscal de ICMS e IPI.
nfe_serie
integer 1-3 Número de série da NF-e
nfe_numero
integer 1-9 Número da PRÓXIMA NOTA FISCAL
Ambiente de produção
nfe_numero_dev
integer 1-9 Número da PRÓXIMA NOTA FISCAL
Ambiente de homologação
nfce_serie
integer 1-3 Número de série da NFC-e
nfce_numero
integer 1-9 Número da PRÓXIMA NOTA FISCAL
Ambiente de produção
nfce_id_csc
string --- ID do Código CSC. Saiba mais
Ambiente de produção
nfce_codigo_csc
string 36 Código CSC
Ambiente de produção
nfce_numero_dev
integer 1-9 Número da PRÓXIMA NOTA FISCAL
Ambiente de homologação
nfce_id_csc_dev
string --- ID do Código CSC. Saiba mais
Ambiente de homologação
nfce_codigo_csc_dev
string 36 Código CSC
Ambiente de homologação
nfse_rps_serie
string 1-5 Série do RPS da NFS-e
nfse_rps_numero
integer 1-9 Número do PRÓXIMO RPS
Ambiente de produção
nfse_rps_numero_dev
integer 1-9 Número do PRÓXIMO RPS
Ambiente de homologação
nfse_lote_rps_numero
integer 1-9 Número do PRÓXIMO LOTE DE RPS

Segue abaixo exemplo para atualizar os dados de nota fiscal da empresa:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "nfe_serie": 1,
  "nfe_numero": 1,
  "nfe_numero_dev": 1,
  "informacoes_fisco": "Documento emitido por ME ou EPP.."
}' \
https://webmaniabr.com/api/1/nfe/empresa/

Atualizar empresa
Certificado Digital A1

Para atualizar o Certificado Digital A1, envie a requisição no método POST para a URL /1/nfe/empresa/, sendo que o parâmetro certificado deve ser enviado na codificação Base64.

Parâmetro Todos modelos Tipo Tam. Descrição
certificado
Base64 encode --- Certificado Digital A1. Saiba mais
certificado_senha
integer --- Senha do Certificado A1

Segue abaixo exemplo para atualizar o Certificado Digital A1 da empresa:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "certificado": "VXRpbGl6ZSBhIFJFU1QgQVBJIGRhIFdlYm1hbmlhQlLCriBwYXJhIHJlYWxpemFyIGludGVncmHDp8OjbyBuYSBzdWEgTG9qYSBWaXJ0dWFsLCBFUlAgZSBTaXN0ZW1hcyBGaW5hbmNlaXJvcyBwYXJhIGVtaXNzw6NvIGRlIE5vdGEgRmlzY2FsIEVsZXRyw7RuaWNhIChORi1lKSBlIE5vdGEgRmlzY2FsIGRvIENvbnN1bWlkb3IgRWxldHLDtG5pY2EgKE5GQy1lKS4=",
  "certificado_senha": 123456
}' \
https://webmaniabr.com/api/1/nfe/empresa/

Atualizar empresa
Opcionais

Para atualizar as informações opcionais da empresa, envie a requisição no método POST para a URL /1/nfe/empresa/.

Parâmetro Todos modelos Tipo Tam. Descrição
partilha_icms_contribuinte
boolean --- Simples Nacional com incidência do Diferencial de Alíquota do ICMS (DIFAL)
Específico para algumas empresas do Simples Nacional.
partilha_icms_isento
boolean --- Lucro Normal isento do Diferencial de Alíquota do ICMS (DIFAL)
Específico para algumas empresas do Lucro Normal.
orientacao_danfe
string 1 Orientação do Danfe
P - Retrato
L - Paisagem
microcervejaria
boolean --- Indicador de Microcervejaria.
Destinado para empresas classificadas como Microcervejaria, onde possui benefícios fiscais específicos para cada estado. Saiba mais.
icms_ref_sp
boolean --- Optante regime especial de tributação no fornecimento de refeições em bares e restaurantes
- Alíquota ICMS 3,69%
Estado de São Paulo
refeicoes_sp
boolean --- Optante regime especial de tributação no fornecimento
de refeições em bares e restaurantes
- Alíquota ICMS 3,69%
Estado de São Paulo
icms_ref_df
boolean --- Optante regime simplificado no fornecimento de alimentação
previsto na Lei nº 3.168/2003
- Alíquota ICMS 2%
Estado do Distrito Federal
exclusao_icms_pis_cofins
boolean --- Exclusão do ICMS da base de cálculo PIS COFINS
STF - RE 574.706/PR

Segue abaixo exemplo para atualizar as informações opcionais da empresa:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Access-Token: SEU_ACCESS_TOKEN" \
-H "X-Access-Token-Secret: SEU_ACCESS_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "orientacao_danfe": "L"
}' \
https://webmaniabr.com/api/1/nfe/empresa/

Notas Fiscais em Processamento

A Nota Fiscal Eletrônica (NF-e) é emitida no modo assíncrono junto ao Sefaz, ou seja, o procedimento de análise e liberação da Nota Fiscal em alguns momentos podem variar de segundos a minutos, e nestes casos o status da Nota Fiscal é definida inicialmente como processamento. É necessário aguardar o retorno do Sefaz, antes de enviar o produto ou solicitar a emissão de uma nova Nota Fiscal.

A Nota Fiscal do Consumidor (NFC-e) é processada no modo síncrono junto ao Sefaz, ou seja, é realizado a análise, liberação ou rejeição de imediato da 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

Notas Fiscais em Contingência

A Webmania® desenvolveu uma tecnologia exclusiva que trabalha com o ambiente de contingência do Sefaz automaticamente, assim que identificado que as operações do Sefaz se encontram offline.

  • NF-e: As notas fiscais são enviadas para os ambientes SVC-RS ou SVC-AN do Sefaz, para que sejam emitidas com validade legal podendo imprimir o Danfe e enviar os produtos normalmente.
  • NFC-e: As notas fiscais são emitidas no modo offline sem a comunicação com o Sefaz, mas com a possibilidade de imprimir o Danfe para a entrega imediata ao consumidor. O sistema da Webmania® verifica a cada minuto a operação do Sefaz e envia a NFC-e automaticamente respeitando o prazo máximo de 24 horas.
  • SAT e NFC-e: Para a emissão de NFC-e em contingência no estado de São Paulo é exigido a utilização do SAT no ponto de venda. Saiba mais como utilizar SAT junto com API da Webmania®

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 IP's estáticos, caso necessite autorize no firewall a comunicação com os seguintes IP's:

  • 13.248.145.90
  • 76.223.17.240

O retorno via POST na url_notificacao é enviado diretamente dos servidores da Webmania, que não possuem intervalos de endereço estáticos. Caso necessite autorizar os intervalos de entrada no firewall, podem ser obtidos no arquivo ip-ranges.json fornecido pela Amazon AWS ou na documentação da AWS.

Todos os arquivos são armazenados na Amazon S3 que garante 99,999999999% de durabilidade dos arquivos e criptografia de ponta a ponta, seguindo critérios rígidos de segurança e controle interno.

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.
  • Método GET: O método GET deve ser utilizado de forma sistemática e não deve ultrapassar 10 requisições por segundo ou 3.000 requisições a cada 5 minutos.
  • 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 Nota Fiscal Consulta de CEP e IBGE Nota Fiscal WooCommerce

Documentação

API Nota Fiscal de Produto API Nota Fiscal de Serviço API Manifesto Eletrônico API Consulta de Nota Fiscal API CEP e IBGE API Gerencial B2B

Webmania

Blog Clientes Sobre nós

Cases

Nordweg Podi App

Transparência

Política de Cookies Política de Privacidade Política Fiscal Contratos

Acesso rápido

Fale conosco Painel do Cliente Central de Ajuda 2ª via de Boleto Status Webmania® Monitor Sefaz
Facebook Webmania Instagram Webmania Linkedin Webmania Twitter Webmania
GitHub Webmania Telegram Webmania Youtube Webmania
Webmania

Copyright © 2009-2023 Webmania®.
Webmania® é uma marca registrada e de uso exclusivo da WebmaniaBR Serviços Empresariais LTDA
CNPJ: 11.290.027/0001-82 e WebmaniaBR Desenvolvimento de Software LTDA - CNPJ: 30.902.296/0001-05
sediadas na Av. Anita Garibaldi, 850, Salas 109C e 809A - Curitiba, PR - CEP 80540-400

Grupo WMBR
Voltar para o topo