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

Consulta os títulos vinculados a um lote específico, incluindo o status de processamento de cada título dentro do lote.

Path Params

Campo Tipo Descrição
idLote Número Identificador do lote.
Response Body — 200 OK
[
  {
    "id": 2001,
    "numeroControleParticipante": "0001",
    "numeroDocumento": "12345",
    "dataEmissao": "2024-11-28",
    "dataVencimento": "2024-12-28",
    "valorNominal": 1000.5,
    "valorAquisicao": 900.78,
    "bancoCobranca": 123,
    "agenciaCobranca": 4567,
    "especie": "Duplicata",
    "status": 1,
    "motivoRejeicao": null,
    "jurosMoraDiaAtraso": 0.5,
    "valorAbatimento": 20,
    "tags": ["CC01", "RATING_A"],
    "sacado": {
      "tipoPessoa": 2,
      "cpfCnpj": "12345678000199",
      "nome": "Sacado I",
      "cep": "12345678",
      "endereco": "Rua dos Sacados, 1000",
      "cidade": "Blumenau",
      "uf": "Santa Catarina (SC)",
      "email": "financeiro@sacado.com.br",
      "telefone": "47999990000",
      "numero": 1000,
      "bairro": "Centro",
      "complemento": "Sala 1"
    },
    "lastro": {
      "numeroNotaFiscal": 123456789,
      "numeroSerieNotaFiscal": 1,
      "chaveNfe": "12345678901234567890123456789012345678901234",
      "chaveAcessoNfe": "",
      "inscricaoMunicipal": "",
      "codigoMunicipioIBGE": "",
      "dataEmissao": "2024-11-28",
      "valorTotal": 1000.5,
      "tipoLastroPerformado": "Bens performado",
      "quantidadeParcelas": 1
    }
  }
]
Response Body — 400 Bad Request
{
  "status": "erro",
  "mensagem": "Mensagem retornada pela API.",
  "titulos": null
}

Modelo de dados

Retorno

O retorno é uma lista de títulos do lote.

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.
dataEmissao Data Data de emissão do título.
dataVencimento Data Data de vencimento do título.
valorNominal Decimal Valor nominal do título.
valorAquisicao Decimal Valor de aquisição do título no lote.
bancoCobranca Número Código do banco de cobrança.
agenciaCobranca Número Agência de cobrança.
especie Texto Descrição da espécie do título (ex.: Duplicata, UR, CCB Pré Digital).
status Número Status do título no lote. Ver Status do título no lote.
motivoRejeicao Texto Motivo da rejeição, quando status = 2.
jurosMoraDiaAtraso Decimal Juros aplicados por dia de atraso.
valorAbatimento Decimal Valor de abatimento do título.
tags Lista de texto Tags associadas ao título.
sacado Sacado Dados do pagador.
lastro Lastro Dados do lastro do título.

Status do título no lote

Código Status Descrição
0 Em Análise Título em análise pelas regras de elegibilidade.
1 Aprovado Título aprovado nas regras.
2 Rejeitado Título rejeitado. Ver motivoRejeicao.

Sacado

Campo Tipo Descrição
tipoPessoa Número 1 = Pessoa Física, 2 = Pessoa Jurídica.
cpfCnpj Texto Documento do sacado, somente números.
nome Texto Nome do sacado.
cep Texto CEP do endereço.
endereco Texto Endereço do sacado.
cidade Texto Cidade do sacado.
uf Texto Descrição da unidade federativa (ex.: Santa Catarina (SC)).
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 do endereço.

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 nota fiscal eletrônica.
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 da nota fiscal.
valorTotal Decimal Valor total da nota fiscal.
tipoLastroPerformado Texto Descrição do tipo de lastro performado (ex.: Bens performado).
quantidadeParcelas Número Quantidade de parcelas vinculadas ao lastro.