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

Consultas de cupom fiscal

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

CuponsFiscais

consultaClaudeMCP

Listagem dos cupons fiscais.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 8Campos e estruturas que você pode enviar
CampoTipoDescrição
dDtAlteracaoAtetexto · até 10Data da Alteração do Cupom Fiscal - Até. No formato dd/mm/aaaa.
dDtAlteracaoDetexto · até 10Data da Alteração do Cupom Fiscal - De. No formato dd/mm/aaaa.
dDtEmissaoAtetexto · até 10Data de emissão do Cupom Fiscal - Até. No formato dd/mm/aaaa.
dDtEmissaoDetexto · até 10Data de emissão do Cupom Fiscal - De. No formato dd/mm/aaaa.
dDtInclusaoAtetexto · até 10Data de Inclusão do Cupom Fiscal - Até. No formato dd/mm/aaaa.
dDtInclusaoDetexto · até 10Data de Inclusão do Cupom Fiscal - De. No formato dd/mm/aaaa.
nPaginanúmero inteiroNúmero da página a ser recuperada.
nRegPorPaginanúmero inteiroNúmero de registros por página. (máximo 500).
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
cuponslista de objetosLista de Cupons Fiscais.
cupons[].cabecalhoCupomobjetoInformações do cabeçalho do Cupom Fiscal.
cupons[].cabecalhoCupom.cChaveCupomtextoChave do Cupom Fiscal.
cupons[].cabecalhoCupom.cContingenciatextoIndica se o Cupom Fiscal foi Emitido em ambiente de Contingencia. (S/N).
cupons[].cabecalhoCupom.cHrEmisaoCupomtextoHora de emissão de Cupom Fiscal.
cupons[].cabecalhoCupom.cModeloCupomtextoModelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e
cupons[].cabecalhoCupom.dDtEmissaoCupomtextoData de emissão do Cupom Fiscal.
cupons[].cabecalhoCupom.idClientenúmero inteiroCódigo do cliente.
cupons[].cabecalhoCupom.idVendedornúmero inteiroCódigo do Vendedor.
cupons[].cabecalhoCupom.infoobjetoInformações adicionais do Cupom Fiscal.
cupons[].cabecalhoCupom.info.cCupomCanceladotextoCupom Fiscal Cancelado (S/N)?
cupons[].cabecalhoCupom.info.cCupomDevolvidotextoCupom Fiscal Devolvido (S/N)?
cupons[].cabecalhoCupom.info.cHrAlteracaotextoHora da Alteração do Cupom Fiscal. No formato hh:mm:ss.
cupons[].cabecalhoCupom.info.cHrInclusaotextoHora da Inclusão do Cupom Fiscal. No formato hh:mm:ss.
cupons[].cabecalhoCupom.info.dDtAlteracaotextoData de Alteração do Documento.
cupons[].cabecalhoCupom.info.dDtInclusaotextoData de Inclusão do Documento.
cupons[].cabecalhoCupom.info.uAlttextoUsuário da Alteração do Cupom Fiscal.
cupons[].cabecalhoCupom.info.uInctextoUsuário da Inclusão do Cupom Fiscal.
cupons[].cabecalhoCupom.nIdCupomnúmero inteiroID do Cupom Fiscal.
cupons[].cabecalhoCupom.nNumCupomnúmero inteiroNúmero do Cupom Fiscal.
cupons[].cabecalhoCupom.nSerieCupomtextoSérie do Cupom Fiscal.
cupons[].cabecalhoCupom.nValorCOFINSdecimalValor do COFINS.
cupons[].cabecalhoCupom.nValorCupomdecimalValor do Cupom Fiscal.
cupons[].cabecalhoCupom.nValorICMSdecimalValor do ICMS.
cupons[].cabecalhoCupom.nValorPISdecimalValor do PIS.
cupons[].cabecalhoCupom.nValorTaxadecimalValor da Taxa.
cupons[].cabecalhoCupom.seqCaixanúmero inteiroNúmero sequencial do Caixa.
cupons[].cabecalhoCupom.seqCupomnúmero inteiroNumero sequencial do cupom.
cupons[].itensCupomlista de objetosInformações dos Itens do Cupom Fiscal.
cupons[].itensCupom[].cCFOPtextoCFOP do Item.
cupons[].itensCupom[].cCodigotextoCódigo do Produto no Cupom Fiscal.
cupons[].itensCupom[].cItemCanceladotextoItem do Cupom Fiscal Cancelado (S/N)?
cupons[].itensCupom[].cItemDevolvidotextoItem do Cupom Fiscal Devolvido (S/N)?
cupons[].itensCupom[].cNCMtextoNCM do Item.
cupons[].itensCupom[].cUntextoUnidade do item do cupom fiscal.
cupons[].itensCupom[].emiProdutotextoCódigo do PDV do item do cupom fiscal.
cupons[].itensCupom[].idItemnúmero inteiroID do item do cupom fiscal.
cupons[].itensCupom[].idProdutonúmero inteiroID do produto do item do cupom fiscal.
cupons[].itensCupom[].nAliqCOFINSdecimalAlíquota do COFINS.
cupons[].itensCupom[].nAliqICMSdecimalAlíquota do ICMS.
cupons[].itensCupom[].nAliqPISdecimalAlíquota do PIS.
cupons[].itensCupom[].nQuantdecimalQuantidade do item do cupom fiscal.
cupons[].itensCupom[].nSequencianúmero inteiroSequência do item no Cupom Fiscal.
cupons[].itensCupom[].nValorCOFINSdecimalValor do COFINS.
cupons[].itensCupom[].nValorICMSdecimalValor do ICMS.
cupons[].itensCupom[].nValorOutrosdecimalOutros valores.
cupons[].itensCupom[].nValorPISdecimalValor do PIS.
cupons[].itensCupom[].vAcrescdecimalValor acréscimo do item do cupom fiscal.
cupons[].itensCupom[].vDescdecimalValor desconto do item do cupom fiscal.
cupons[].itensCupom[].vItemdecimalValor líquido do item do cupom fiscal.
cupons[].itensCupom[].vUnitdecimalValor unitário do item do cupom fiscal.
cupons[].itensCupom[].xProdtextoDescrição do item do cupom fiscal.
cupons[].pagamentosCupomlista de objetosInformações dos Pagamentos do Cupom Fiscal.
cupons[].pagamentosCupom[].cCategoriatextoCódigo da Categoria.
cupons[].pagamentosCupom[].cNumParcelatextoNúmero da parcela.
cupons[].pagamentosCupom[].cTipoDoctextoTipo de Documento. Pode ser: 99999 - Outros BOL - Boleto CHQ - Cheque CHT - Cheque de Terceiros CRC - Cartão de Crédito CRD - Cartão de Débito CRE - Creadiário CRT - Cartão DIN - Dinheiro PIX - Pix
cupons[].pagamentosCupom[].dDtVencimentotextoData de Vencimento do Documento.
cupons[].pagamentosCupom[].idContaCorrentenúmero inteiroCódigo da Conta Corrente.
cupons[].pagamentosCupom[].nCodTitulonúmero inteiroCódigo do título.
cupons[].pagamentosCupom[].nSequencianúmero inteiroSequência do item no Cupom Fiscal.
cupons[].pagamentosCupom[].nValorDocumentodecimalValor do Documento.
cupons[].pagamentosCupom[].nValorTaxadecimalValor da Taxa.
nPaginanúmero inteiro
nRegistrosnúmero inteiro
nTotPaginasnúmero inteiro
nTotRegistrosnúmero inteiro
POST /api/v1/produtos/cupomfiscalconsultar/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CuponsFiscais", "param": [{"nPagina": 1, "nRegPorPagina": 50}]}'

