Produtos ·
CupomFiscalConsultarConsultas de cupom fiscal
3consultas
0alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Listagem dos cupons fiscais.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 8Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
dDtAlteracaoAte | texto · até 10 | Data da Alteração do Cupom Fiscal - Até. No formato dd/mm/aaaa. |
dDtAlteracaoDe | texto · até 10 | Data da Alteração do Cupom Fiscal - De. No formato dd/mm/aaaa. |
dDtEmissaoAte | texto · até 10 | Data de emissão do Cupom Fiscal - Até. No formato dd/mm/aaaa. |
dDtEmissaoDe | texto · até 10 | Data de emissão do Cupom Fiscal - De. No formato dd/mm/aaaa. |
dDtInclusaoAte | texto · até 10 | Data de Inclusão do Cupom Fiscal - Até. No formato dd/mm/aaaa. |
dDtInclusaoDe | texto · até 10 | Data de Inclusão do Cupom Fiscal - De. No formato dd/mm/aaaa. |
nPagina | número inteiro | Número da página a ser recuperada. |
nRegPorPagina | número inteiro | Número de registros por página. (máximo 500). |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cupons | lista de objetos | Lista de Cupons Fiscais. |
cupons[].cabecalhoCupom | objeto | Informações do cabeçalho do Cupom Fiscal. |
cupons[].cabecalhoCupom.cChaveCupom | texto | Chave do Cupom Fiscal. |
cupons[].cabecalhoCupom.cContingencia | texto | Indica se o Cupom Fiscal foi Emitido em ambiente de Contingencia. (S/N). |
cupons[].cabecalhoCupom.cHrEmisaoCupom | texto | Hora de emissão de Cupom Fiscal. |
cupons[].cabecalhoCupom.cModeloCupom | texto | Modelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e |
cupons[].cabecalhoCupom.dDtEmissaoCupom | texto | Data de emissão do Cupom Fiscal. |
cupons[].cabecalhoCupom.idCliente | número inteiro | Código do cliente. |
cupons[].cabecalhoCupom.idVendedor | número inteiro | Código do Vendedor. |
cupons[].cabecalhoCupom.info | objeto | Informações adicionais do Cupom Fiscal. |
cupons[].cabecalhoCupom.info.cCupomCancelado | texto | Cupom Fiscal Cancelado (S/N)? |
cupons[].cabecalhoCupom.info.cCupomDevolvido | texto | Cupom Fiscal Devolvido (S/N)? |
cupons[].cabecalhoCupom.info.cHrAlteracao | texto | Hora da Alteração do Cupom Fiscal. No formato hh:mm:ss. |
cupons[].cabecalhoCupom.info.cHrInclusao | texto | Hora da Inclusão do Cupom Fiscal. No formato hh:mm:ss. |
cupons[].cabecalhoCupom.info.dDtAlteracao | texto | Data de Alteração do Documento. |
cupons[].cabecalhoCupom.info.dDtInclusao | texto | Data de Inclusão do Documento. |
cupons[].cabecalhoCupom.info.uAlt | texto | Usuário da Alteração do Cupom Fiscal. |
cupons[].cabecalhoCupom.info.uInc | texto | Usuário da Inclusão do Cupom Fiscal. |
cupons[].cabecalhoCupom.nIdCupom | número inteiro | ID do Cupom Fiscal. |
cupons[].cabecalhoCupom.nNumCupom | número inteiro | Número do Cupom Fiscal. |
cupons[].cabecalhoCupom.nSerieCupom | texto | Série do Cupom Fiscal. |
cupons[].cabecalhoCupom.nValorCOFINS | decimal | Valor do COFINS. |
cupons[].cabecalhoCupom.nValorCupom | decimal | Valor do Cupom Fiscal. |
cupons[].cabecalhoCupom.nValorICMS | decimal | Valor do ICMS. |
cupons[].cabecalhoCupom.nValorPIS | decimal | Valor do PIS. |
cupons[].cabecalhoCupom.nValorTaxa | decimal | Valor da Taxa. |
cupons[].cabecalhoCupom.seqCaixa | número inteiro | Número sequencial do Caixa. |
cupons[].cabecalhoCupom.seqCupom | número inteiro | Numero sequencial do cupom. |
cupons[].itensCupom | lista de objetos | Informações dos Itens do Cupom Fiscal. |
cupons[].itensCupom[].cCFOP | texto | CFOP do Item. |
cupons[].itensCupom[].cCodigo | texto | Código do Produto no Cupom Fiscal. |
cupons[].itensCupom[].cItemCancelado | texto | Item do Cupom Fiscal Cancelado (S/N)? |
cupons[].itensCupom[].cItemDevolvido | texto | Item do Cupom Fiscal Devolvido (S/N)? |
cupons[].itensCupom[].cNCM | texto | NCM do Item. |
cupons[].itensCupom[].cUn | texto | Unidade do item do cupom fiscal. |
cupons[].itensCupom[].emiProduto | texto | Código do PDV do item do cupom fiscal. |
cupons[].itensCupom[].idItem | número inteiro | ID do item do cupom fiscal. |
cupons[].itensCupom[].idProduto | número inteiro | ID do produto do item do cupom fiscal. |
cupons[].itensCupom[].nAliqCOFINS | decimal | Alíquota do COFINS. |
cupons[].itensCupom[].nAliqICMS | decimal | Alíquota do ICMS. |
cupons[].itensCupom[].nAliqPIS | decimal | Alíquota do PIS. |
cupons[].itensCupom[].nQuant | decimal | Quantidade do item do cupom fiscal. |
cupons[].itensCupom[].nSequencia | número inteiro | Sequência do item no Cupom Fiscal. |
cupons[].itensCupom[].nValorCOFINS | decimal | Valor do COFINS. |
cupons[].itensCupom[].nValorICMS | decimal | Valor do ICMS. |
cupons[].itensCupom[].nValorOutros | decimal | Outros valores. |
cupons[].itensCupom[].nValorPIS | decimal | Valor do PIS. |
cupons[].itensCupom[].vAcresc | decimal | Valor acréscimo do item do cupom fiscal. |
cupons[].itensCupom[].vDesc | decimal | Valor desconto do item do cupom fiscal. |
cupons[].itensCupom[].vItem | decimal | Valor líquido do item do cupom fiscal. |
cupons[].itensCupom[].vUnit | decimal | Valor unitário do item do cupom fiscal. |
cupons[].itensCupom[].xProd | texto | Descrição do item do cupom fiscal. |
cupons[].pagamentosCupom | lista de objetos | Informações dos Pagamentos do Cupom Fiscal. |
cupons[].pagamentosCupom[].cCategoria | texto | Código da Categoria. |
cupons[].pagamentosCupom[].cNumParcela | texto | Número da parcela. |
cupons[].pagamentosCupom[].cTipoDoc | texto | Tipo 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[].dDtVencimento | texto | Data de Vencimento do Documento. |
cupons[].pagamentosCupom[].idContaCorrente | número inteiro | Código da Conta Corrente. |
cupons[].pagamentosCupom[].nCodTitulo | número inteiro | Código do título. |
cupons[].pagamentosCupom[].nSequencia | número inteiro | Sequência do item no Cupom Fiscal. |
cupons[].pagamentosCupom[].nValorDocumento | decimal | Valor do Documento. |
cupons[].pagamentosCupom[].nValorTaxa | decimal | Valor da Taxa. |
nPagina | número inteiro | |
nRegistros | número inteiro | |
nTotPaginas | número inteiro | |
nTotRegistros | nú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}]}'import os
import requests
corpo = {'call': 'CuponsFiscais', 'param': [{'nPagina': 1, 'nRegPorPagina': 50}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/",
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/cupomfiscalconsultar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "CuponsFiscais",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/");
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": "CuponsFiscais",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/")
corpo = <<~'JSON'
{
"call": "CuponsFiscais",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
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": "CuponsFiscais",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/"))
.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/cupomfiscalconsultar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""CuponsFiscais"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 50}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosListagem dos itens dos cupons fiscais.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 9Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
dDtAltAte | texto · até 10 | Data de alteração. |
dDtAltDe | texto · até 10 | Data de alteração. |
dDtEmisAte | texto · até 10 | Filtrar os títulos pela data de emissão - até. |
dDtEmisDe | texto · até 10 | Filtrar os títulos pela data de emissão - a partir de. |
dDtIncAte | texto · até 10 | Data de inclusão. |
dDtIncDe | texto · até 10 | Data de inclusão. |
nIdCupom | número inteiro | ID do Cupom Fiscal. |
nPagina | número inteiro | Número da página a ser recuperada. |
nRegPorPagina | número inteiro | Número de registros por página. (máximo 50). |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
itens | lista de objetos | |
itens[].cChaveCupom | texto | Chave do Cupom Fiscal. |
itens[].cCpfCnpjCliente | texto | CPF/CNPJ do Cliente. |
itens[].cCupomCancelado | texto | Cupom Fiscal Cancelado (S/N)? |
itens[].cCupomDevolvido | texto | Cupom Fiscal Devolvido (S/N)? |
itens[].cHrEmisaoCupom | texto | Hora de emissão de Cupom Fiscal. |
itens[].cItemCancelado | texto | Item do Cupom Fiscal Cancelado (S/N)? |
itens[].cItemDevolvido | texto | Item do Cupom Fiscal Devolvido (S/N)? |
itens[].cModeloCupom | texto | Modelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e. |
itens[].cNaoMovEstoque | texto | Indica se o item do cupom fiscal não movimenta estoque. |
itens[].cRazaoSocialCliente | texto | Razão Social do Cliente. |
itens[].cUn | texto | Unidade do item do cupom fiscal. |
itens[].dDtAlteracao | texto | Data de Alteração do Documento. |
itens[].dDtEmissaoCupom | texto | Data de emissão do Cupom Fiscal. |
itens[].dDtInclusao | texto | Data de Inclusão do Documento. |
itens[].emiProduto | texto | Código do PDV do item do cupom fiscal. |
itens[].idAjusteCanc | número inteiro | Id da movimentação de cancelamento de ajuste do estoque do item do cupom fiscal. |
itens[].idAjusteEstoque | número inteiro | Id da movimentação de ajuste do estoque do item do cupom fiscal. |
itens[].idCliente | número inteiro | Código do cliente. |
itens[].idItem | número inteiro | ID do item do cupom fiscal. |
itens[].idLocalEstoque | número inteiro | Id do local de estoque do item do cupom fiscal. |
itens[].idMovCanc | número inteiro | ID do Movimento de Estoque do cancelamento do item do cupom fiscal. |
itens[].idMovEstoque | número inteiro | Id da movimentação de estoque do item do cupom. |
itens[].idProduto | número inteiro | ID do produto do item do cupom fiscal. |
itens[].nIdCupom | número inteiro | ID do Cupom Fiscal. |
itens[].nNumCupom | número inteiro | Número do Cupom Fiscal. |
itens[].nQuant | decimal | Quantidade do item do cupom fiscal. |
itens[].nQuantDev | decimal | Quantidade devolvida do item do cupom fiscal. |
itens[].nSerieCupom | texto | Série do Cupom Fiscal. |
itens[].nValorCupom | decimal | Valor do Cupom Fiscal. |
itens[].seqCaixa | número inteiro | Número sequencial do Caixa. |
itens[].seqCupom | número inteiro | Numero sequencial do cupom. |
itens[].seqItem | número inteiro | Sequência do Item do Cupom Fiscal. |
itens[].vAcresc | decimal | Valor acréscimo do item do cupom fiscal. |
itens[].vDesc | decimal | Valor desconto do item do cupom fiscal. |
itens[].vItem | decimal | Valor líquido do item do cupom fiscal. |
itens[].vUnit | decimal | Valor unitário do item do cupom fiscal. |
itens[].xProd | texto | Descrição do item do cupom fiscal. |
nPagina | número inteiro | |
nRegistros | número inteiro | |
nTotPaginas | número inteiro | |
nTotRegistros | nú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}]}'import os
import requests
corpo = {'call': 'CuponsItens', 'param': [{'nPagina': 1, 'nRegPorPagina': 50}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/",
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/cupomfiscalconsultar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "CuponsItens",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/");
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": "CuponsItens",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/")
corpo = <<~'JSON'
{
"call": "CuponsItens",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
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": "CuponsItens",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/"))
.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/cupomfiscalconsultar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""CuponsItens"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 50}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosListagem dos pagamentos dos cupons fiscais.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 14Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
dDtAltAte | texto · até 10 | Data de alteração. |
dDtAltDe | texto · até 10 | Data de alteração. |
dDtEmisAte | texto · até 10 | Filtrar os títulos pela data de emissão - até. |
dDtEmisDe | texto · até 10 | Filtrar os títulos pela data de emissão - a partir de. |
dDtIncAte | texto · até 10 | Data de inclusão. |
dDtIncDe | texto · até 10 | Data de inclusão. |
dDtPagtoAte | texto · até 10 | Filtrar os títulos pela data de pagamento - até. |
dDtPagtoDe | texto · até 10 | Filtrar os títulos pela data de pagamento - a partir de. |
dDtPrevAte | texto · até 10 | Data de previsão. |
dDtPrevDe | texto · até 10 | Data de previsão. |
dDtVencAte | texto · até 10 | Filtrar os títulos pela data de vencimento - até. |
dDtVencDe | texto · até 10 | Filtrar os títulos pela data de vencimento - a partir de. |
nPagina | número inteiro | Número da página a ser recuperada. |
nRegPorPagina | número inteiro | Número de registros por página. (máximo 50). |
Retorno 6O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
empresa | objeto | Informações do estabelecimento. |
empresa.cCNPJ | texto | CNPJ do estabelecimento. |
empresa.cIE | texto | Inscrição Estadual do estabelecimento. |
empresa.cNomeFantasia | texto | Nome Fantasia do estabelecimento. |
empresa.cRazaoSocial | texto | Razão social do estabelecimento. |
nPagina | número inteiro | |
nRegistros | número inteiro | |
nTotPaginas | número inteiro | |
nTotRegistros | número inteiro | |
pagamentos | lista de objetos | |
pagamentos[].NSU | texto | Número do NSU (TEF/POS). |
pagamentos[].NSUHost | texto | NSU (Número Sequencial Único) Identifica uma operação de venda no host. |
pagamentos[].TID | texto | TID (Transaction ID) identifica uma transação realizada via e-commerce pelo adquirente / subadquirente. |
pagamentos[].cBanco | texto | Código do Banco. |
pagamentos[].cBandeira | texto | Código da Bandeira. |
pagamentos[].cCategoria | texto | Código da Categoria. |
pagamentos[].cChaveCupom | texto | Chave do Cupom Fiscal. |
pagamentos[].cCnpjAdquirente | texto | CNPJ da instituição de pagamente ou adquirente. |
pagamentos[].cCpfCnpjCliente | texto | CPF/CNPJ do Cliente. |
pagamentos[].cCupomCancelado | texto | Cupom Fiscal Cancelado (S/N)? |
pagamentos[].cCupomDevolvido | texto | Cupom Fiscal Devolvido (S/N)? |
pagamentos[].cDRE | texto | Código no DRE. |
pagamentos[].cEstabelecimento | texto | Código do estabelecimento. |
pagamentos[].cHrEmisaoCupom | texto | Hora de emissão de Cupom Fiscal. |
pagamentos[].cIndPag | texto | Código da Forma de Pagamento. Pode ser: 0 = Pagamento à Vista 1 = Pagamento à Prazo. |
pagamentos[].cItemAgrupado | texto | Indica se o título foi gerado de forma agrupada ou individual. |
pagamentos[].cLiquidado | texto | Indica se o Título está Liquidado (S/N)? |
pagamentos[].cMeioPag | texto | Có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[].cModeloCupom | texto | Modelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e. |
pagamentos[].cNossoNumero | texto | Identificação do pagamento no Cupom Fiscal. |
pagamentos[].cNumParcela | texto | Número da parcela. |
pagamentos[].cNumeroDocFiscal | texto | Número do Documento Fiscal. |
pagamentos[].cNumeroDocumento | texto | Número do documento. |
pagamentos[].cRazaoSocialCliente | texto | Razão Social do Cliente. |
pagamentos[].cRedePOS | texto | Nome da rede. |
pagamentos[].cRedeTEF | texto | Nome da rede. |
pagamentos[].cTipoCartaoTEF | texto | Tipo de Cartão utilizado (TEF). |
pagamentos[].cTipoDoc | texto | Tipo 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[].cTpBandeira | texto | Có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[].cTpIntegra | texto | Tipo 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[].dDtAlteracao | texto | Data de Alteração do Documento. |
pagamentos[].dDtEmissao | texto | Data de Emissão do Documento. |
pagamentos[].dDtEmissaoCupom | texto | Data de emissão do Cupom Fiscal. |
pagamentos[].dDtInclusao | texto | Data de Inclusão do Documento. |
pagamentos[].dDtPagamento | texto | Data de Pagamento do Documento. |
pagamentos[].dDtPrevisao | texto | Data de Previsão do Documento. |
pagamentos[].dDtRegistro | texto | Data de Registro do Documento. |
pagamentos[].dDtVencimento | texto | Data de Vencimento do Documento. |
pagamentos[].dTransacao | texto | Data da transação da operação do cartão. |
pagamentos[].hTransacao | texto | Hora da transação da operação do cartão. |
pagamentos[].idCliente | número inteiro | Código do cliente. |
pagamentos[].idContaCorrente | número inteiro | Código da Conta Corrente. |
pagamentos[].nCodTitulo | número inteiro | Código do título. |
pagamentos[].nIdCupom | número inteiro | ID do Cupom Fiscal. |
pagamentos[].nNumAutorizacaoTEF | texto | Número de autorização do TEF. |
pagamentos[].nNumCupom | número inteiro | Número do Cupom Fiscal. |
pagamentos[].nParcelaPOS | número inteiro | Número de parcelas. |
pagamentos[].nParcelaTEF | número inteiro | Número de parcelas. |
pagamentos[].nSerieCupom | texto | Série do Cupom Fiscal. |
pagamentos[].nValAberto | decimal | Valor em aberto do Título. |
pagamentos[].nValPago | decimal | Valor pago do Título. |
pagamentos[].nValorCupom | decimal | Valor do Cupom Fiscal. |
pagamentos[].nValorDocumento | decimal | Valor do Documento. |
pagamentos[].nValorItem | decimal | Valor do Pagamento no item. |
pagamentos[].nValorPOS | decimal | Valor autorizado. |
pagamentos[].nValorTEF | decimal | Valor autorizado. |
pagamentos[].seqCaixa | número inteiro | Número sequencial do Caixa. |
pagamentos[].seqCupom | número inteiro | Numero sequencial do cupom. |
pagamentos[].seqItem | número inteiro | Sequência do item do cupom fiscal. |
pagamentos[].xCategoria | texto | Descrição da Categoria. |
pagamentos[].xContaCorrente | texto | Descriçã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}]}'import os
import requests
corpo = {'call': 'CuponsPagamentos', 'param': [{'nPagina': 1, 'nRegPorPagina': 50}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/",
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/cupomfiscalconsultar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "CuponsPagamentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/");
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": "CuponsPagamentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/")
corpo = <<~'JSON'
{
"call": "CuponsPagamentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
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": "CuponsPagamentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/cupomfiscalconsultar/"))
.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/cupomfiscalconsultar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""CuponsPagamentos"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 50}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados