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

Adiciona um ou mais títulos a um lote de cessão existente.

Path Params

Campo Tipo Descrição
idLote Número Identificador do lote.
Request Body
{
  "titulos": [
    {
      "numeroControleParticipante": "0001",
      "numeroDocumento": "12345",
      "dataEmissao": "2024-11-28",
      "dataVencimento": "2024-12-28",
      "valorNominal": 1000.5,
      "valorAquisicao": 900.78,
      "bancoCobranca": 123,
      "agenciaDepositaria": 4567,
      "especie": "DM",
      "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": "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": "4202404",
        "dataEmissao": "2024-11-28",
        "valorTotal": 1000.5,
        "tipoLastroPerformado": "BP",
        "quantidadeParcelas": 1
      }
    }
  ]
}
Response Body — 200 OK
{
  "status": "sucesso",
  "mensagem": "1 título(s) inserido(s) com sucesso.",
  "titulos": null
}

Modelo de dados

Requisição

Campo Tipo Descrição
titulos Lista de Título Lista de títulos a serem adicionados ao lote.

Título

Campo Tipo Descrição
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 original do título.
valorAquisicao Decimal Valor de aquisição do título.
bancoCobranca Número Código do banco responsável pela cobrança. Campo opcional.
agenciaDepositaria Número Agência depositária do banco de cobrança. Campo opcional.
especie Texto Espécie do título conforme combinado para a integração.
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.

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 Unidade federativa do sacado.
email Texto E-mail do sacado. Campo opcional.
telefone Texto Telefone do sacado. Campo opcional.
numero Número Número do endereço. Campo opcional.
bairro Texto Bairro. Campo opcional.
complemento Texto Complemento do endereço. Campo opcional.

Lastro

Campo Tipo Descrição
numeroNotaFiscal Número Número da nota fiscal. Campo opcional.
numeroSerieNotaFiscal Número Número de série da nota fiscal. Campo opcional.
chaveNfe Texto Chave da nota fiscal eletrônica.
chaveAcessoNfe Texto Chave de acesso da NF-e. Campo opcional.
inscricaoMunicipal Texto Inscrição municipal. Campo opcional.
codigoMunicipioIBGE Texto Código do município segundo o IBGE. Campo opcional.
dataEmissao Data Data de emissão da nota fiscal.
valorTotal Decimal Valor total da nota fiscal.
tipoLastroPerformado Texto Tipo do lastro performado conforme combinado para a integração.
quantidadeParcelas Número Quantidade de parcelas vinculadas ao lastro. Campo opcional.

Retorno

Campo Tipo Descrição
status Texto Status do processamento.
mensagem Texto Mensagem retornada pela API.
titulos Lista de Título inválido Lista preenchida quando houver inconsistências por título.

Título inválido

Campo Tipo Descrição
regra Texto Regra de validação que rejeitou o título.
quantidadeOcorrencia Número Quantidade de ocorrências da regra.
numeroDocumento Texto Número do documento rejeitado.
dataEmissao Data Data de emissão informada.
dataVencimento Data Data de vencimento informada.
valorNominal Decimal Valor nominal informado.
especie Número Código da espécie do título.
documentoSacado Texto Documento do sacado informado.