OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Finanças · PesquisarTitulos

Pesquisa titulos de Contas a Pagar e Receber

POSThttps://app.omie.com.br/api/v1/financas/pesquisartitulos/WSDL
1consulta
0alterações
Claude · ChatGPT · MCPpelos assistentes de IA
JSON · XMLformato

PesquisarLancamentos

consultaClaudeChatGPTMCP

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
CampoTipoDescrição
cCPFCNPJClientetexto · até 20Filtrar os títulos por CPF/CNPJ do cliente.
cChaveNFetexto · até 44Chave da NF-e, CT-e, NFC-e de origem.
cCodCategtexto · até 20Código da Categoria.
cCodIntTitulotexto · até 60Código de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela)
cCodigoBarrastexto · até 70Código de Barras do título.
cNaturezatexto · até 1Filtrar os títulos pela natureza. Pode ser: P - Contas a Pagar. R - Contas a Receber.
cNumCtrtexto · até 60Filtrar os títulos pelo número do contrato informado pelo usuário.
cNumDocFiscaltexto · até 20Número do documento fiscal (NF-e, NFC-e, NFS-e, etc) (Informado pelo usuário / visualizado na tela)
cNumOStexto · até 15Filtrar os títulos pelo código da Ordem de Serviço. (Código visualizado na tela)
cNumTitulotexto · até 20Número do título. (Informado pelo usuário / visualizado na tela)
cOperacaotexto · até 2Operaçã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
cOrdemDecrescentetexto · até 1Se a lista será apresentada em ordem decrescente.
cOrdenarPortexto · até 100Ordem de exibição do dados. Pode ser: CODIGO CODIGO_INTEGRACAO
cStatustexto · até 100Filtrar os títulos pelo status. Pode ser: CANCELADO RECEBIDO LIQUIDADO EMABERTO PAGTO_PARCIAL VENCEHOJE AVENCER ATRASADO
cTipotexto · até 5Tipo 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
dDtAltAtetexto · até 10Data de alteração
dDtAltDetexto · até 10Data de alteração
dDtCancAtetexto · até 10
dDtCancDetexto · até 10
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
dDtRegAtetexto · até 10Data de registro
dDtRegDetexto · até 10Data de registro
dDtVencAtetexto · até 10Filtrar os títulos pela data de vencimento - até.
dDtVencDetexto · até 10Filtrar os títulos pela data de vencimento - a partir de.
lDadosCadsim/nãoExibir dados cadastrais como Data de Inclusão, Alteração do Título. Pode ser: true false Default false.
nCodCCnúmero inteiroFiltrar os títulos pelo código da conta corrente. (Gerado internamente, não é visualizado na tela)
nCodClientenúmero inteiroFiltrar os títulos pelo código do cliente. (Gerado internamente, não é visualizado na tela)
nCodCompradornúmero inteiroCódigo do comprador. (Gerado internamente, não é visualizado na tela)
nCodCtrnúmero inteiroFiltrar os títulos pelo código do contrato. (Gerado internamente, não é visualizado na tela)
nCodOSnúmero inteiroFiltrar os títulos pelo código da Ordem de Serviço. (Gerado internamente, não é visualizado na tela)
nCodProjetonúmero inteiroCódigo do projeto. (Gerado internamente, não é visualizado na tela)
nCodTitulonúmero inteiroCódigo do titulo. (Gerado internamente, não é visualizado na tela)
nCodVendedornúmero inteiroCódigo do vendedor. (Gerado internamente, não é visualizado na tela)
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
nPaginanúmero inteiro
nRegistrosnúmero inteiro
nTotPaginasnúmero inteiro
nTotRegistrosnúmero inteiro
titulosEncontradoslista de objetos
titulosEncontrados[].cabecTituloobjetoInformações sobre o título encontrado
titulosEncontrados[].cabecTitulo.aCodCateglista de objetos
titulosEncontrados[].cabecTitulo.aCodCateg[].cCodCategtextoCódigo da categoria
titulosEncontrados[].cabecTitulo.aCodCateg[].nPercdecimalPercentual da categoria
titulosEncontrados[].cabecTitulo.aCodCateg[].nValordecimalValor da categoria
titulosEncontrados[].cabecTitulo.cCPFCNPJClientetextoFiltrar os títulos por CPF/CNPJ do cliente.
titulosEncontrados[].cabecTitulo.cChaveNFetextoChave da NF-e, CT-e, NFC-e de origem.
titulosEncontrados[].cabecTitulo.cCodCategtextoCódigo da categoria.
titulosEncontrados[].cabecTitulo.cCodIntTitulotextoCódigo de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela)
titulosEncontrados[].cabecTitulo.cCodProjetonúmero inteiroCódigo do projeto. (Gerado internamente, não é visualizado na tela)
titulosEncontrados[].cabecTitulo.cCodVendedornúmero inteiroCódigo do vendedor. (Gerado internamente, não é visualizado na tela)
titulosEncontrados[].cabecTitulo.cCodigoBarrastextoCódigo de Barras do título.
titulosEncontrados[].cabecTitulo.cNSUtextoNúmero Sequencial Único - Comprovante de pagamento.
titulosEncontrados[].cabecTitulo.cNaturezatextoNatureza do título. Pode ser: P - Contas a Pagar R - Contas a Receber
titulosEncontrados[].cabecTitulo.cNumBoletotextoNúmero do Boleto.
titulosEncontrados[].cabecTitulo.cNumCtrtextoNúmero do contrato associado ao título. (Informado pelo usuário / visualizado na tela)
titulosEncontrados[].cabecTitulo.cNumDocFiscaltextoNúmero do documento fiscal (NF-e, NFC-e, NFS-e, etc) (Informado pelo usuário / visualizado na tela)
titulosEncontrados[].cabecTitulo.cNumOStextoNúmero do pedido de venda / Ordem de Serviço. (visualizado na tela)
titulosEncontrados[].cabecTitulo.cNumParcelatextoNúmero da parcela "Formatada" como 999/999
titulosEncontrados[].cabecTitulo.cNumTitulotextoNúmero do título. (Informado pelo usuário / visualizado na tela)
titulosEncontrados[].cabecTitulo.cOperacaotextoOperaçã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.cOrigemtextoOrigem 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.cRetCOFINStextoIndica que o Valor do COFINS informado deve ser retido.
titulosEncontrados[].cabecTitulo.cRetCSLLtextoIndica que o Valor do CSLL informado deve ser retido.
titulosEncontrados[].cabecTitulo.cRetINSStextoIndica que o Valor do INSS informado deve ser retido.
titulosEncontrados[].cabecTitulo.cRetIRtextoIndica que o Valor do Imposto de Renda informado deve ser retido.
titulosEncontrados[].cabecTitulo.cRetISStextoIndica que o Valor do ISS informado deve ser retido.
titulosEncontrados[].cabecTitulo.cRetPIStextoIndica que o Valor do PIS informado deve ser retido.
titulosEncontrados[].cabecTitulo.cStatustextoStatus do título. Pode ser: CANCELADO RECEBIDO LIQUIDADO EMABERTO PAGTO_PARCIAL VENCEHOJE AVENCER ATRASADO
titulosEncontrados[].cabecTitulo.cTipotextoTipo 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.dDtCanctextoData de Cancelamento do título.
titulosEncontrados[].cabecTitulo.dDtEmissaotextoData de emissão do título.
titulosEncontrados[].cabecTitulo.dDtPagamentotextoData de pagamento do título.
titulosEncontrados[].cabecTitulo.dDtPrevisaotextoData de previsão de Pagamento/Recebimento.
titulosEncontrados[].cabecTitulo.dDtRegistrotextoData de registro da NF.
titulosEncontrados[].cabecTitulo.dDtVenctextoData de vencimento do título.
titulosEncontrados[].cabecTitulo.departamentoslista de objetosDistribuição por departamentos.
titulosEncontrados[].cabecTitulo.departamentos[].cCodDepartamentotextoCódigo do Departamento.
titulosEncontrados[].cabecTitulo.departamentos[].nDistrPercentualdecimalPercentual da distribuição.
titulosEncontrados[].cabecTitulo.departamentos[].nDistrValordecimalValor da distribuição.
titulosEncontrados[].cabecTitulo.departamentos[].nValorFixotextoIndica que o valor foi fixado na distribuição (S/N).
titulosEncontrados[].cabecTitulo.infoobjetoInformações complemetares.
titulosEncontrados[].cabecTitulo.info.cImpAPItextoImportado pela API (S/N).
titulosEncontrados[].cabecTitulo.info.dAlttextoData da Alteração. No formato dd/mm/aaaa.
titulosEncontrados[].cabecTitulo.info.dInctextoData da Inclusão. No formato dd/mm/aaaa.
titulosEncontrados[].cabecTitulo.info.hAlttextoHora da Alteração. No formato hh:mm:ss.
titulosEncontrados[].cabecTitulo.info.hInctextoHora da Inclusão. No formato hh:mm:ss.
titulosEncontrados[].cabecTitulo.info.uAlttextoUsuário da Alteração.
titulosEncontrados[].cabecTitulo.info.uInctextoUsuário da Inclusão.
titulosEncontrados[].cabecTitulo.nCodCCnúmero inteiroCódigo da conta corrente. (Gerado internamente, não é visualizado na tela)
titulosEncontrados[].cabecTitulo.nCodClientenúmero inteiroCódigo de Cliente / Fornecedor. (Gerado internamente, não é visualizado na tela)
titulosEncontrados[].cabecTitulo.nCodCompradornúmero inteiroCódigo do comprador. (Gerado internamente, não é visualizado na tela)
titulosEncontrados[].cabecTitulo.nCodCtrnúmero inteiroCódigo do contrato associado ao título. (Gerado internamente, não é visualizado na tela)
titulosEncontrados[].cabecTitulo.nCodNFnúmero inteiroCódigo da Nota Fiscal.
titulosEncontrados[].cabecTitulo.nCodOSnúmero inteiroCódigo do Pedido de Venda / Ordem de Serviço. (Gerado internamente, não é visualizado na tela)
titulosEncontrados[].cabecTitulo.nCodTitRepetnúmero inteiroCódigo do título original que gerou a repetição dos lançamentos.
titulosEncontrados[].cabecTitulo.nCodTitulonúmero inteiroCódigo do titulo. (Gerado internamente, não é visualizado na tela)
titulosEncontrados[].cabecTitulo.nValorCOFINSdecimalValor do COFINS.
titulosEncontrados[].cabecTitulo.nValorCSLLdecimalValor do CSLL.
titulosEncontrados[].cabecTitulo.nValorINSSdecimalValor do INSS.
titulosEncontrados[].cabecTitulo.nValorIRdecimalValor do Imposto de Renda.
titulosEncontrados[].cabecTitulo.nValorISSdecimalValor do ISS.
titulosEncontrados[].cabecTitulo.nValorPISdecimalValor do PIS.
titulosEncontrados[].cabecTitulo.nValorTitulodecimalValor do título.
titulosEncontrados[].cabecTitulo.observacaotextoObservações do título.
titulosEncontrados[].lancamentoslista de objetosLançamentos realizados para o título
titulosEncontrados[].lancamentos[].cCodIntLanctextoCódigo de Integração do Lançamento
titulosEncontrados[].lancamentos[].cNaturezatextoNatureza do Lançamento. Pode ser: P - Contas a Pagar R - Contas a Receber
titulosEncontrados[].lancamentos[].cObsLanctextoObservação para o lançamento
titulosEncontrados[].lancamentos[].dDtLanctextoData do Lançamento
titulosEncontrados[].lancamentos[].nCodCCnúmero inteiroCódigo da Conta Corrente
titulosEncontrados[].lancamentos[].nCodLancnúmero inteiroCódigo do lançamento
titulosEncontrados[].lancamentos[].nDescontodecimalDescontos do título
titulosEncontrados[].lancamentos[].nIdLancCCnúmero inteiroCódigo do Lançamento na Conta Corrente
titulosEncontrados[].lancamentos[].nJurosdecimalJuros para o título
titulosEncontrados[].lancamentos[].nMultadecimalMulta para o título
titulosEncontrados[].lancamentos[].nValLancdecimalValor do Lançamento
titulosEncontrados[].resumoobjetoResumo dos pagamentos realizados para o título
titulosEncontrados[].resumo.cLiquidadotextoIndica 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.nDescontodecimalValor do Desconto.
titulosEncontrados[].resumo.nJurosdecimalValor do Juros.
titulosEncontrados[].resumo.nMultadecimalValor da Multa.
titulosEncontrados[].resumo.nValAbertodecimalValor total em aberto para o título.
titulosEncontrados[].resumo.nValLiquidodecimalValor líquido (nValPago - nDesconto + Juros + nMulta)
titulosEncontrados[].resumo.nValPagodecimalValor 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}]}'