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

Importação de NF-e

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

ExcluirNFe

altera dadosClaudeMCP

Exclui uma NF-e importada via integração.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 3Campos e estruturas que você pode enviar
CampoTipoDescrição
cChaveNFetexto · até 44Chave da NF-e.
nIdImportacaonúmero inteiroID da Importação da NF-e.
nIdNFenúmero inteiroID do NF-e.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cChaveNFetextoChave da NF-e.
cCodStatustextoCódigo do Status do processamento.
cDesStatustextoDescrição do status de processamento.
nIdImportacaonúmero inteiroID da Importação da NF-e.
nIdNFenúmero inteiroID do NF-e.
POST /api/v1/produtos/nfe/
curl -s https://app.omie.com.br/api/v1/produtos/nfe/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ExcluirNFe", "param": [{"cChaveNFe": "", "nIdImportacao": 0, "nIdNFe": 0}]}'

ImportarCancNFe

altera dadosClaudeMCP

Importa o XML de cancelamento de uma Nota Fiscal Eletrônica.

Obrigatórios 6

CampoTipoDescrição
cAppIdtexto · até 100Identificação do aplicativo que emitiu a NF-e. Exemplo: ID001 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de NF-e, indique: "01" e "02" ou "10" e "20" e assim por diante.
cAppNometexto · até 20Nome do Aplicativo que emitiu a NF-e. Exemplo: GeradorNF-e.
cAppVersaotexto · até 20Versão do Aplicativo que emitiu a NF-e. Exemplo: 1.02.01.
cChaveNfetexto · até 44Chave da NF-e a ser importada. Apenas números com 44 digitos.
cMd5NFeCanctexto · até 32MD5 do arquivo XML importado. Aplique o MD5 sobre o XML antes de realizar o consumo.
cXmlNFeCanctextoXml de Cancelamento do CT-e. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: &amp; para &amp;amp; > para &amp;gt; < para &amp;lt; " para &amp;quot; " para &amp;apos; | para &amp;#124; Após essa conversão aplique o MD5 para enviar no campo "cMd5CteCanc". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: &lt;![CDATA[Conteúdo do campo convertido]]&gt;.
Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
nIdImportacaonúmero inteiroID da Importação da NF-e.
nIdNFenúmero inteiroID do NF-e.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cChaveNFetextoChave da NF-e.
cCodStatustextoCódigo do Status do processamento.
cDesStatustextoDescrição do status de processamento.
nIdImportacaonúmero inteiroID da Importação da NF-e.
nIdNFenúmero inteiroID do NF-e.
POST /api/v1/produtos/nfe/
curl -s https://app.omie.com.br/api/v1/produtos/nfe/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ImportarCancNFe", "param": [{"cAppNome": "GeradorNFe", "cAppVersao": "1.01.02", "cAppId": "NFe01", "cChaveNFe": "", "cXmlNFeCanc": "", "cMd5NFeCanc": ""}]}'

ImportarNFe

altera dadosClaudeMCP

Importa o XML de uma Nota Fiscal Eletrônica.

Obrigatórios 8

CampoTipoDescrição
cAppIdtexto · até 100Identificação do aplicativo que emitiu a NF-e. Exemplo: ID001 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de NF-e, indique: "01" e "02" ou "10" e "20" e assim por diante.
cAppNometexto · até 20Nome do Aplicativo que emitiu a NF-e. Exemplo: GeradorNF-e.
cAppVersaotexto · até 20Versão do Aplicativo que emitiu a NF-e. Exemplo: 1.02.01.
cChaveNFetexto · até 44Chave da NF-e a ser importada. Apenas números com 44 digitos.
cMd5NFetexto · até 32MD5 do arquivo XML importado. Aplique o MD5 sobre o XML antes de realizar o consumo.
cOperacaotexto · até 2Tipo de Operação da Nota Fiscal. Códigos Disponíveis: 11 - Venda de produtos 21 - Compra de produtos.
cXmlNFetextoXml da NF-e a ser importada. Antes de enviar, converta os seus seguintes caracteres: &amp; para &amp;amp; > para &amp;gt; < para &amp;lt; " para &amp;quot; " para &amp;apos; | para &amp;#124; Após essa conversão aplique o MD5 para enviar no campo "cMd5NFe".
dDataPrevisaotexto · até 10Data de Previsão do título de contas a pagar/receber. Formato: dd/mm/aaaa.
Opcionais 16Campos e estruturas que você pode enviar
CampoTipoDescrição
cCategoriatexto · até 20Código da Categoria.
cNumeroPedidoClientetexto · até 30
cOrigemtexto · até 3Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API.
codigo_local_estoquenúmero inteiroCódigo do local do estoque. Assumirá o local padrão de estoque caso não informado.
itenslista de objetosItens da Nota Fiscal.
itens[].cCategoriatexto · até 20Código da Categoria.
itens[].codigo_local_estoquenúmero inteiroCódigo do local do estoque. Assumirá o local padrão de estoque caso não informado.
itens[].lNaoGerarTitulosim/nãoNão gerar título de contas a pagar ou receber para a NF-e. Pode ser: true - inibe a geração do título de Contas a Pagar ou Receber no financeiro. false - Gera o ítulo de Contas a Pagar ou Receber no financeiro. O padrão é true.
itens[].lNaoMovEstoquesim/nãoNão movimenta o estoque para o item. Pode ser: true - inibe a movimentação do estoque. false - Gera o movimentação do estoque. O padrão é false.
itens[].lote_validadelista de objetosInformações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API.
itens[].lote_validade[].cCodAgregtexto · até 20Código de agregação do lote do produto. (Opcional).
itens[].lote_validade[].cNumLotetexto · até 60Número do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado.
itens[].lote_validade[].dDataFabtextoData de fabricação do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. Como default é utilizado a data atual.
itens[].lote_validade[].dDataValtextoData de validade do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada.
itens[].lote_validade[].nIdLotenúmero inteiroId do lote do produto. (Opcional) Se não informado iremos cadastrar um novo lote.
itens[].lote_validade[].nQtdLoteobrigatórionúmeroInforme aqui a quantidade do lote para o produto.
itens[].nIdProdutonúmero inteiroID do produto. Caso não informado, fará a pesquisa do produto de acordo com os dados do XML da NF-e.
itens[].nSequenciaobrigatórionúmero inteiroNúmero da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999.
itensXmllista de objetosDados dos Itens da NF-e. Informe aqui a relação dos produtos contidos no XML com o respectivo produto no Omie ERP. Caso a tag "itens" seja preenchida esta tag não deve ser utilizada.
itensXml[].cProdXmlobrigatóriotexto · até 60Código do produto no XML da NF-e. Essa informação está localizada na tag "cProd" do XML da NF-e, ela é utilizada para identificar o produto no XML.
itensXml[].lote_validadelista de objetosInformações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API.
itensXml[].lote_validade[].cCodAgregtexto · até 20Código de agregação do lote do produto. (Opcional).
itensXml[].lote_validade[].cNumLotetexto · até 60Número do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado.
itensXml[].lote_validade[].dDataFabtextoData de fabricação do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. Como default é utilizado a data atual.
itensXml[].lote_validade[].dDataValtextoData de validade do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada.
itensXml[].lote_validade[].nIdLotenúmero inteiroId do lote do produto. (Opcional) Se não informado iremos cadastrar um novo lote.
itensXml[].lote_validade[].nQtdLoteobrigatórionúmeroInforme aqui a quantidade do lote para o produto.
itensXml[].nIdProdutoXmlobrigatórionúmero inteiroID do produto no Omie que será vinculado ao produto informado na tag "cProdXml".
itensXml[].nSequencianúmero inteiroNúmero da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999.
lNaoGerarTitulosim/nãoNão gerar título de contas a pagar ou receber para a NF-e. Pode ser: true - inibe a geração do título de Contas a Pagar ou Receber no financeiro. false - Gera o ítulo de Contas a Pagar ou Receber no financeiro. O padrão é true.
lNaoIncluirClientesim/nãoNão adicionar o cliente caso não encontre no Omie. Pode ser: true - inibe a inclusão do cliente. false - Inclui o cliente caso não encontre. O padrão é true.
lNaoIncluirProdutosim/nãoNão adicionar o produto caso não encontre no Omie. Pode ser: true - inibe a inclusão do produto. false - Inclui o produto caso não encontre. O padrão é true.
lNaoMovEstoquesim/nãoNão movimentar o estoque. Pode ser: true - inibe a movimentação do estoque. false - Gera o movimentação do estoque. O padrão é true.
lancamentoslista de objetosLançamentos no Conta Corrente relacionados a Nota Fiscal. (Tarifas,taxas,entre outros).
lancamentos[].cCategoriatexto · até 20Código da Categoria.
lancamentos[].cNaturezaDocumentoobrigatóriotexto · até 1Natureza do Documento. Pode ser: P - Pagar R - Receber.
lancamentos[].cObstextoObservações.
lancamentos[].cOrigemtexto · até 3Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API.
lancamentos[].cTipoDocumentotexto · até 5Tipo de Documento. Lista de tipos de documentos em: /api/v1/geral/tiposdoc.
lancamentos[].dDataDocumentoobrigatóriotexto · até 10Data do documento.
lancamentos[].nContaCorrentenúmero inteiroId da Conta Corrente.
lancamentos[].nProjetonúmero inteiroId do projeto.
lancamentos[].nSequencianúmero inteiroNúmero da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999.
lancamentos[].nValorDocumentoobrigatórionúmeroValor do Documento.
lancamentos[].nVendedornúmero inteiroId do Vendedor.
nClientenúmero inteiroId do cliente.
nContaCorrentenúmero inteiroId da Conta Corrente.
nProjetonúmero inteiroId do projeto.
nVendedornúmero inteiroId do Vendedor.
parcelaslista de objetosInformações complementares das Parcelas da NF-e. Nessa tag é recebido informações para complemento das parcelas já existentes no XML da NF-e enviada.
parcelas[].cCategoriatexto · até 20Código da Categoria.
parcelas[].cObstextoObservações.
parcelas[].cTipoDocumentotexto · até 5Tipo de Documento.
parcelas[].dDataEntradatexto · até 10Data de Entrada da Nota Fiscal. Formato: dd/mm/aaaa.
parcelas[].dDataPrevisaotexto · até 10Data de Previsão do título de contas a pagar/receber. Formato: dd/mm/aaaa.
parcelas[].dDataVencimentoobrigatóriotexto · até 10Data de Vencimento da Parcela. Formato: dd/mm/aaaa.
parcelas[].nContaCorrentenúmero inteiroId da Conta Corrente.
parcelas[].nProjetonúmero inteiroId do projeto.
parcelas[].nSequenciaobrigatórionúmero inteiroNúmero da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999.
parcelas[].nValorParcelaobrigatórionúmeroValor da Parcela.
parcelas[].nVendedornúmero inteiroId do Vendedor.
parcelas[].nsutexto · até 100Número Sequencial Único - NSU Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cChaveNFetextoChave da NF-e.
cCodStatustextoCódigo do Status do processamento.
cDesStatustextoDescrição do status de processamento.
nIdImportacaonúmero inteiroID da Importação da NF-e.
nIdNFenúmero inteiroID do NF-e.
POST /api/v1/produtos/nfe/
curl -s https://app.omie.com.br/api/v1/produtos/nfe/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ImportarNFe", "param": [{"cAppNome": "GeradorNFe", "cAppVersao": "1.01.02", "cAppId": "NFe01", "cChaveNFe": "", "cXmlNFe": "", "cMd5NFe": "", "cOperacao": "11", "cOrigem": "API", "nCliente": 0, "cCategoria": "1.01.02", "nContaCorrente": 0, "codigo_local_estoque": 0, "lNaoMovEstoque": true, "lNaoGerarTitulo": false, "lNaoIncluirCliente": false, "lNaoIncluirProduto": true}]}'

ListarNFe

consultaClaudeMCP

Lista as NFes importadas.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 9Campos e estruturas que você pode enviar
CampoTipoDescrição
cChaveNFetexto · até 44Chave da NF-e.
dDataEmissaoFinaltexto · até 10Data de emissão final. No formato dd/mm/aaaa.
dDataEmissaoInicialtexto · até 10Data de emissão inicial. No formato dd/mm/aaaa.
dDataInclusaoFinaltexto · até 10Data de Inclusão Final. No formato dd/mm/aaaa.
dDataInclusaoInicialtexto · até 10Data de Inclusão Inicial. No formato dd/mm/aaaa.
nIdImportacaonúmero inteiroID da Importação da NF-e.
nIdNFenúmero inteiroID do NF-e.
nPaginanúmero inteiroNúmero da página que se deseja resgatar. O padrão é "1".
nRegPorPaginanúmero inteiroNúmero de registros retornados por página. O padrão é 20. O limite máximo é 500 por página.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
listagemNfelista de objetosLista de NFes importadas.
listagemNfe[].cAppIdtextoIdentificação do aplicativo que emitiu a NF-e. Exemplo: ID001 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de NF-e, indique: "01" e "02" ou "10" e "20" e assim por diante.
listagemNfe[].cAppNometextoNome do Aplicativo que emitiu a NF-e. Exemplo: GeradorNF-e.
listagemNfe[].cAppVersaotextoVersão do Aplicativo que emitiu a NF-e. Exemplo: 1.02.01.
listagemNfe[].cChaveNFetextoChave da NF-e a ser importada. Apenas números com 44 digitos.
listagemNfe[].cExcluidotextoIndica se o registro foi excluído (S ou N).
listagemNfe[].cHoraExclusaotextoHora de exclusão.
listagemNfe[].cHoraImportacaotextoHora da importação.
listagemNfe[].cNumeroNFetextoNúmero da NF-e.
listagemNfe[].cOperacaotextoTipo de Operação da Nota Fiscal. Códigos Disponíveis: 11 - Venda de produtos 21 - Compra de produtos.
listagemNfe[].cOrigemtextoOrigem da Nota Fiscal. Códigos Disponíveis: API - Importado via API.
listagemNfe[].cStatustextoStatus da importação. Pode ser: 1 - Em processamento. 4 - Importada com sucesso. 9 - Erro na importação.
listagemNfe[].dDataEmissaotextoData de emissão da NF-e.
listagemNfe[].dDataExclusaotextoData de exclusão.
listagemNfe[].dDataImportacaotextoData da importação.
listagemNfe[].nClientenúmero inteiroId do cliente.
listagemNfe[].nIdExcusaonúmero inteiroID da exclusão.
listagemNfe[].nIdImportacaonúmero inteiroID da Importação da NF-e.
listagemNfe[].nIdNFenúmero inteiroID do NF-e.
listagemNfe[].nValorNFedecimalValor da NF-e.
nPaginanúmero inteiroNúmero da página resgatada.
nRegistrosnúmero inteiroNúmero de registros retornados na página.
nTotPaginasnúmero inteiroNúmero total de páginas encontradas.
nTotRegistrosnúmero inteiroNúmero total de registros encontrados.
POST /api/v1/produtos/nfe/
curl -s https://app.omie.com.br/api/v1/produtos/nfe/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarNFe", "param": [{"nPagina": 1, "nRegPorPagina": 50, "dDataEmissaoInicial": "30/09/2026", "dDataEmissaoFinal": "30/09/2026"}]}'