REST API de Nota Fiscal Eletrônica

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.

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.

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"] = "[...]"
["log_cancelamento"] = "[...]"

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.

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

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

{
  "operacao": 1,
  "natureza_operacao": "Venda de produção do estabelecimento",
  "modelo": 1,
  "finalidade": 1,
  "ambiente": 1,
  "nfe_referenciada": [
    "00000000000000000000000000000000000000000000",
    "00000000000000000000000000000000000000000000"
  ],
  "cliente": { ... },
  "produtos": [ ... ],
  "pedido": { ... }
}

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

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

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

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.

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.

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.

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

{
  "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
Criar/Editar Impostos de Produto

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.

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": [
    {
      "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": [
    {
      ...
      "aliquota_mva" : [
        {
          "estado" : "PR",
          "aliquota" : "32.00"
        },
        {
          "estado" : "SC",
          "aliquota" : "32.00"
        },
        {
          "estado" : "RS",
          "aliquota" : "32.00"
        }
      ]
    }
  ]
}

{
  "icms": [
    {
      ...
      "aliquota_icms" : [
        {
          "estado" : "PR",
          "aliquota" : "32.00"
        },
        {
          "estado" : "SC",
          "aliquota" : "32.00"
        },
        {
          "estado" : "RS",
          "aliquota" : "32.00"
        }
      ]
    }
  ]
}

{
  "icms": [
    {
      ...
      "aliquota_icms_st" : [
        {
          "estado" : "PR",
          "aliquota" : "32.00"
        },
        {
          "estado" : "SC",
          "aliquota" : "32.00"
        },
        {
          "estado" : "RS",
          "aliquota" : "32.00"
        }
      ]
    }
  ]
}

{
  "icms": [
    {
      ...
      "aliquota_fcp" : [
        {
          "estado" : "PR",
          "aliquota" : "32.00"
        },
        {
          "estado" : "SC",
          "aliquota" : "32.00"
        },
        {
          "estado" : "RS",
          "aliquota" : "32.00"
        }
      ]
    }
  ]
}

{
  "icms": [
    {
      ...
      "aliquota_fcp_st" : [
        {
          "estado" : "PR",
          "aliquota" : "32.00"
        },
        {
          "estado" : "SC",
          "aliquota" : "32.00"
        },
        {
          "estado" : "RS",
          "aliquota" : "32.00"
        }
      ]
    }
  ]
}

{
  "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": [
    {
      "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"
    }
  ]
}

{
  "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
Criar/Editar Impostos de Serviço

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.

Segue exemplo de classe de imposto, para o provedor Abrasf:

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 prestação de serviço",
  "tipo": "nfse",
  "codigo_servico": "01.01",
  "natureza_operacao": 1,
  "exigibilidade_iss": 1,
  "iss_retido": 2, // Não
  "iss": 2 // Alíquota do ISS
}' \
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 prestação de serviço", // Descrição
  "data": "0000-00-00 00:00:00" // Data de criação
}

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-09-01 14:45:00",
    "icms": [],
    "ipi": [],
    "pis": [],
    "cofins": []
  },
  {
    "referencia": "REF43673367",
    "descricao": "Entrada de produtos",
    "data": "2023-09-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.

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:

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.

"impostos": {
   "icms": {
     "codigo_cfop": "5.102",
     "situacao_tributaria": "101",
     "aliquota_credito": "10.00"
   }
 }

"impostos": {
   "icms": {
     "codigo_cfop": "5.402",
     "situacao_tributaria": "201",
     "aliquota_credito": "10.00",
     "aliquota_mva": "20.00"
   }
 }

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

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

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

"impostos": {
   "icms": {
     "codigo_cfop": "5.102",
     "situacao_tributaria": "20",
     "aliquota_reducao": "20.00"
   }
 }

"impostos": {
   "icms": {
     "codigo_cfop": "5.102",
     "situacao_tributaria": "40",
     "motivo_desoneracao": "9"
   }
 }

"impostos": {
   "icms": {
     "codigo_cfop": "5.102",
     "situacao_tributaria": "51",
     "aliquota_diferimento": "20.00"
   }
 }