Finanças ·
PesquisarTitulosPesquisa titulos de Contas a Pagar e Receber
1consulta
0alterações
Claude · ChatGPT · MCPpelos assistentes de IA
JSON · XMLformato
Pesquisa os lancamentos de títulos de Contas a Pagar e Receber
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 42Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCPFCNPJCliente | texto · até 20 | Filtrar os títulos por CPF/CNPJ do cliente. |
cChaveNFe | texto · até 44 | Chave da NF-e, CT-e, NFC-e de origem. |
cCodCateg | texto · até 20 | Código da Categoria. |
cCodIntTitulo | texto · até 60 | Código de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela) |
cCodigoBarras | texto · até 70 | Código de Barras do título. |
cNatureza | texto · até 1 | Filtrar os títulos pela natureza. Pode ser: P - Contas a Pagar. R - Contas a Receber. |
cNumCtr | texto · até 60 | Filtrar os títulos pelo número do contrato informado pelo usuário. |
cNumDocFiscal | texto · até 20 | Número do documento fiscal (NF-e, NFC-e, NFS-e, etc) (Informado pelo usuário / visualizado na tela) |
cNumOS | texto · até 15 | Filtrar os títulos pelo código da Ordem de Serviço. (Código visualizado na tela) |
cNumTitulo | texto · até 20 | Número do título. (Informado pelo usuário / visualizado na tela) |
cOperacao | texto · até 2 | Operação do título. Pode ser: 01 - Venda de Serviço 11 - Venda de Produto 12 - Venda de Produto pelo PDV 13 - Devolução de Venda 14 - Remessa de Produto 16 - Transferência |
cOrdemDecrescente | texto · até 1 | Se a lista será apresentada em ordem decrescente. |
cOrdenarPor | texto · até 100 | Ordem de exibição do dados. Pode ser: CODIGO CODIGO_INTEGRACAO |
cStatus | texto · até 100 | Filtrar os títulos pelo status. Pode ser: CANCELADO RECEBIDO LIQUIDADO EMABERTO PAGTO_PARCIAL VENCEHOJE AVENCER ATRASADO |
cTipo | texto · até 5 | Tipo de Documento. Pode ser: ADI - Adiantamento BOL - Boleto CRT - Cartão CHQ - Cheque CON - Convênios CRE - Crediário DRF - DARF DAS - DAS DEB - Débito em conta DIN - Dinheiro DOC - DOC GUIA - Guia de Recolhimento PROT - Protesto REC - Recibo RPA - RPA TED - TED TRA - Transferência 99999 - Outros |
dDtAltAte | texto · até 10 | Data de alteração |
dDtAltDe | texto · até 10 | Data de alteração |
dDtCancAte | texto · até 10 | |
dDtCancDe | texto · até 10 | |
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 |
dDtRegAte | texto · até 10 | Data de registro |
dDtRegDe | texto · até 10 | Data de registro |
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. |
lDadosCad | sim/não | Exibir dados cadastrais como Data de Inclusão, Alteração do Título. Pode ser: true false Default false. |
nCodCC | número inteiro | Filtrar os títulos pelo código da conta corrente. (Gerado internamente, não é visualizado na tela) |
nCodCliente | número inteiro | Filtrar os títulos pelo código do cliente. (Gerado internamente, não é visualizado na tela) |
nCodComprador | número inteiro | Código do comprador. (Gerado internamente, não é visualizado na tela) |
nCodCtr | número inteiro | Filtrar os títulos pelo código do contrato. (Gerado internamente, não é visualizado na tela) |
nCodOS | número inteiro | Filtrar os títulos pelo código da Ordem de Serviço. (Gerado internamente, não é visualizado na tela) |
nCodProjeto | número inteiro | Código do projeto. (Gerado internamente, não é visualizado na tela) |
nCodTitulo | número inteiro | Código do titulo. (Gerado internamente, não é visualizado na tela) |
nCodVendedor | número inteiro | Código do vendedor. (Gerado internamente, não é visualizado na tela) |
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 |
|---|---|---|
nPagina | número inteiro | |
nRegistros | número inteiro | |
nTotPaginas | número inteiro | |
nTotRegistros | número inteiro | |
titulosEncontrados | lista de objetos | |
titulosEncontrados[].cabecTitulo | objeto | Informações sobre o título encontrado |
titulosEncontrados[].cabecTitulo.aCodCateg | lista de objetos | |
titulosEncontrados[].cabecTitulo.aCodCateg[].cCodCateg | texto | Código da categoria |
titulosEncontrados[].cabecTitulo.aCodCateg[].nPerc | decimal | Percentual da categoria |
titulosEncontrados[].cabecTitulo.aCodCateg[].nValor | decimal | Valor da categoria |
titulosEncontrados[].cabecTitulo.cCPFCNPJCliente | texto | Filtrar os títulos por CPF/CNPJ do cliente. |
titulosEncontrados[].cabecTitulo.cChaveNFe | texto | Chave da NF-e, CT-e, NFC-e de origem. |
titulosEncontrados[].cabecTitulo.cCodCateg | texto | Código da categoria. |
titulosEncontrados[].cabecTitulo.cCodIntTitulo | texto | Código de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela) |
titulosEncontrados[].cabecTitulo.cCodProjeto | número inteiro | Código do projeto. (Gerado internamente, não é visualizado na tela) |
titulosEncontrados[].cabecTitulo.cCodVendedor | número inteiro | Código do vendedor. (Gerado internamente, não é visualizado na tela) |
titulosEncontrados[].cabecTitulo.cCodigoBarras | texto | Código de Barras do título. |
titulosEncontrados[].cabecTitulo.cNSU | texto | Número Sequencial Único - Comprovante de pagamento. |
titulosEncontrados[].cabecTitulo.cNatureza | texto | Natureza do título. Pode ser: P - Contas a Pagar R - Contas a Receber |
titulosEncontrados[].cabecTitulo.cNumBoleto | texto | Número do Boleto. |
titulosEncontrados[].cabecTitulo.cNumCtr | texto | Número do contrato associado ao título. (Informado pelo usuário / visualizado na tela) |
titulosEncontrados[].cabecTitulo.cNumDocFiscal | texto | Número do documento fiscal (NF-e, NFC-e, NFS-e, etc) (Informado pelo usuário / visualizado na tela) |
titulosEncontrados[].cabecTitulo.cNumOS | texto | Número do pedido de venda / Ordem de Serviço. (visualizado na tela) |
titulosEncontrados[].cabecTitulo.cNumParcela | texto | Número da parcela "Formatada" como 999/999 |
titulosEncontrados[].cabecTitulo.cNumTitulo | texto | Número do título. (Informado pelo usuário / visualizado na tela) |
titulosEncontrados[].cabecTitulo.cOperacao | texto | Operação do título. Pode ser: 01 - Venda de Serviço 11 - Venda de Produto 12 - Venda de Produto pelo PDV 13 - Devolução de Venda 14 - Remessa de Produto 16 - Nota Complementar de Saída 21 - Compra de Produto 22 - Compra de Produto (Importação) 23 - Devolução ao Fornecedor 24 - Retorno de Remessa 26 - Nota Complementar de Entrada 28 - Ordem de Produção |
titulosEncontrados[].cabecTitulo.cOrigem | texto | Origem do lançamento. Pode ser: APBP Integração de Pagamento de Conta APBR Integração de Recebimento de Conta APEP Integração de Lançamento de Despesa APER Integração de Lançamento de Receita APIP Integração de Conta a Pagar APIR Integração de Conta a Receber BARP Conta a Pagar Importada por Código de Barras BARR Conta a Receber Importada por Código de Barras BAXP Pagamento de Conta a Pagar BAXR Recebimento de Conta a Receber COMP Parcela a Pagar de Compras DEVP Conta a Pagar da Devolução de Venda DEVR Conta a Receber da Devolução ao Fornecedor EXTP Lançamento Manual de Despesa EXTR Lançamento Manual de Receita IMPP Parcela a Pagar de uma Nota de Importação MANP Lançamento Manual de Conta a Pagar MANR Lançamento Manual de Conta a Receber NFEP Conta a Pagar Importada de uma NF-e NFER Conta a Receber Importada de uma NF-e OFXP Pagamento Importado de um arquivo OFX OFXR Recebimento Importado de um arquivo OFX RPTP Repetição de Contas a Pagar RPTR Repetição de Contas a Receber TRAP Débito de Transf. entre Contas Correntes TRAR Crédito de Transf. entre Contas Correntes VENR Parcela a Receber de Vendas XMLP Conta a Pagar Importada de um arquivo XML XMLR Conta a Receber Importada de um arquivo XML |
titulosEncontrados[].cabecTitulo.cRetCOFINS | texto | Indica que o Valor do COFINS informado deve ser retido. |
titulosEncontrados[].cabecTitulo.cRetCSLL | texto | Indica que o Valor do CSLL informado deve ser retido. |
titulosEncontrados[].cabecTitulo.cRetINSS | texto | Indica que o Valor do INSS informado deve ser retido. |
titulosEncontrados[].cabecTitulo.cRetIR | texto | Indica que o Valor do Imposto de Renda informado deve ser retido. |
titulosEncontrados[].cabecTitulo.cRetISS | texto | Indica que o Valor do ISS informado deve ser retido. |
titulosEncontrados[].cabecTitulo.cRetPIS | texto | Indica que o Valor do PIS informado deve ser retido. |
titulosEncontrados[].cabecTitulo.cStatus | texto | Status do título. Pode ser: CANCELADO RECEBIDO LIQUIDADO EMABERTO PAGTO_PARCIAL VENCEHOJE AVENCER ATRASADO |
titulosEncontrados[].cabecTitulo.cTipo | texto | Tipo de documento. Pode ser: ADI - Adiantamento BOL - Boleto CRT - Cartão CHQ - Cheque CON - Convênios CRE - Crediário DRF - DARF DAS - DAS DEB - Débito em conta DIN - Dinheiro DOC - DOC GUIA - Guia de Recolhimento PROT - Protesto REC - Recibo RPA - RPA TED - TED TRA - Transferência 99999 - Outros |
titulosEncontrados[].cabecTitulo.dDtCanc | texto | Data de Cancelamento do título. |
titulosEncontrados[].cabecTitulo.dDtEmissao | texto | Data de emissão do título. |
titulosEncontrados[].cabecTitulo.dDtPagamento | texto | Data de pagamento do título. |
titulosEncontrados[].cabecTitulo.dDtPrevisao | texto | Data de previsão de Pagamento/Recebimento. |
titulosEncontrados[].cabecTitulo.dDtRegistro | texto | Data de registro da NF. |
titulosEncontrados[].cabecTitulo.dDtVenc | texto | Data de vencimento do título. |
titulosEncontrados[].cabecTitulo.departamentos | lista de objetos | Distribuição por departamentos. |
titulosEncontrados[].cabecTitulo.departamentos[].cCodDepartamento | texto | Código do Departamento. |
titulosEncontrados[].cabecTitulo.departamentos[].nDistrPercentual | decimal | Percentual da distribuição. |
titulosEncontrados[].cabecTitulo.departamentos[].nDistrValor | decimal | Valor da distribuição. |
titulosEncontrados[].cabecTitulo.departamentos[].nValorFixo | texto | Indica que o valor foi fixado na distribuição (S/N). |
titulosEncontrados[].cabecTitulo.info | objeto | Informações complemetares. |
titulosEncontrados[].cabecTitulo.info.cImpAPI | texto | Importado pela API (S/N). |
titulosEncontrados[].cabecTitulo.info.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. |
titulosEncontrados[].cabecTitulo.info.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. |
titulosEncontrados[].cabecTitulo.info.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. |
titulosEncontrados[].cabecTitulo.info.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. |
titulosEncontrados[].cabecTitulo.info.uAlt | texto | Usuário da Alteração. |
titulosEncontrados[].cabecTitulo.info.uInc | texto | Usuário da Inclusão. |
titulosEncontrados[].cabecTitulo.nCodCC | número inteiro | Código da conta corrente. (Gerado internamente, não é visualizado na tela) |
titulosEncontrados[].cabecTitulo.nCodCliente | número inteiro | Código de Cliente / Fornecedor. (Gerado internamente, não é visualizado na tela) |
titulosEncontrados[].cabecTitulo.nCodComprador | número inteiro | Código do comprador. (Gerado internamente, não é visualizado na tela) |
titulosEncontrados[].cabecTitulo.nCodCtr | número inteiro | Código do contrato associado ao título. (Gerado internamente, não é visualizado na tela) |
titulosEncontrados[].cabecTitulo.nCodNF | número inteiro | Código da Nota Fiscal. |
titulosEncontrados[].cabecTitulo.nCodOS | número inteiro | Código do Pedido de Venda / Ordem de Serviço. (Gerado internamente, não é visualizado na tela) |
titulosEncontrados[].cabecTitulo.nCodTitRepet | número inteiro | Código do título original que gerou a repetição dos lançamentos. |
titulosEncontrados[].cabecTitulo.nCodTitulo | número inteiro | Código do titulo. (Gerado internamente, não é visualizado na tela) |
titulosEncontrados[].cabecTitulo.nValorCOFINS | decimal | Valor do COFINS. |
titulosEncontrados[].cabecTitulo.nValorCSLL | decimal | Valor do CSLL. |
titulosEncontrados[].cabecTitulo.nValorINSS | decimal | Valor do INSS. |
titulosEncontrados[].cabecTitulo.nValorIR | decimal | Valor do Imposto de Renda. |
titulosEncontrados[].cabecTitulo.nValorISS | decimal | Valor do ISS. |
titulosEncontrados[].cabecTitulo.nValorPIS | decimal | Valor do PIS. |
titulosEncontrados[].cabecTitulo.nValorTitulo | decimal | Valor do título. |
titulosEncontrados[].cabecTitulo.observacao | texto | Observações do título. |
titulosEncontrados[].lancamentos | lista de objetos | Lançamentos realizados para o título |
titulosEncontrados[].lancamentos[].cCodIntLanc | texto | Código de Integração do Lançamento |
titulosEncontrados[].lancamentos[].cNatureza | texto | Natureza do Lançamento. Pode ser: P - Contas a Pagar R - Contas a Receber |
titulosEncontrados[].lancamentos[].cObsLanc | texto | Observação para o lançamento |
titulosEncontrados[].lancamentos[].dDtLanc | texto | Data do Lançamento |
titulosEncontrados[].lancamentos[].nCodCC | número inteiro | Código da Conta Corrente |
titulosEncontrados[].lancamentos[].nCodLanc | número inteiro | Código do lançamento |
titulosEncontrados[].lancamentos[].nDesconto | decimal | Descontos do título |
titulosEncontrados[].lancamentos[].nIdLancCC | número inteiro | Código do Lançamento na Conta Corrente |
titulosEncontrados[].lancamentos[].nJuros | decimal | Juros para o título |
titulosEncontrados[].lancamentos[].nMulta | decimal | Multa para o título |
titulosEncontrados[].lancamentos[].nValLanc | decimal | Valor do Lançamento |
titulosEncontrados[].resumo | objeto | Resumo dos pagamentos realizados para o título |
titulosEncontrados[].resumo.cLiquidado | texto | Indica se o título está liquidado. Pode ser: S - Sim, indicado que o título está quitado. N - Não, indicando que o título ainda está em aberto. |
titulosEncontrados[].resumo.nDesconto | decimal | Valor do Desconto. |
titulosEncontrados[].resumo.nJuros | decimal | Valor do Juros. |
titulosEncontrados[].resumo.nMulta | decimal | Valor da Multa. |
titulosEncontrados[].resumo.nValAberto | decimal | Valor total em aberto para o título. |
titulosEncontrados[].resumo.nValLiquido | decimal | Valor líquido (nValPago - nDesconto + Juros + nMulta) |
titulosEncontrados[].resumo.nValPago | decimal | Valor total pago para o título. |
POST /api/v1/financas/pesquisartitulos/
curl -s https://app.omie.com.br/api/v1/financas/pesquisartitulos/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "PesquisarLancamentos", "param": [{"nPagina": 1, "nRegPorPagina": 20}]}'import os
import requests
corpo = {'call': 'PesquisarLancamentos', 'param': [{'nPagina': 1, 'nRegPorPagina': 20}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/pesquisartitulos/",
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/financas/pesquisartitulos/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "PesquisarLancamentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/pesquisartitulos/");
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": "PesquisarLancamentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/pesquisartitulos/")
corpo = <<~'JSON'
{
"call": "PesquisarLancamentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
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": "PesquisarLancamentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/pesquisartitulos/"))
.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/financas/pesquisartitulos/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""PesquisarLancamentos"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 20}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados