Financeiro > Lançamentos

Detalhes de uma recorrência de lançamentos

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.
get/v1/lancamentos/recorrencias/{recorrenciaId}

Request

  • Base URL
    https://api.trinks.com
  • Auth
    API key in header X-Api-Key

Path parameters

recorrenciaIdinteger required

Headers

estabelecimentoIdstring required

Response

Success

idinteger
inicioRecorrenciastring date-time
fimRecorrenciastring date-time nullable
tipoRecorrenciainteger
tipoRecorrenciaNomestring nullable
formaDeAplicarCompetenciainteger nullable
formaDeAplicarCompetenciaNomestring nullable
numeroDeParcelasAtivasinteger
numeroDeParcelasInativasinteger
categoriaIdinteger
categoriaNomestring nullable
ativoboolean

Changes

No recorded changes to this operation across all 1 revision of this API.