---
title: "Consulta protestos filtrando por data de inclusão e situação"
method: GET
path: "/api/ConsultaProtesto"
tags: ["Protesto"]
---

# Consulta protestos filtrando por data de inclusão e situação

`GET /api/ConsultaProtesto`

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.

## Query parameters

- `DataInicial` string, date-time, required
- `DataFinal` string, date-time, required
- `Situacao` string
- `TituloID` integer
- `Start` integer
- `Size` integer

## Headers

- `Aeskey` string, required

## Response `200`

Consulta realizada com sucesso

- BknBankPagamentosBusinessProtestoDtoProtestoResponseDto[]
  - `Id` string, uuid
  - `TransacaoId` string, uuid
  - `ClienteId` string, uuid
  - `Tipo` integer
  - `TituloID` integer
  - `Identificador` string
  - `DataEmissao` string, date-time
  - `DataInclusao` string, date-time
  - `DataCriacao` string, date-time
  - `DataVencimento` string, date-time
  - `Situacao` string
  - `ValorTotal` number, double
  - `ValorSaldo` number, double
  - `ValorTaxas` number, double
  - `TipoDescricao` string
  - `ClienteNome` string
  - `CredorNome` string
  - `DevedorNome` string
  - `Descricao` string
  - `VencimentoTransacao` string, date-time
  - `CobrancaId` string, uuid
  - `Ativo` boolean
  - `MotivoRejeicao` string
  - `DescricaoMotivoRejeicao` string
  - `DescricaoErro` string
  - `SituacaoAmigavel` string
  - `SituacaoDetalhada` string
  - `GrupoStatus` 'Preparacao' | 'EmProcessamento' | 'EmCartorio' | 'EncerradoPago' | 'EncerradoProtestado' | 'EncerradoDevolvidoImpedido' | 'EncerradoRetirado' | 'EncerradoCancelado' | 'Judicial'
  - `NomeGrupo` string
  - `SituacaoCompleta` string
  - `ClasseBadge` string
  - `HtmlTooltipMotivoRejeicao` string

## Other responses

- `400` — Parâmetros obrigatórios ausentes ou inválidos
- `401` — Não autorizado
- `403` — Acesso proibido
- `404` — Nenhum protesto encontrado com os filtros informados
- `500` — Erro interno no servidor

---

[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)