Método | URL |
---|---|
https://BASE_URL/recebiveis/lotes/{idLote}/titulos |
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"
},
"lastro": {
"numeroNotaFiscal": "123456789",
"numeroSerieNotaFiscal": "001",
"chaveNfe": "12345678901234567890123456789012345678901234",
"chaveAcessoNfe": "",
"inscricaoMunicipal": "",
"codigoMunicipioIBGE": "",
"dataEmissao": "2024-11-28",
"dataVencimento": "2024-12-28",
"valorTotal": 1000.5,
"tipoLastroPerformado": "BP"
}
}
]
}
Response Body
{
"status": "sucesso",
"mensagem": "10 registros inseridos com sucesso."
}
Modelo de dados¶
Requisição¶
Campo | Tipo | Descrição |
---|---|---|
titulos | Lista de Títulos | Lista dos títulos a serem cedidos. |
Título¶
Campo | Tipo | Descrição |
---|---|---|
numeroControleParticipante | Texto | Número de controle do participante (Id interno utilizado no seu ERP) |
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 |
agenciaDepositaria | Número | Agência depositária do banco de cobrança |
especie | Texto | DM - Duplicata Mercantil UR - Unidade de recebível |
jurosMoraDiaAtraso | Decimal | Juros aplicados por dia de atraso |
valorAbatimento | Decimal | Valor de desconto aplicado ao título |
tags | Lista de Texto | Tags associadas ao título |
sacado | Sacado | Informações do pagador |
lastro | Lastro | Informações do lastro (Nota Fiscal) |
Sacado¶
Campo | Tipo | Descrição |
---|---|---|
tipoPessoa | Número | 1 - Pessoa Física 2 - Pessoa Jurídica |
cpfCnpj | Texto | Documento do Sacado (CPF ou CNPJ) |
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 |
Lastro¶
Campo | Tipo | Descrição |
---|---|---|
numeroNotaFiscal | Texto | Número da nota fiscal |
numeroSerieNotaFiscal | Texto | 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 |
dataVencimento | Data | Data de vencimento da nota fiscal |
valorTotal | Número | Valor total da nota fiscal |
tipoLastroPerformado | Texto | SN - Serviços não Performado SP - Serviços performado BN - Bens não performado BP - Bens performado MN - Bens serviços não performado MP - Bens serviços performado |
Retorno¶
Campo | Tipo | Descrição |
---|---|---|
status | Texto | Status de sucesso |
mensagem | Texto | Mensagem de sucesso |