CuponsItens

consultaClaudeMCP

Listagem dos itens dos cupons fiscais.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 9Campos e estruturas que você pode enviar
CampoTipoDescrição
dDtAltAtetexto · até 10Data de alteração.
dDtAltDetexto · até 10Data de alteração.
dDtEmisAtetexto · até 10Filtrar os títulos pela data de emissão - até.
dDtEmisDetexto · até 10Filtrar os títulos pela data de emissão - a partir de.
dDtIncAtetexto · até 10Data de inclusão.
dDtIncDetexto · até 10Data de inclusão.
nIdCupomnúmero inteiroID do Cupom Fiscal.
nPaginanúmero inteiroNúmero da página a ser recuperada.
nRegPorPaginanúmero inteiroNúmero de registros por página. (máximo 50).
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
itenslista de objetos
itens[].cChaveCupomtextoChave do Cupom Fiscal.
itens[].cCpfCnpjClientetextoCPF/CNPJ do Cliente.
itens[].cCupomCanceladotextoCupom Fiscal Cancelado (S/N)?
itens[].cCupomDevolvidotextoCupom Fiscal Devolvido (S/N)?
itens[].cHrEmisaoCupomtextoHora de emissão de Cupom Fiscal.
itens[].cItemCanceladotextoItem do Cupom Fiscal Cancelado (S/N)?
itens[].cItemDevolvidotextoItem do Cupom Fiscal Devolvido (S/N)?
itens[].cModeloCupomtextoModelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e.
itens[].cNaoMovEstoquetextoIndica se o item do cupom fiscal não movimenta estoque.
itens[].cRazaoSocialClientetextoRazão Social do Cliente.
itens[].cUntextoUnidade do item do cupom fiscal.
itens[].dDtAlteracaotextoData de Alteração do Documento.
itens[].dDtEmissaoCupomtextoData de emissão do Cupom Fiscal.
itens[].dDtInclusaotextoData de Inclusão do Documento.
itens[].emiProdutotextoCódigo do PDV do item do cupom fiscal.
itens[].idAjusteCancnúmero inteiroId da movimentação de cancelamento de ajuste do estoque do item do cupom fiscal.
itens[].idAjusteEstoquenúmero inteiroId da movimentação de ajuste do estoque do item do cupom fiscal.
itens[].idClientenúmero inteiroCódigo do cliente.
itens[].idItemnúmero inteiroID do item do cupom fiscal.
itens[].idLocalEstoquenúmero inteiroId do local de estoque do item do cupom fiscal.
itens[].idMovCancnúmero inteiroID do Movimento de Estoque do cancelamento do item do cupom fiscal.
itens[].idMovEstoquenúmero inteiroId da movimentação de estoque do item do cupom.
itens[].idProdutonúmero inteiroID do produto do item do cupom fiscal.
itens[].nIdCupomnúmero inteiroID do Cupom Fiscal.
itens[].nNumCupomnúmero inteiroNúmero do Cupom Fiscal.
itens[].nQuantdecimalQuantidade do item do cupom fiscal.
itens[].nQuantDevdecimalQuantidade devolvida do item do cupom fiscal.
itens[].nSerieCupomtextoSérie do Cupom Fiscal.
itens[].nValorCupomdecimalValor do Cupom Fiscal.
itens[].seqCaixanúmero inteiroNúmero sequencial do Caixa.
itens[].seqCupomnúmero inteiroNumero sequencial do cupom.
itens[].seqItemnúmero inteiroSequência do Item do Cupom Fiscal.
itens[].vAcrescdecimalValor acréscimo do item do cupom fiscal.
itens[].vDescdecimalValor desconto do item do cupom fiscal.
itens[].vItemdecimalValor líquido do item do cupom fiscal.
itens[].vUnitdecimalValor unitário do item do cupom fiscal.
itens[].xProdtextoDescrição do item do cupom fiscal.
nPaginanúmero inteiro
nRegistrosnúmero inteiro
nTotPaginasnúmero inteiro
nTotRegistrosnúmero inteiro
POST /api/v1/produtos/cupomfiscalconsultar/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CuponsItens", "param": [{"nPagina": 1, "nRegPorPagina": 50}]}'

