OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Produtos · NotaFiscal

Gerenciamento de Notas Fiscais Eletrônicas

POSThttps://app.omie.com.br/api/v1/produtos/nf/WSDL
1consulta
3alterações
Claude 3 de 4 · MCP 3 de 4pelos assistentes de IA
JSON · XMLformato

NotaFiscalCancelar

altera dadosClaudeMCP

Cancela uma Nota Fiscal.

Obrigatórios 2

CampoTipoDescrição
dtCanctexto · até 10Data do cancelamento, no formato dd/mm/aaaa. Obrigatório.
xJusttextoJustificativa do cancelamento. Obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_nfnúmero inteiroCódigo interno da nota fiscal. Informe este ou codigo_nf_integracao.
codigo_nf_integracaotexto · até 20Código de integração da nota fiscal. Informe este ou codigo_nf.
Retorno 7O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_nfnúmero inteiroCódigo interno da nota fiscal.
codigo_nf_integracaotextoCódigo de integração da nota fiscal.
codigo_statustexto"0" quando a solicitação foi registrada; "999" quando não foi, com o motivo no aviso da chamada.
descricao_statustextoDescrição do resultado.
nf_numerotextoNúmero da Nota Fiscal
nf_serietextoSérie da NF
nf_tipotextoTipo 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"}]}'

NotaFiscalCartaCorrecao

altera dadosClaudeMCP

Efetua uma solicitação da Carta de Correção

Obrigatórios 1

CampoTipoDescrição
xCorrecaotextoTexto da correção. Obrigatório. Os acentos são removidos antes do envio.
Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_nfnúmero inteiroCódigo interno da nota fiscal. Informe este ou codigo_nf_integracao.
codigo_nf_integracaotexto · até 20Código de integração da nota fiscal. Informe este ou codigo_nf.
Retorno 7O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_nfnúmero inteiroCódigo interno da nota fiscal.
codigo_nf_integracaotextoCódigo de integração da nota fiscal.
codigo_statustexto"0" quando a solicitação foi registrada; "999" quando não foi, com o motivo no aviso da chamada.
descricao_statustextoRetorno do envio da carta de correção.
nf_numerotextoNúmero da Nota Fiscal
nf_serietextoSérie da Nota Fiscal
nf_tipotextoTipo 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"}]}'

Inutiliza uma Nota Fiscal.

Obrigatórios 2

CampoTipoDescrição
dtInuttexto · até 10Data da inutilização, no formato dd/mm/aaaa. Obrigatório.
xJusttextoJustificativa da inutilização. Obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_nfnúmero inteiroCódigo interno da nota fiscal. Informe este ou codigo_nf_integracao.
codigo_nf_integracaotexto · até 20Código de integração da nota fiscal. Informe este ou codigo_nf.
Retorno 7O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_nfnúmero inteiroCódigo interno da nota fiscal.
codigo_nf_integracaotextoCódigo de integração da nota fiscal.
codigo_statustexto"0" quando a solicitação foi registrada; "999" quando não foi, com o motivo no aviso da chamada.
descricao_statustextoDescrição do resultado.
nf_numerotextoNúmero da Nota Fiscal
nf_serietextoSérie da NF
nf_tipotextoTipo 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"}]}'

NotaFiscalStatus

consultaClaudeMCP

Retorna o status da Nota Fiscal

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_empresanúmero inteiroIgnorado pela consulta (a empresa vem da nota).
codigo_empresa_integracaotexto · até 20Ignorado pela consulta.
codigo_nfnúmero inteiroCódigo interno da nota fiscal. Informe este ou codigo_nf_integracao.
codigo_nf_integracaotexto · até 20Código de integração da nota fiscal. Informe este ou codigo_nf.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
dados_cancelamentoobjetoDados do cancelamento, quando houver.
dados_cancelamento.dtCanctextoData do cancelamento, no formato dd/mm/aaaa.
dados_cancelamento.dtRettextoData de retorno do cancelamento
dados_cancelamento.hrRettextoHora de retorno do cancelamento
dados_cancelamento.nfCanctextoS quando a nota foi cancelada.
dados_cancelamento.xJusttextoMotivo do cancelamento.
dados_loteobjetoLote de envio da NF-e à SEFAZ.
dados_lote.ambientetextoAmbiente do lote: P produção, H homologação.
dados_lote.data_enviotextoData de envio
dados_lote.data_retornotextoData de retorno do lote, no formato dd/mm/aaaa.
dados_lote.hora_enviotextoHora de envio do lote, no formato hh:mm:ss.
dados_lote.hora_retornotextoHora de retorno do lote, no formato hh:mm:ss.
dados_lote.numeronúmero inteiroNúmero do lote
dados_lote.recibonúmero inteiroNúmero do recibo de envio do lote na SEFAZ.
dados_lote.statustextoStatus do Lote
dados_lote.status_sefaztextoCódigo de status devolvido pela SEFAZ.
dados_nota_fiscalobjetoDados da NF-e.
dados_nota_fiscal.chave_nfetextoChave de acesso da NF-e (44 dígitos).
dados_nota_fiscal.data_emissaotextoData de Emissão
dados_nota_fiscal.digValtexto
dados_nota_fiscal.faturadatextoS quando a NF-e foi autorizada.
dados_nota_fiscal.numerotextoNúmero da Nota Fiscal
dados_nota_fiscal.protocolonúmero inteiroNúmero do protocolo de autorização.
dados_nota_fiscal.serietextoSérie da Nota Fiscal
dados_nota_fiscal.statustexto
dados_nota_fiscal.status_sefaztextoCódigo de status devolvido pela SEFAZ.
dados_nota_fiscal.tipotextoTipo da nota: 0 entrada, 1 saída.
dados_nota_fiscal.valor_totaldecimalValor Total
integracaoobjetoIdentificação da nota.
integracao.codigo_empresanúmero inteiroCódigo da empresa emitente da nota.
integracao.codigo_empresa_integracaotextoVem como informado no pedido.
integracao.codigo_nfnúmero inteiroCódigo da Nota Fiscal
integracao.codigo_nf_integracaotextoCódigo de Integração da Nota Fiscal.
mensagenslista de objetosMensagens de retorno da SEFAZ para o lote (rejeições e avisos).
mensagens[].codigotextoCódigo da mensagem.
mensagens[].correcaotextoOrientação de correção.
mensagens[].descricaotextoDescrição da mensagem.
mensagens[].tipotextoTipo 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}]}'