Ir para o conteúdo
Método URL
GET https://BASE_URL/public/v1/recebiveis/titulos

Consulta títulos disponíveis em estoque. O retorno é paginado.

Query Params

Campo Tipo Descrição
IdOperacao Número Identificador da operação.
IdCessionario Número Identificador do cessionário.
IdEmpresa Número Identificador da empresa cedente.
SacadoOuNfe Texto Busca por dados do sacado ou NF-e.
IdSacado Número Identificador do sacado.
NomeSacado Texto Nome do sacado.
NumeroDocumento Texto Número do documento.
DataImportacaoInicio Data Data inicial de importação.
DataImportacaoFim Data Data final de importação.
DataAquisicaoInicio Data Data inicial de aquisição.
DataAquisicaoFim Data Data final de aquisição.
DataVencimentoInicio Data Data inicial de vencimento.
DataVencimentoFim Data Data final de vencimento.
DataVencimento Data Data exata de vencimento.
DiasVencimento Número Quantidade de dias até o vencimento.
DataLiquidacaoInicio Data Data inicial de liquidação.
DataLiquidacaoFim Data Data final de liquidação.
EspeciesTitulo Lista de números Códigos das espécies dos títulos.
IdsCredenciadoras Lista de números Identificadores das credenciadoras.
IdsArranjosPagamento Lista de números Identificadores dos arranjos de pagamento.
PossuiLastro Booleano Indica se o título possui lastro.
LastroPerformado Booleano Indica se o lastro é performado.
NumeroNotaFiscalInicio Número Número inicial da nota fiscal.
NumeroNotaFiscalFim Número Número final da nota fiscal.
NumeroSerieNotaFiscalInicio Número Série inicial da nota fiscal.
NumeroSerieNotaFiscalFim Número Série final da nota fiscal.
ValorNominalMin Decimal Valor nominal mínimo.
ValorNominalMax Decimal Valor nominal máximo.
ValorNominal Decimal Valor nominal exato.
ValorPresenteMin Decimal Valor presente mínimo.
ValorPresenteMax Decimal Valor presente máximo.
ValorPresente Decimal Valor presente exato.
ValorAquisicaoMin Decimal Valor de aquisição mínimo.
ValorAquisicaoMax Decimal Valor de aquisição máximo.
ValorPagoMin Decimal Valor pago mínimo.
ValorPagoMax Decimal Valor pago máximo.
ValorSaldoDevedor Decimal Valor de saldo devedor.
PrazoAtualInicio Número Prazo atual mínimo.
PrazoAtualFim Número Prazo atual máximo.
PrazoAquisicaoInicio Número Prazo de aquisição mínimo.
PrazoAquisicaoFim Número Prazo de aquisição máximo.
Status Texto Status do título conforme filtro disponível na API.
Ordem Texto Campo usado para ordenação.
DirecaoOrdem Texto Direção da ordenação.
SiglaArranjo Texto Sigla do arranjo de pagamento.
CnpjCedente Texto CNPJ do cedente.
NomeCedente Texto Nome do cedente.
TipoRecebivel Texto Tipo do recebível.
CpfCnpjSacado Texto CPF ou CNPJ do sacado.
DemonstrarLiquidados Booleano Indica se títulos liquidados devem ser exibidos.
IndicePagina Número Índice da página.
TamanhoDaPagina Número Quantidade de registros por página.
Response Body — 200 OK
{
  "registros": [
    {
      "id": 1,
      "numeroControleParticipante": "CTRL-001",
      "numeroDocumento": "DOC-123456",
      "nossoNumero": "00012345",
      "dataEmissao": "2025-01-10",
      "dataVencimento": "2025-04-10",
      "bancoCobranca": 341,
      "agenciaCobranca": 1234,
      "especie": 2,
      "jurosMoraDia": 0.033,
      "valorAbatimento": 50,
      "tags": [],
      "sacado": {
        "tipoPessoa": 2,
        "cpfCnpj": "12345678000199",
        "nome": "Empresa Sacado LTDA",
        "cep": "01310100",
        "endereco": "Avenida Paulista",
        "cidade": "São Paulo",
        "uf": "SP",
        "email": "financeiro@sacado.com.br",
        "telefone": "11999990000",
        "numero": 1000,
        "bairro": "Bela Vista",
        "complemento": "Sala 42"
      },
      "cedente": {
        "nome": "Cedente Comércio S.A.",
        "cnpj": "98765432000111"
      },
      "lastro": {
        "numeroNotaFiscal": 9871,
        "numeroSerieNotaFiscal": 1,
        "chaveNfe": "NFe35250112345678000199550010000098711000012345",
        "chaveAcessoNfe": "",
        "inscricaoMunicipal": "",
        "codigoMunicipioIBGE": "3550308",
        "dataEmissao": "2025-01-08",
        "valorTotal": 15000,
        "tipoLastroPerformado": 3
      },
      "lotes": [
        {
          "idLote": 987,
          "status": 4,
          "ocorrencia": 1
        }
      ],
      "dataVencimentoAjustada": "2025-04-11",
      "dataLiquidacao": null,
      "valorPresente": 14200,
      "valorDespesa": 120,
      "valorDesconto": 300,
      "valorNominal": 15000,
      "valorAquisicao": 14500,
      "valorPago": null,
      "prazoAtual": 79,
      "dataAquisicao": "2025-01-11",
      "prazoAquisicao": 89,
      "valorSaldoDevedor": 15000,
      "valorMulta": null,
      "taxaDesagio": 2.5,
      "numeroCodigoBarras": null,
      "numeroLinhaDigitavel": null,
      "numeroParcela": 1,
      "numeroTotalParcelas": 1,
      "arranjoPagamento": null,
      "tickerSymbol": null,
      "codigoIpoc": null
    }
  ],
  "paginacao": {
    "paginaAtual": 1,
    "paginaTotal": 1,
    "paginaQuantidadeRegistro": 1,
    "quantidadeRegistros": 1,
    "temPaginaAnterior": false,
    "temProximaPagina": false
  },
  "mensagem": null
}

