v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBProtesto
Consulta protestos filtrando por data de inclusão e situação
Esta rota permite consultar uma lista de protestos filtrando por data de inclusão (dataInicial e dataFinal) e, opcionalmente, pela situação do protesto.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| DataInicial | Data | Data inicial da inclusão do protesto (formato yyyy-MM-dd) | Sim |
| DataFinal | Data | Data final da inclusão do protesto (formato yyyy-MM-dd) | Sim |
| Situacao | Texto | Situação do protesto | Não |
| TituloID | Numérico | Número do título (busca exata) | Não |
| Start | Numérico | Índice de paginação inicial (default: 0) | Não |
| Size | Numérico | Tamanho da página (default: 10) | Não |
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. |
get/api/ConsultaProtesto
Query parameters
DataInicialstring date-time required
DataFinalstring date-time required
Situacaostring
TituloIDinteger
Startinteger
Sizeinteger
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"
}
]