v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBProtesto
Consulta um protesto por TituloID
Esta rota permite consultar os dados de um protesto específico a partir do identificador do título.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| TituloId | Numérico | Identificador do título | Sim |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| TransacaoId | Guid | Identificador da transação relacionada |
| ClienteId | Guid | Identificador do cliente proprietário |
| Tipo | Numérico | Tipo do título/protesto |
| TituloID | Numérico | Identificador do título registrado |
| Identificador | Texto | Referência externa atribuída ao título |
| DataEmissao | Data | Data de emissão do título |
| DataInclusao | Data | Data em que o protesto foi incluído no sistema |
| Situacao | Texto | Situação atual do protesto |
| ValorTotal | Numérico com 2 decimais | Valor total do título |
| ValorSaldo | Numérico com 2 decimais | Valor de saldo pendente do título |
| ValorTaxas | Numérico com 2 decimais | Valor total das taxas associadas |
| TipoDescricao | Texto | Descrição amigável do tipo de título/protesto. |
Observações
- O campo id representa o identificador do título (TituloID) e é obrigatório.
- Se não for encontrado nenhum protesto com o id informado, a resposta será 404 (não encontrado).
get/api/ConsultaProtestoPorId
Query parameters
TituloIdinteger required
Headers
Aeskeystring required
Response
Consulta realizada com sucesso
Example response
{
"Id": "00000000-0000-0000-0000-000000000000",
"TransacaoId": "00000000-0000-0000-0000-000000000000",
"ClienteId": "00000000-0000-0000-0000-000000000000",
"CobrancaId": "00000000-0000-0000-0000-000000000000"
}