Modelo de dados

Retorno

Campo Tipo Descrição
registros Lista de Título Títulos retornados na página atual.
paginacao Paginação Dados de paginação.
mensagem Texto Mensagem complementar da consulta.

Título

Campo Tipo Descrição
id Número Identificador do título.
numeroControleParticipante Texto Número de controle do participante.
numeroDocumento Texto Número do documento.
nossoNumero Texto Nosso número.
dataEmissao Data Data de emissão do título.
dataVencimento Data Data de vencimento do título.
bancoCobranca Número Código do banco de cobrança.
agenciaCobranca Número Código da agência de cobrança.
especie Número Código da espécie do título. Ver Espécies de título.
jurosMoraDia Decimal Juros de mora por dia.
valorAbatimento Decimal Valor de abatimento.
tags Lista de texto Tags associadas ao título.
sacado Sacado Dados do sacado.
cedente Cedente Dados do cedente.
lastro Lastro Dados do lastro.
lotes Lista de Lote do título Lotes aos quais o título está vinculado.
dataVencimentoAjustada Data Data de vencimento ajustada.
dataLiquidacao Data Data de liquidação.
valorPresente Decimal Valor presente do título.
valorDespesa Decimal Valor de despesa.
valorDesconto Decimal Valor de desconto.
valorNominal Decimal Valor nominal do título.
valorAquisicao Decimal Valor de aquisição do título.
valorPago Decimal Valor pago.
prazoAtual Número Prazo atual em dias.
dataAquisicao Data Data de aquisição.
prazoAquisicao Número Prazo de aquisição em dias.
valorSaldoDevedor Decimal Valor de saldo devedor.
valorMulta Decimal Valor de multa.
taxaDesagio Decimal Taxa de deságio.
numeroCodigoBarras Texto Código de barras.
numeroLinhaDigitavel Texto Linha digitável.
numeroParcela Número Número da parcela.
numeroTotalParcelas Número Número total de parcelas.
arranjoPagamento Texto Arranjo de pagamento.
tickerSymbol Texto Ticker associado ao título.
codigoIpoc Texto Código IPOC.

Lote do título

Campo Tipo Descrição
idLote Número Identificador do lote vinculado ao título.
status Número Código do status do lote. Ver a seção Status na página Consultar Lote.
ocorrencia Número Código da ocorrência do lote. Ver a seção Ocorrências na página Consultar Lote.

Sacado

Campo Tipo Descrição
tipoPessoa Número 1 = Pessoa Física, 2 = Pessoa Jurídica.
cpfCnpj Texto CPF ou CNPJ do sacado.
nome Texto Nome do sacado.
cep Texto CEP do sacado.
endereco Texto Endereço do sacado.
cidade Texto Cidade do sacado.
uf Texto UF do sacado.
email Texto E-mail do sacado.
telefone Texto Telefone do sacado.
numero Número Número do endereço.
bairro Texto Bairro.
complemento Texto Complemento.

Cedente

Campo Tipo Descrição
nome Texto Nome da empresa cedente.
cnpj Texto CNPJ da empresa cedente.

Lastro

Campo Tipo Descrição
numeroNotaFiscal Número Número da nota fiscal.
numeroSerieNotaFiscal Número Número de série da nota fiscal.
chaveNfe Texto Chave da NF-e.
chaveAcessoNfe Texto Chave de acesso da NF-e.
inscricaoMunicipal Texto Inscrição municipal.
codigoMunicipioIBGE Texto Código do município segundo o IBGE.
dataEmissao Data Data de emissão do lastro.
valorTotal Decimal Valor total do lastro.
tipoLastroPerformado Número Código do tipo de lastro performado.

Paginação

Campo Tipo Descrição
paginaAtual Número Página atual.
paginaTotal Número Total de páginas.
paginaQuantidadeRegistro Número Quantidade de registros na página.
quantidadeRegistros Número Quantidade total de registros.
temPaginaAnterior Booleano Indica se existe página anterior.
temProximaPagina Booleano Indica se existe próxima página.

Espécies de título

Código Espécie
2 Duplicata Mercantil
3 Unidade Recebível
4 Nota Fiscal Serviço
5 Nota de Débito
6 CCB Pré Digital
8 Nota Promissória
9 Nota Comercial