CuponsPagamentos

consultaClaudeMCP

Listagem dos pagamentos dos cupons fiscais.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 14Campos e estruturas que você pode enviar
CampoTipoDescrição
dDtAltAtetexto · até 10Data de alteração.
dDtAltDetexto · até 10Data de alteração.
dDtEmisAtetexto · até 10Filtrar os títulos pela data de emissão - até.
dDtEmisDetexto · até 10Filtrar os títulos pela data de emissão - a partir de.
dDtIncAtetexto · até 10Data de inclusão.
dDtIncDetexto · até 10Data de inclusão.
dDtPagtoAtetexto · até 10Filtrar os títulos pela data de pagamento - até.
dDtPagtoDetexto · até 10Filtrar os títulos pela data de pagamento - a partir de.
dDtPrevAtetexto · até 10Data de previsão.
dDtPrevDetexto · até 10Data de previsão.
dDtVencAtetexto · até 10Filtrar os títulos pela data de vencimento - até.
dDtVencDetexto · até 10Filtrar os títulos pela data de vencimento - a partir de.
nPaginanúmero inteiroNúmero da página a ser recuperada.
nRegPorPaginanúmero inteiroNúmero de registros por página. (máximo 50).
Retorno 6O que volta numa chamada bem-sucedida
CampoTipoDescrição
empresaobjetoInformações do estabelecimento.
empresa.cCNPJtextoCNPJ do estabelecimento.
empresa.cIEtextoInscrição Estadual do estabelecimento.
empresa.cNomeFantasiatextoNome Fantasia do estabelecimento.
empresa.cRazaoSocialtextoRazão social do estabelecimento.
nPaginanúmero inteiro
nRegistrosnúmero inteiro
nTotPaginasnúmero inteiro
nTotRegistrosnúmero inteiro
pagamentoslista de objetos
pagamentos[].NSUtextoNúmero do NSU (TEF/POS).
pagamentos[].NSUHosttextoNSU (Número Sequencial Único) Identifica uma operação de venda no host.
pagamentos[].TIDtextoTID (Transaction ID) identifica uma transação realizada via e-commerce pelo adquirente / subadquirente.
pagamentos[].cBancotextoCódigo do Banco.
pagamentos[].cBandeiratextoCódigo da Bandeira.
pagamentos[].cCategoriatextoCódigo da Categoria.
pagamentos[].cChaveCupomtextoChave do Cupom Fiscal.
pagamentos[].cCnpjAdquirentetextoCNPJ da instituição de pagamente ou adquirente.
pagamentos[].cCpfCnpjClientetextoCPF/CNPJ do Cliente.
pagamentos[].cCupomCanceladotextoCupom Fiscal Cancelado (S/N)?
pagamentos[].cCupomDevolvidotextoCupom Fiscal Devolvido (S/N)?
pagamentos[].cDREtextoCódigo no DRE.
pagamentos[].cEstabelecimentotextoCódigo do estabelecimento.
pagamentos[].cHrEmisaoCupomtextoHora de emissão de Cupom Fiscal.
pagamentos[].cIndPagtextoCódigo da Forma de Pagamento. Pode ser: 0 = Pagamento à Vista 1 = Pagamento à Prazo.
pagamentos[].cItemAgrupadotextoIndica se o título foi gerado de forma agrupada ou individual.
pagamentos[].cLiquidadotextoIndica se o Título está Liquidado (S/N)?
pagamentos[].cMeioPagtextoCódigo do Meio de pagamento utilizado. Pode ser: 01=Dinheiro 02=Cheque 03=Cartão de Crédito 04=Cartão de Débito 05=Crédito Loja 10=Vale Alimentação 11=Vale Refeição 12=Vale Presente 13=Vale Combustível 15=Boleto Bancário 16=Depósito Bancário 17=Pagamento Instantâneo (PIX) 18=Transferência bancária, Carteira Digital 19=Programa de fidelidade, Cashback, Crédito Virtual 90= Sem pagamento 99=Outros.
pagamentos[].cModeloCupomtextoModelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e.
pagamentos[].cNossoNumerotextoIdentificação do pagamento no Cupom Fiscal.
pagamentos[].cNumParcelatextoNúmero da parcela.
pagamentos[].cNumeroDocFiscaltextoNúmero do Documento Fiscal.
pagamentos[].cNumeroDocumentotextoNúmero do documento.
pagamentos[].cRazaoSocialClientetextoRazão Social do Cliente.
pagamentos[].cRedePOStextoNome da rede.
pagamentos[].cRedeTEFtextoNome da rede.
pagamentos[].cTipoCartaoTEFtextoTipo de Cartão utilizado (TEF).
pagamentos[].cTipoDoctextoTipo de Documento. Pode ser: 99999 - Outros BOL - Boleto CHQ - Cheque CHT - Cheque de Terceiros CRC - Cartão de Crédito CRD - Cartão de Débito CRE - Creadiário CRT - Cartão DIN - Dinheiro PIX - Pix.
pagamentos[].cTpBandeiratextoCódigo da Bandeira da operadora de cartão de crédito/débito. Pode ser: 01=Visa 02=Mastercard 03=American Express 04=Sorocred 05=Diners Club 06=Elo 07=Hipercard 08=Aura 09=Cabal 99=Outros.
pagamentos[].cTpIntegratextoTipo de Integração do processo de pagamento. Pode ser: 1 = Pagamento integrado com o sistema de automação (TEF). 2= Pagamento não integrado com o sistema de automação (POS).
pagamentos[].dDtAlteracaotextoData de Alteração do Documento.
pagamentos[].dDtEmissaotextoData de Emissão do Documento.
pagamentos[].dDtEmissaoCupomtextoData de emissão do Cupom Fiscal.
pagamentos[].dDtInclusaotextoData de Inclusão do Documento.
pagamentos[].dDtPagamentotextoData de Pagamento do Documento.
pagamentos[].dDtPrevisaotextoData de Previsão do Documento.
pagamentos[].dDtRegistrotextoData de Registro do Documento.
pagamentos[].dDtVencimentotextoData de Vencimento do Documento.
pagamentos[].dTransacaotextoData da transação da operação do cartão.
pagamentos[].hTransacaotextoHora da transação da operação do cartão.
pagamentos[].idClientenúmero inteiroCódigo do cliente.
pagamentos[].idContaCorrentenúmero inteiroCódigo da Conta Corrente.
pagamentos[].nCodTitulonúmero inteiroCódigo do título.
pagamentos[].nIdCupomnúmero inteiroID do Cupom Fiscal.
pagamentos[].nNumAutorizacaoTEFtextoNúmero de autorização do TEF.
pagamentos[].nNumCupomnúmero inteiroNúmero do Cupom Fiscal.
pagamentos[].nParcelaPOSnúmero inteiroNúmero de parcelas.
pagamentos[].nParcelaTEFnúmero inteiroNúmero de parcelas.
pagamentos[].nSerieCupomtextoSérie do Cupom Fiscal.
pagamentos[].nValAbertodecimalValor em aberto do Título.
pagamentos[].nValPagodecimalValor pago do Título.
pagamentos[].nValorCupomdecimalValor do Cupom Fiscal.
pagamentos[].nValorDocumentodecimalValor do Documento.
pagamentos[].nValorItemdecimalValor do Pagamento no item.
pagamentos[].nValorPOSdecimalValor autorizado.
pagamentos[].nValorTEFdecimalValor autorizado.
pagamentos[].seqCaixanúmero inteiroNúmero sequencial do Caixa.
pagamentos[].seqCupomnúmero inteiroNumero sequencial do cupom.
pagamentos[].seqItemnúmero inteiroSequência do item do cupom fiscal.
pagamentos[].xCategoriatextoDescrição da Categoria.
pagamentos[].xContaCorrentetextoDescrição da Conta Corrente.
POST /api/v1/produtos/cupomfiscalconsultar/
curl -s https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CuponsPagamentos", "param": [{"nPagina": 1, "nRegPorPagina": 50}]}'