---
title: "Detalhes de uma recorrência de lançamentos"
method: GET
path: "/v1/lancamentos/recorrencias/{recorrenciaId}"
tags: ["Financeiro > Lançamentos"]
---

# Detalhes de uma recorrência de lançamentos

`GET /v1/lancamentos/recorrencias/{recorrenciaId}`

## Request

- Base URL: `https://api.trinks.com`
- URL: `https://api.trinks.com/v1/lancamentos/recorrencias/{recorrenciaId}`
- Auth: API key in header `X-Api-Key`

Retorna os detalhes completos de uma recorrência, incluindo:
- **Informações da recorrência**: ID, tipo (Mensalmente/Quinzenalmente/Semanalmente), número total de parcelas, datas de início e fim, forma de aplicar competência, status (ativa/inativa).
- **Lista de todas as parcelas**: Cada parcela inclui ID do lançamento, data de vencimento, data de competência, valor, status de pagamento (Pago/Não Pago), e se está ativa ou inativa.
            
**Uso típico:**
- Visualizar todas as parcelas de uma recorrência criada.
- Verificar quantas parcelas já foram pagas ou estão pendentes.
- Identificar parcelas inativadas individualmente.

## Path parameters

- `recorrenciaId` integer, required

## Headers

- `estabelecimentoId` string, required

## Response `200`

Success

- RecorrenciaDetailsDTO
  - `id` integer
  - `inicioRecorrencia` string, date-time
  - `fimRecorrencia` string, date-time, nullable
  - `tipoRecorrencia` integer
  - `tipoRecorrenciaNome` string, nullable
  - `formaDeAplicarCompetencia` integer, nullable
  - `formaDeAplicarCompetenciaNome` string, nullable
  - `numeroDeParcelasAtivas` integer
  - `numeroDeParcelasInativas` integer
  - `categoriaId` integer
  - `categoriaNome` string, nullable
  - `ativo` boolean
  - `parcelas` ParcelaRecorrenciaDTO[], nullable
    - `lancamentoId` integer
    - `dataVencimento` string, date-time
    - `dataPagamento` string, date-time, nullable
    - `dataCompetencia` string, date-time, nullable
    - `descricao` string, nullable
    - `valor` number, double
    - `status` 1 | 2
    - `statusNome` string, nullable
    - `ativo` boolean

## Other responses

- `404`: Not Found

---

[API](https://skmtc.dev/trinks/apis/trinks-api.md) - [All operations](https://skmtc.dev/trinks/apis/trinks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trinks/apis/trinks-api/revisions/1b5b1e3825ef?raw)
