Produtos ·
NotaFiscalGerenciamento de Notas Fiscais Eletrônicas
1consulta
3alterações
Claude 3 de 4 · MCP 3 de 4pelos assistentes de IA
JSON · XMLformato
Cancela uma Nota Fiscal.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
dtCanc | texto · até 10 | Data do cancelamento, no formato dd/mm/aaaa. Obrigatório. |
xJust | texto | Justificativa do cancelamento. Obrigatório. |
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_nf | número inteiro | Código interno da nota fiscal. Informe este ou codigo_nf_integracao. |
codigo_nf_integracao | texto · até 20 | Código de integração da nota fiscal. Informe este ou codigo_nf. |
Retorno 7O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_nf | número inteiro | Código interno da nota fiscal. |
codigo_nf_integracao | texto | Código de integração da nota fiscal. |
codigo_status | texto | "0" quando a solicitação foi registrada; "999" quando não foi, com o motivo no aviso da chamada. |
descricao_status | texto | Descrição do resultado. |
nf_numero | texto | Número da Nota Fiscal |
nf_serie | texto | Série da NF |
nf_tipo | texto | Tipo da nota: 0 entrada, 1 saída. |
POST /api/v1/produtos/nf/
curl -s https://app.omie.com.br/api/v1/produtos/nf/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "NotaFiscalCancelar", "param": [{"codigo_nf": 3478700021, "dtCanc": "09/10/2026", "xJust": "Pedido cancelado pelo cliente antes da saída da mercadoria"}]}'import os
import requests
corpo = {'call': 'NotaFiscalCancelar',
'param': [{'codigo_nf': 3478700021,
'dtCanc': '09/10/2026',
'xJust': 'Pedido cancelado pelo cliente antes da saída da mercadoria'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/nf/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/nf/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "NotaFiscalCancelar",
"param": [
{
"codigo_nf": 3478700021,
"dtCanc": "09/10/2026",
"xJust": "Pedido cancelado pelo cliente antes da saída da mercadoria"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/nf/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "NotaFiscalCancelar",
"param": [
{
"codigo_nf": 3478700021,
"dtCanc": "09/10/2026",
"xJust": "Pedido cancelado pelo cliente antes da saída da mercadoria"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/nf/")
corpo = <<~'JSON'
{
"call": "NotaFiscalCancelar",
"param": [
{
"codigo_nf": 3478700021,
"dtCanc": "09/10/2026",
"xJust": "Pedido cancelado pelo cliente antes da saída da mercadoria"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "NotaFiscalCancelar",
"param": [
{
"codigo_nf": 3478700021,
"dtCanc": "09/10/2026",
"xJust": "Pedido cancelado pelo cliente antes da saída da mercadoria"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/nf/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/nf/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""NotaFiscalCancelar"", ""param"": [{""codigo_nf"": 3478700021, ""dtCanc"": ""09/10/2026"", ""xJust"": ""Pedido cancelado pelo cliente antes da saída da mercadoria""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosEfetua uma solicitação da Carta de Correção
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
xCorrecao | texto | Texto da correção. Obrigatório. Os acentos são removidos antes do envio. |
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_nf | número inteiro | Código interno da nota fiscal. Informe este ou codigo_nf_integracao. |
codigo_nf_integracao | texto · até 20 | Código de integração da nota fiscal. Informe este ou codigo_nf. |
Retorno 7O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_nf | número inteiro | Código interno da nota fiscal. |
codigo_nf_integracao | texto | Código de integração da nota fiscal. |
codigo_status | texto | "0" quando a solicitação foi registrada; "999" quando não foi, com o motivo no aviso da chamada. |
descricao_status | texto | Retorno do envio da carta de correção. |
nf_numero | texto | Número da Nota Fiscal |
nf_serie | texto | Série da Nota Fiscal |
nf_tipo | texto | Tipo da nota: 0 entrada, 1 saída. |
POST /api/v1/produtos/nf/
curl -s https://app.omie.com.br/api/v1/produtos/nf/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "NotaFiscalCartaCorrecao", "param": [{"codigo_nf": 3478700021, "xCorrecao": "Corrigir o endereco de entrega para Rua das Flores, 120, Centro"}]}'import os
import requests
corpo = {'call': 'NotaFiscalCartaCorrecao',
'param': [{'codigo_nf': 3478700021,
'xCorrecao': 'Corrigir o endereco de entrega para Rua das Flores, 120, '
'Centro'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/nf/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/nf/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "NotaFiscalCartaCorrecao",
"param": [
{
"codigo_nf": 3478700021,
"xCorrecao": "Corrigir o endereco de entrega para Rua das Flores, 120, Centro"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/nf/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "NotaFiscalCartaCorrecao",
"param": [
{
"codigo_nf": 3478700021,
"xCorrecao": "Corrigir o endereco de entrega para Rua das Flores, 120, Centro"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/nf/")
corpo = <<~'JSON'
{
"call": "NotaFiscalCartaCorrecao",
"param": [
{
"codigo_nf": 3478700021,
"xCorrecao": "Corrigir o endereco de entrega para Rua das Flores, 120, Centro"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "NotaFiscalCartaCorrecao",
"param": [
{
"codigo_nf": 3478700021,
"xCorrecao": "Corrigir o endereco de entrega para Rua das Flores, 120, Centro"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/nf/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/nf/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""NotaFiscalCartaCorrecao"", ""param"": [{""codigo_nf"": 3478700021, ""xCorrecao"": ""Corrigir o endereco de entrega para Rua das Flores, 120, Centro""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosNotaFiscalInutilizar
altera dadosInutiliza uma Nota Fiscal.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
dtInut | texto · até 10 | Data da inutilização, no formato dd/mm/aaaa. Obrigatório. |
xJust | texto | Justificativa da inutilização. Obrigatório. |
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_nf | número inteiro | Código interno da nota fiscal. Informe este ou codigo_nf_integracao. |
codigo_nf_integracao | texto · até 20 | Código de integração da nota fiscal. Informe este ou codigo_nf. |
Retorno 7O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_nf | número inteiro | Código interno da nota fiscal. |
codigo_nf_integracao | texto | Código de integração da nota fiscal. |
codigo_status | texto | "0" quando a solicitação foi registrada; "999" quando não foi, com o motivo no aviso da chamada. |
descricao_status | texto | Descrição do resultado. |
nf_numero | texto | Número da Nota Fiscal |
nf_serie | texto | Série da NF |
nf_tipo | texto | Tipo da nota: 0 entrada, 1 saída. |
POST /api/v1/produtos/nf/
curl -s https://app.omie.com.br/api/v1/produtos/nf/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "NotaFiscalInutilizar", "param": [{"codigo_nf": 3478700022, "dtInut": "09/10/2026", "xJust": "Numeração não utilizada por falha na transmissão da nota"}]}'import os
import requests
corpo = {'call': 'NotaFiscalInutilizar',
'param': [{'codigo_nf': 3478700022,
'dtInut': '09/10/2026',
'xJust': 'Numeração não utilizada por falha na transmissão da nota'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/nf/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/nf/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "NotaFiscalInutilizar",
"param": [
{
"codigo_nf": 3478700022,
"dtInut": "09/10/2026",
"xJust": "Numeração não utilizada por falha na transmissão da nota"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/nf/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "NotaFiscalInutilizar",
"param": [
{
"codigo_nf": 3478700022,
"dtInut": "09/10/2026",
"xJust": "Numeração não utilizada por falha na transmissão da nota"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/nf/")
corpo = <<~'JSON'
{
"call": "NotaFiscalInutilizar",
"param": [
{
"codigo_nf": 3478700022,
"dtInut": "09/10/2026",
"xJust": "Numeração não utilizada por falha na transmissão da nota"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "NotaFiscalInutilizar",
"param": [
{
"codigo_nf": 3478700022,
"dtInut": "09/10/2026",
"xJust": "Numeração não utilizada por falha na transmissão da nota"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/nf/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/nf/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""NotaFiscalInutilizar"", ""param"": [{""codigo_nf"": 3478700022, ""dtInut"": ""09/10/2026"", ""xJust"": ""Numeração não utilizada por falha na transmissão da nota""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosRetorna o status da Nota Fiscal
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 4Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_empresa | número inteiro | Ignorado pela consulta (a empresa vem da nota). |
codigo_empresa_integracao | texto · até 20 | Ignorado pela consulta. |
codigo_nf | número inteiro | Código interno da nota fiscal. Informe este ou codigo_nf_integracao. |
codigo_nf_integracao | texto · até 20 | Código de integração da nota fiscal. Informe este ou codigo_nf. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
dados_cancelamento | objeto | Dados do cancelamento, quando houver. |
dados_cancelamento.dtCanc | texto | Data do cancelamento, no formato dd/mm/aaaa. |
dados_cancelamento.dtRet | texto | Data de retorno do cancelamento |
dados_cancelamento.hrRet | texto | Hora de retorno do cancelamento |
dados_cancelamento.nfCanc | texto | S quando a nota foi cancelada. |
dados_cancelamento.xJust | texto | Motivo do cancelamento. |
dados_lote | objeto | Lote de envio da NF-e à SEFAZ. |
dados_lote.ambiente | texto | Ambiente do lote: P produção, H homologação. |
dados_lote.data_envio | texto | Data de envio |
dados_lote.data_retorno | texto | Data de retorno do lote, no formato dd/mm/aaaa. |
dados_lote.hora_envio | texto | Hora de envio do lote, no formato hh:mm:ss. |
dados_lote.hora_retorno | texto | Hora de retorno do lote, no formato hh:mm:ss. |
dados_lote.numero | número inteiro | Número do lote |
dados_lote.recibo | número inteiro | Número do recibo de envio do lote na SEFAZ. |
dados_lote.status | texto | Status do Lote |
dados_lote.status_sefaz | texto | Código de status devolvido pela SEFAZ. |
dados_nota_fiscal | objeto | Dados da NF-e. |
dados_nota_fiscal.chave_nfe | texto | Chave de acesso da NF-e (44 dígitos). |
dados_nota_fiscal.data_emissao | texto | Data de Emissão |
dados_nota_fiscal.digVal | texto | |
dados_nota_fiscal.faturada | texto | S quando a NF-e foi autorizada. |
dados_nota_fiscal.numero | texto | Número da Nota Fiscal |
dados_nota_fiscal.protocolo | número inteiro | Número do protocolo de autorização. |
dados_nota_fiscal.serie | texto | Série da Nota Fiscal |
dados_nota_fiscal.status | texto | |
dados_nota_fiscal.status_sefaz | texto | Código de status devolvido pela SEFAZ. |
dados_nota_fiscal.tipo | texto | Tipo da nota: 0 entrada, 1 saída. |
dados_nota_fiscal.valor_total | decimal | Valor Total |
integracao | objeto | Identificação da nota. |
integracao.codigo_empresa | número inteiro | Código da empresa emitente da nota. |
integracao.codigo_empresa_integracao | texto | Vem como informado no pedido. |
integracao.codigo_nf | número inteiro | Código da Nota Fiscal |
integracao.codigo_nf_integracao | texto | Código de Integração da Nota Fiscal. |
mensagens | lista de objetos | Mensagens de retorno da SEFAZ para o lote (rejeições e avisos). |
mensagens[].codigo | texto | Código da mensagem. |
mensagens[].correcao | texto | Orientação de correção. |
mensagens[].descricao | texto | Descrição da mensagem. |
mensagens[].tipo | texto | Tipo da mensagem. |
POST /api/v1/produtos/nf/
curl -s https://app.omie.com.br/api/v1/produtos/nf/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "NotaFiscalStatus", "param": [{"codigo_nf": 3478700021}]}'import os
import requests
corpo = {'call': 'NotaFiscalStatus', 'param': [{'codigo_nf': 3478700021}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/nf/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/nf/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "NotaFiscalStatus",
"param": [
{
"codigo_nf": 3478700021
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/nf/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "NotaFiscalStatus",
"param": [
{
"codigo_nf": 3478700021
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/nf/")
corpo = <<~'JSON'
{
"call": "NotaFiscalStatus",
"param": [
{
"codigo_nf": 3478700021
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "NotaFiscalStatus",
"param": [
{
"codigo_nf": 3478700021
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/nf/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/nf/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""NotaFiscalStatus"", ""param"": [{""codigo_nf"": 3478700021}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados