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

Cadastro de Cupons Fiscais

POSThttps://app.omie.com.br/api/v1/produtos/cupomfiscal/WSDL
2consultas
7alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato

CancelarCupom

altera dadosClaudeMCP

Cancela um cupom fiscal.

Obrigatórios 1

CampoTipoDescrição
nIdCupomnúmero inteiroID do Cupom Fiscal.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status do processamento.
cDesStatustextoDescrição do status de processamento.
nIdCupomnúmero inteiroID do Cupom Fiscal.
POST /api/v1/produtos/cupomfiscal/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscal/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CancelarCupom", "param": [{"nIdCupom": 0}]}'

CancelarNFCE

altera dadosClaudeMCP

Cancelar NFC-e.

Obrigatórios 3

CampoTipoDescrição
cDataEmissaotexto · até 10Data de Emissão do Cupom Fiscal. No formato "dd/mm/aaaa".
nCodigoPDVtexto · até 20Código do PDV.
nNumeroCaixanúmero inteiroNúmero do Caixa.
Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
DadosCancNFCEobjetoDados do Cancelamento da NFC-e.
DadosCancNFCE.cDataCancelamentoobrigatóriotexto · até 10Data de Cancelamento. No formato "dd/mm/aaaa".
DadosCancNFCE.cHoraCancelamentoobrigatóriotexto · até 10Hora de Cancelamento. No formato "hh:mm:ss".
DadosCancNFCE.cXmlCancNFCEobrigatóriotextoXML de Cancelamento da NFC-e.
DadosCancNFCE.nChaveCancNFCEobrigatóriotexto · até 44Chave de Cancelamento da NFC-e.
DadosCancNFCE.nProtCancNFCEobrigatóriotexto · até 30Número do Protocolo de Cancelamento da NFC-e.
IdenticacaoNFCEobjetoIndicação da NFC-e.
IdenticacaoNFCE.nChaveNFCEobrigatóriotexto · até 44Chave da NFC-e.
IdenticacaoNFCE.nNumeroNFCEobrigatóriotexto · até 20Número do NFC-e.
IdenticacaoNFCE.nSerieNFCEobrigatóriotexto · até 4Número de Série da NFC-e.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status do processamento.
cDesStatustextoDescrição do status de processamento.
nIdCupomnúmero inteiroID do Cupom Fiscal.
POST /api/v1/produtos/cupomfiscal/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscal/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CancelarNFCE", "param": [{"nCodigoPDV": 0, "nNumeroCaixa": 0, "cDataEmissao": "", "IdenticacaoNFCE": {"nNumeroNFCE": 0, "nSerieNFCE": 0, "nChaveNFCE": ""}, "DadosCancNFCE": {"nProtCancNFCE": 0, "nChaveCancNFCE": "", "cXmlCancNFCE": "", "cDataCancelamento": "", "cHoraCancelamento": ""}}]}'

CancelarSAT

altera dadosClaudeMCP

Cancelar CF-e-SAT.

Obrigatórios 3

CampoTipoDescrição
cDataEmissaotexto · até 10Data de Emissão do Cupom Fiscal. No formato "dd/mm/aaaa".
nCodigoPDVtexto · até 20Código do PDV.
nNumeroCaixanúmero inteiroNúmero do Caixa.
Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
DadosCancSATobjetoDados do Cancelamento do CF-e-SAT.
DadosCancSAT.cDataCancelamentoobrigatóriotexto · até 10Data de Cancelamento. No formato "dd/mm/aaaa".
DadosCancSAT.cHoraCancelamentoobrigatóriotexto · até 10Hora de Cancelamento. No formato "hh:mm:ss".
DadosCancSAT.cXmlCancSATobrigatóriotextoXML de Cancelamento do CF-e-SAT.
DadosCancSAT.nChaveCancSATobrigatóriotexto · até 44Número do Protocolo de Cancelamento do CF-e-SAT.
DadosCancSAT.nProtCancSATobrigatórionúmero inteiroNúmero do Protocolo de Cancelamento do CF-e-SAT.
IdenticacaoSATobjetoIndicação do CF-e-SAT.
IdenticacaoSAT.cNumeroSerieSATobrigatóriotexto · até 20Número de Série do Equipamento SAT.
IdenticacaoSAT.nChaveSATobrigatóriotexto · até 44Chave da CF-e-SAT.
IdenticacaoSAT.nNumeroSATobrigatórionúmero inteiroNúmero do CF-e-SAT.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status do processamento.
cDesStatustextoDescrição do status de processamento.
nIdCupomnúmero inteiroID do Cupom Fiscal.
POST /api/v1/produtos/cupomfiscal/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscal/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CancelarSAT", "param": [{"nCodigoPDV": 0, "nNumeroCaixa": 0, "cDataEmissao": "", "IdenticacaoSAT": {"nNumeroSAT": 0, "nChaveSAT": "", "cNumeroSerieSAT": ""}, "DadosCancSAT": {"nProtCancSAT": 0, "nChaveCancSAT": "", "cXmlCancSAT": "", "cDataCancelamento": "", "cHoraCancelamento": ""}}]}'

DevolverCupom

altera dadosClaudeMCP

Realiza a inclusão da devolução do cupom fiscal.

Obrigatórios 2

CampoTipoDescrição
nIdCupomnúmero inteiroID do Cupom Fiscal.
nIdMotivDevolnúmero inteiroID do motivo da devolução. Lista de motivo de devolução em: /api/v1/geral/motivodevolucao/
Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
itenslista de objetosInformações dos produtos que serão devolvidos. Caso essa tag não seja preenchida será realizado a devolução integral de todos os produtos do cupom fiscal.
itens[].nIdItemobrigatórionúmero inteiroID do item do cupom fiscal. Essa informação não é exibida nas telas do Omie. Lista com os itens do cupom em: /api/v1/produtos/cupomfiscalconsultar/#CuponsFiscais
itens[].nQuanttexto · até 1Quantidade do produto a ser devolvida. Caso não seja preenchida será feita a devolução integral do produto.
nIdClientenúmero inteiroCódigo do cliente. Caso o cliente não seja informado, será assumido o cliente apontado no Cupom Fiscal Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API /api/v1/geral/clientes/ para obter essa informação.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status do processamento.
cDesStatustextoDescrição do status de processamento.
nIdDevolucaonúmero inteiroID da devolução.
POST /api/v1/produtos/cupomfiscal/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscal/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "DevolverCupom", "param": [{"nIdCupom": 0, "nIdMotivDevol": 0, "itens": [{"nIdItem": 0, "nQuant": 0}]}]}'

ExcluirCupom

altera dadosClaudeMCP

Exclui um Cupom Fiscal.

Obrigatórios 1

CampoTipoDescrição
nIdCupomnúmero inteiroID do Cupom Fiscal.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status do processamento.
cDesStatustextoDescrição do status de processamento.
nIdCupomnúmero inteiroID do Cupom Fiscal.
POST /api/v1/produtos/cupomfiscal/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscal/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ExcluirCupom", "param": [{"nIdCupom": 0}]}'

ExcluirCuponsPorNumero

altera dadosClaudeMCP

Excluir cupons por número.

Obrigatórios 4

CampoTipoDescrição
cDataEmissaotexto · até 10Data de Emissão do Cupom Fiscal. No formato "dd/mm/aaaa".
nCodigoPDVtexto · até 20Código do PDV.
nNumCupomnúmero inteiroNúmero do Cupom Fiscal.
nNumeroCaixanúmero inteiroNúmero do Caixa.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status do processamento.
cDesStatustextoDescrição do status de processamento.
nIdCupomnúmero inteiroID do Cupom Fiscal.
POST /api/v1/produtos/cupomfiscal/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscal/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ExcluirCuponsPorNumero", "param": [{"nCodigoPDV": 0, "nNumeroCaixa": 0, "cDataEmissao": "", "nNumCupom": 0}]}'

ExcluirLote

altera dadosClaudeMCP

Excluir o lote.

Obrigatórios 1

CampoTipoDescrição
nNumLotenúmero inteiroNúmero do Lote do Cupom Fiscal.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status do processamento.
cDesStatustextoDescrição do status de processamento.
nNumLotenúmero inteiroNúmero do Lote do Cupom Fiscal.
POST /api/v1/produtos/cupomfiscal/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscal/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ExcluirLote", "param": [{"nNumLote": 0}]}'

ListarCupons

consultaClaudeMCP

Lista os Cupons Fiscais.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 23Campos e estruturas que você pode enviar
CampoTipoDescrição
cAcaotexto · até 3Ação realizada. Pode ser: ADD - Adiciona um cupom. TMP - Adiciona um cupom de um caixa em aberto. CAN - Cupom Cancelado. CTG - Cupom em Contingência. INU - Cupom Inutilizado.
cCaixaFechadotexto · até 1Caixa está fechado (S/N)?
cCanceladotexto · até 1Cupom Fiscal Cancelado (S/N)?
cErrotexto · até 1Cupom Fiscal com erro no processamento (S/N)?
cModelotexto · até 2Modelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e
cNumeroSerieECFtexto · até 20Número de Série da Impressora Fiscal.
cOrdemDecrescentetexto · até 1Indica se a ordem de exibição é Decrescente caso seja informado "S".
cOrdenarPortexto · até 100Ordem os resultados da página por: NUMCUPOM - Número do Cupom Fiscal. NUMVENDA - Número da Venda. DATAEMISSAO - Data de Emissão.
cProcessadotexto · até 1Cupom Fiscal foi processado (S/N)?
dDtEmisFinaltexto · até 10Data de emissão final. No formato dd/mm/aaaa.
dDtEmisInicialtexto · até 10Data de emissão inicial. No formato dd/mm/aaaa.
nCCFnúmero inteiroNúmero do CCF.
nCOOnúmero inteiroNúmero do COO.
nChaveNFCEtexto · até 44Chave da NFC-e.
nChaveSATtexto · até 44Chave da CF-e-SAT.
nCodigoPDVtexto · até 20Código do PDV.
nNumLotenúmero inteiroNúmero do Lote do Cupom Fiscal.
nNumMovimentonúmero inteiroNúmero do movimento (caixa).
nNumeroNFCEtexto · até 20Número do NFC-e.
nNumeroSATnúmero inteiroNúmero do CF-e-SAT.
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 é 50 por página.
nSerieNFCEtexto · até 4Número de Série da NFC-e.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
listaCuponslista de objetosLista de Cupons Fiscais.
listaCupons[].cAcaotextoAção realizada. Pode ser: ADD - Adiciona um cupom. TMP - Adiciona um cupom de um caixa em aberto. CAN - Cupom Cancelado. CTG - Cupom em Contingência. INU - Cupom Inutilizado. EXC - Cupom Excluído.
listaCupons[].cCaixaFechadotextoCaixa está fechado (S/N)?
listaCupons[].cCanceladotextoCupom Fiscal Cancelado (S/N)?
listaCupons[].cChavetextoChave do Cupom Fiscal.
listaCupons[].cErrotextoCupom Fiscal com erro no processamento (S/N)?
listaCupons[].cHrEmisaotextoHora de emissão de Cupom Fiscal.
listaCupons[].cModelotextoModelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e
listaCupons[].cProcessadotextoCupom Fiscal foi processado (S/N)? Também como retornar como 'E' indicando que o cupom foi excluído.
listaCupons[].dDtEmissaotextoData de emissão do Cupom Fiscal.
listaCupons[].nIdCupomnúmero inteiroID do Cupom Fiscal.
listaCupons[].nNumCupomnúmero inteiroNúmero do Cupom Fiscal.
listaCupons[].nNumLotenúmero inteiroNúmero do Lote do Cupom Fiscal.
listaCupons[].nNumMovimentonúmero inteiroNúmero do Movimento (Caixa).
listaCupons[].nNumVendanúmero inteiroNumero da venda.
listaCupons[].nValorNFdecimalValor do Cupom Fiscal.
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/cupomfiscal/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscal/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarCupons", "param": [{"nPagina": 1, "nRegPorPagina": 50, "dDtEmisInicial": "", "dDtEmisFinal": ""}]}'

ObterProximoLote

consultaClaudeMCP

Retorna o próximo número de lote disponível.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 1Campos e estruturas que você pode enviar
CampoTipoDescrição
nCodigoPDVtexto · até 20Código do PDV.
Retorno 1O que volta numa chamada bem-sucedida
CampoTipoDescrição
nNumLotenúmero inteiroNúmero do Lote do Cupom Fiscal.
POST /api/v1/produtos/cupomfiscal/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscal/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterProximoLote", "param": [{"nCodigoPDV": ""}]}'