> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.
# Atualizar um prazo
> Atualiza parcialmente um prazo e retorna a entidade persistida.
Esses endpoints permitem o gerenciamento de prazos no **Console**. Você também pode chamá-los diretamente para integrar prazos aos seus próprios sistemas.
## OpenAPI
````yaml pt/openapi/v3-current/reporter.yaml patch /v1/deadlines/{id}
openapi: 3.1.0
info:
contact:
name: Discord community
url: https://discord.gg/DnhqKwkGv3
description: >-
Esta é a documentação OpenAPI do Reporter. O binário unificado do Reporter
serve a API REST (RUN_MODE=api) e/ou o worker de geração de relatórios do
RabbitMQ (RUN_MODE=worker); RUN_MODE=all executa ambos em um único processo
para desenvolvimento local. Todos os endpoints REST documentados aqui são
servidos somente quando RUN_MODE=api ou all (porta :4005); o worker (porta
:4006) expõe apenas health/readyz.
license:
name: Lerian Studio General License
title: API do Midaz Reporter
version: 4.0.0
servers:
- url: http://localhost:4005
- url: https://localhost:4005
security:
- BearerAuth: []
tags:
- description: Instâncias de relatórios gerados e seu ciclo de vida.
name: Reports
- description: Definições reutilizáveis de relatórios.
name: Templates
- description: Construção interativa de templates de relatório.
name: Template Builder
- description: Acompanhamento de datas de vencimento de relatórios agendados.
name: Deadlines
- description: Entradas configuradas que fornecem dados para relatórios.
name: Data Sources
- description: Métricas agregadas de relatórios.
name: Metrics
- description: Catálogo de eventos de negócio publicados e políticas de entrega.
name: Streaming
paths:
/v1/deadlines/{id}:
patch:
tags:
- Deadlines
summary: Atualizar um prazo
description: Atualiza parcialmente um prazo e retorna a entidade persistida.
operationId: updateDeadline
parameters:
- description: Identificador único do prazo.
example: 00000000-0000-0000-0000-000000000001
in: path
name: id
required: true
schema:
description: Identificador único do prazo.
type: string
requestBody:
content:
application/json:
schema:
properties:
active:
description: Estado ativo atualizado.
examples:
- false
type: boolean
color:
description: Cor hexadecimal atualizada.
examples:
- '#00FF00'
type: string
description:
description: Descrição do prazo atualizada.
examples:
- Updated description
type: string
dueDate:
description: Data e hora de vencimento do prazo atualizadas.
examples:
- '2026-06-30T23:59:59Z'
format: date-time
type: string
frequency:
description: Frequência de recorrência atualizada.
examples:
- annual
type: string
monthsOfYear:
description: Meses de recorrência atualizados.
examples:
- - 6
items:
format: int64
type: integer
type:
- array
- 'null'
name:
description: Nome legível do prazo atualizado.
examples:
- Updated Report Name
type: string
notifyDaysBefore:
description: Antecedência de notificação atualizada, em dias.
examples:
- 10
format: int64
type: integer
templateId:
description: Identificador do template atualizado.
examples:
- 00000000-0000-0000-0000-000000000001
type: string
type:
description: Categoria do prazo atualizada.
examples:
- custom
type: string
type: object
description: Payload JSON da requisição.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Deadline'
description: OK
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Detail'
description: Requisição inválida
'401':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Detail'
description: Não autorizado
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Detail'
description: Proibido
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Detail'
description: Não encontrado
'409':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Detail'
description: Conflito
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Detail'
description: Entidade não processável
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Detail'
description: Erro interno do servidor
components:
schemas:
Deadline:
properties:
active:
description: Se o prazo está ativo.
examples:
- true
type: boolean
color:
description: Cor hexadecimal usada para identificar o prazo.
examples:
- '#FF5733'
type: string
createdAt:
description: Data e hora em que o prazo foi criado.
examples:
- '2026-01-01T00:00:00Z'
format: date-time
type: string
deliveredAt:
description: Data e hora em que o prazo foi entregue.
examples:
- '2026-03-15T10:00:00Z'
format: date-time
type: string
description:
description: Descrição opcional do prazo.
examples:
- Monthly regulatory compliance report
type: string
dueDate:
description: Data e hora de vencimento do prazo.
examples:
- '2026-03-31T23:59:59Z'
format: date-time
type: string
frequency:
description: Frequência de recorrência do prazo.
examples:
- monthly
type: string
id:
description: Identificador único do prazo.
examples:
- 00000000-0000-0000-0000-000000000000
type: string
monthsOfYear:
description: Meses em que ocorre um prazo semestral ou anual.
examples:
- - 1
- 6
items:
format: int64
type: integer
type:
- array
- 'null'
name:
description: Nome legível do prazo.
examples:
- Monthly Regulatory Report
type: string
notifyDaysBefore:
description: >-
Quantidade de dias antes da data de vencimento em que as
notificações começam.
examples:
- 5
format: int64
type: integer
status:
description: Status derivado atual do prazo.
examples:
- pending
type: string
templateId:
description: Template usado para gerar o relatório.
examples:
- 00000000-0000-0000-0000-000000000000
type: string
templateName:
description: Nome legível do template associado.
examples:
- Financial Template
type: string
type:
description: Categoria do prazo.
examples:
- regulatory
type: string
updatedAt:
description: Data e hora da última atualização do prazo.
examples:
- '2026-01-01T00:00:00Z'
format: date-time
type: string
type: object
Detail:
properties:
code:
description: >-
Código de erro de domínio estável e legível por máquina, no escopo
do serviço emissor (formato: -NNNN).
examples:
- ERR-0001
type: string
detail:
description: Explicação legível específica para esta ocorrência do problema.
examples:
- Property foo is required but is missing.
type: string
errors:
description: Lista opcional de detalhes individuais do erro
examples:
- - location: body.templateId
message: expected string to match 'uuid' format
value: not-a-uuid
items:
$ref: '#/components/schemas/ErrorDetail'
type:
- array
- 'null'
instance:
description: Referência URI que identifica a ocorrência específica do problema.
examples:
- https://example.com/error-log/abc123
format: uri
type: string
status:
description: Código de status HTTP
examples:
- 400
format: int64
type: integer
title:
description: >-
Resumo curto e legível do tipo de problema. Esse valor não deve
mudar entre ocorrências do erro.
examples:
- Bad Request
type: string
type:
default: about:blank
description: Referência URI para a documentação legível do erro.
examples:
- https://example.com/errors/example
format: uri
type: string
type: object
ErrorDetail:
properties:
location:
description: >-
Local em que o erro ocorreu, por exemplo, 'body.items[3].tags' ou
'path.thing-id'
examples:
- body.templateId
type: string
message:
description: Texto da mensagem de erro
examples:
- expected string to match 'uuid' format
type: string
value:
description: O valor no local informado
examples:
- not-a-uuid
type: object
securitySchemes:
BearerAuth:
bearerFormat: JWT
description: Token bearer JWT emitido pelo provedor de identidade.
scheme: bearer
type: http
````