URL/titulo
Estimated reading: 3 minutes
5 views
Parâmetros de Requisição (GET)
| Parâmetro | Descrição | Opcional |
|---|---|---|
idCartorio |
Recuperado após autenticação ou através do serviço URL/cartorio | X |
idApresentante |
Recuperado após autenticação ou através do serviço URL/apresentante | X |
identificador |
Número identificador do título | X |
numeroTitulo |
Número do título | X |
documentoDevedor |
Documento do devedor do título | X |
documentoCredor |
CPF/CNPJ do credor do título | X |
nomeCredor |
Nome do credor do título | X |
ocorrenciaRetorno |
Ocorrência do título, parâmetros de busca: protesto, pagamento, cacelamento, sustação, devolução, desistência | X |
dataRetorno |
Data do retorno | X |
dataRemessa |
Retorna apenas os títulos referentes à data de remessa informada. | X |
apenasDevedoresEnderecoCompleto |
Filtra títulos em que o apresentante informou um endereço de devedor maior que 45 caracteres (limite do layout FEBRABAN) | X |
apenasTitulosDadosComplementares |
Retorna apenas os títulos que possuem dados complementares (telefone e e-mail) do devedor. |
Exemplo de Resposta
{
"_links": {
"self": {
"href": "http://craUF.api.crabr.com.br/titulo?idCartorio=&numeroTitulo=&documentoDevedor=00000000000&ocorrenciaRetorno=protesto"
}
},
"_embedded": {
"titulo": [
{
"id": 1,
"numeroTitulo": "00000",
"nossoNumero": "000-00000000-0",
"protocolo": "0000000000",
"dataProtocolo": {
"date": "2017-01-18 00:00:00.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"dataEmissao": {
"date": "2016-12-07 00:00:00.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"dataVencimento": "00/00/2017",
"valor": "000.00",
"saldo": "000.00",
"especie": "DMI",
"descricaoEspecie": "Especie do título",
"endosso": "M",
"situacao": "RETORNADO",
"nomeSacador": "TESTE 123",
"tipoDocumentoSacador": "CNPJ",
"documentoSacador": "00000000000000",
"nomeCedente": "TESTE 123",
"devedores": [
{
"nome": "NOME DO DEVEDOR",
"tipoDocumento": "CPF",
"documento": "99999999999",
"telefone": [
"99999999"
],
"email": [
"email@email.com"
],
"endereco": {
"endereco": "80686-508, RUA EXEMPLO99999. BC. 2 AP. 999999",
"enderecoCompleto": "80686-508, RUA EXEMPLO99999. BC. 2 AP. 999999A ENDERECO COMPLETO 999, R. EXEMPLO999999. ANEXOJOSE D'OESTE - XX",
"bairro": "R. EXEMPLO 3. BC. 13",
"cep": 99999999,
"uf": "XX",
"cidade": "CIDADE EXEMPL"
}
}
],
"apresentante": {
"id": 11,
"nome": "APRESENTANTE",
"codigo": "999",
"endereco": {
"endereco": "Endereco de testes",
"bairro": "Centro",
"cep": "99999999",
"uf": "UF"
},
"telefones": [
"6199999999",
"61999999999"
],
"fax": ["61888888888"],
"emails": [
{
"id": 0,
"nome": "Email 1",
"email": "teste.@gmail.com"
},
{
"id": 1,
"nome": "Email 2",
"email": "teste.@gmail.com"
}
]
},
"cartorio": {
"id": 1,
"nome": "1º Ofício de testes",
"documento": "00000000000000",
"uf": "UF",
"tipo": "CARTORIO",
"codigo": "01",
"endereco": {
"endereco": "Avenida Francisco Raulino, 2061-A",
"bairro": "Centro",
"cep": "64290000",
"uf": "PI"
},
"telefones": [ "6100000000" ],
"fax": [ "6100000000" ],
"emails": [
{
"id": 1,
"nome": "NOME QUALQUER",
"email": "TESTE@TESTE.com.br"
}
],
"municipio": {
"id": 1,
"nome": "TESTELANDIA",
"codigo": "1234567"
}
},
"retornos": [
{
"id": 1234567,
"dataApresentante": {
"date": "2017-01-30 12:38:19.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"dataCartorio": {
"date": "2017-01-30 12:38:19.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"ocorrencia": {
"codigo": "2",
"descricao": "Protestado",
"data": {
"date": "2017-01-27 00:00:00.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
}
},
"valor": "000.00",
"saldo": "000.00",
"protocolo": "0000000000",
"dataProtocolo": {
"date": "2017-01-19 00:00:00.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"nossoNumero": "000-00000000-0",
"sequencial": "000001",
"status": "LIBERADO"
}
],
"confirmacao": {
"id": 0,
"dataConfirmacao": {
"date": "2017-01-18 11:41:35.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
}
},
"remessa": {
"id": 0,
"sequencial": "009999",
"nomeArquivo": "B9999999.181",
"data": {
"date": "2018-04-17 08:29:27.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
}
},
"custas":[
{
"tipo": "cancelamento",
"valor" : 10.34,
"vigencia": {
"date": "2022-04-17 08:29:27.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
}
},
{
"tipo": "desistencia",
"valor" : 25.69,
"vigencia": {
"date": "2022-04-17 08:29:27.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
}
}
],
"andamentos": [
{
"codigo": "AA",
"data": {
"date": "2024-10-08 19:05:45.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
}
},
{
"codigo": "AB",
"data": {
"date": "2024-10-09 11:18:32.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
}
}
],
"_links": {
"self": {
"href": "http://craUF.api.crabr.com.br/titulo/0000000000"
}
}
}
]
},
"total_items": 1
}