{"openapi":"3.1.0","info":{"title":"Juridiq API — Documentação para Integradores","description":"API REST para integradores autenticados com chave (`x-juridiq-api-key`).\n\n## Rate limit\n\nA API aberta limita **240 requisições a cada 60s por chave**.\nO escritório também tem um limite conjunto de **240 requisições por minuto** e **15000 por dia** (renova à 00h de Brasília), somando todas as suas chaves. Os gestores e os donos das chaves recebem e-mail aos 50% da cota diária e quando houver bloqueio.\nAo exceder, a resposta é `429 Too Many Requests` com os headers `x-ratelimit-limit`, `x-ratelimit-remaining`, `x-ratelimit-reset` e `retry-after`.\nRespeite o `retry-after` antes de tentar de novo. Sincronizações em lote devem paginar e tratar 429 com backoff.\n\n## Permissões\n\nCada chave segue as permissões do perfil de acesso escolhido ao gerá-la (visualizar, criar, editar e excluir por módulo), sem passar das que o perfil atual de quem a criou tem. Mudança no perfil vale na requisição seguinte.\nSem a permissão, a resposta é `403` com `translateMessage` dizendo a ação e o módulo (ex.: \"Esta chave não tem permissão para excluir tarefas\").\nExceção: com chave, privar processos e tarefas, mudar a privacidade deles e definir os pontos ao criar tarefa não são checados; registros privados, contas privadas, saldo e as demais permissões específicas seguem quem criou a chave.","version":"1.0.0"},"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-juridiq-api-key","description":"Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a documentação de integradores)."}},"schemas":{}},"paths":{"/actionGroup/":{"get":{"summary":"Listar grupos de ação","tags":["Action Groups"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra por nome"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do grupo de ação"},"name":{"type":"string","description":"Nome"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","officeId","updatedAt","createdAt"],"additionalProperties":true},"description":"Lista de grupos de ação"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar grupo de ação","tags":["Action Groups"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome"}},"required":["name"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do grupo de ação"},"name":{"type":"string","description":"Nome"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","officeId","updatedAt","createdAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"delete":{"summary":"Excluir grupos de ação","tags":["Action Groups"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs dos grupos de ação"}},"required":["id"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/actionGroup/{id}":{"get":{"summary":"Buscar grupo de ação","tags":["Action Groups"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do grupo de ação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do grupo de ação"},"name":{"type":"string","description":"Nome"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","officeId","updatedAt","createdAt"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar grupo de ação","tags":["Action Groups"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome"}},"required":["name"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do grupo de ação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do grupo de ação"},"name":{"type":"string","description":"Nome"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","officeId","updatedAt","createdAt"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/comment/":{"get":{"summary":"Listar comentários de tarefa","tags":["Task Comments"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"taskId","required":true,"description":"ID da tarefa"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do comentário"},"content":{"type":"string","description":"Conteúdo"},"responsibleId":{"type":"string","format":"uuid","nullable":true,"description":"ID do responsável"},"responsibleName":{"type":"string","description":"Nome do responsável"},"responsibleAvatar":{"type":"string","nullable":true,"description":"Avatar do responsável"},"taskId":{"type":"string","format":"uuid","description":"ID da tarefa"},"replies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da resposta"},"content":{"type":"string","description":"Conteúdo"},"responsibleId":{"type":"string","format":"uuid","nullable":true,"description":"ID do responsável"},"responsibleName":{"type":"string","description":"Nome do responsável"},"responsibleAvatar":{"type":"string","nullable":true,"description":"Avatar do responsável"},"parentCommentId":{"type":"string","format":"uuid","description":"ID do comentário pai"},"taskId":{"type":"string","format":"uuid","description":"ID da tarefa"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","content","responsibleName","taskId","createdAt","updatedAt"],"additionalProperties":false},"description":"Respostas"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","content","responsibleName","taskId","replies","createdAt","updatedAt"],"additionalProperties":false},"description":"Comentários"}},"required":["data"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar comentário em tarefa","tags":["Task Comments"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","description":"Conteúdo do comentário em texto ou HTML, devolvido como enviado. Texto que já começa e termina com aspas duplas é tratado como delimitado e volta sem elas"},"taskId":{"type":"string","format":"uuid","description":"ID da tarefa"},"responsibleId":{"type":"string","format":"uuid","description":"Ignorado. O autor é sempre o usuário autenticado"},"parentCommentId":{"type":"string","format":"uuid","nullable":true,"description":"ID do comentário pai (resposta)"}},"required":["content","taskId"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do comentário"},"content":{"description":"Conteúdo"},"taskId":{"type":"string","format":"uuid","description":"ID da tarefa"},"responsibleId":{"type":"string","format":"uuid","nullable":true,"description":"ID do responsável"},"commentId":{"type":"string","format":"uuid","nullable":true,"description":"ID do comentário pai"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","taskId","createdAt","updatedAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/comment/{id}":{"patch":{"summary":"Atualizar comentário de tarefa","tags":["Task Comments"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","description":"Conteúdo do comentário em texto ou HTML, devolvido como enviado. Texto que já começa e termina com aspas duplas é tratado como delimitado e volta sem elas"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do comentário"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do comentário"},"content":{"description":"Conteúdo"},"taskId":{"type":"string","format":"uuid","description":"ID da tarefa"},"responsibleId":{"type":"string","format":"uuid","nullable":true,"description":"ID do responsável"},"commentId":{"type":"string","format":"uuid","nullable":true,"description":"ID do comentário pai"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","taskId","createdAt","updatedAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir comentário de tarefa","tags":["Task Comments"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do comentário"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/event/":{"get":{"summary":"Listar eventos","tags":["Events"],"description":"Eventos, tarefas e audiências do período. Sem filtro de processo ou pessoa, vale o compartilhamento de agenda de quem consulta (a chave de API consulta como o dono dela): compromisso de colega que não compartilha não vem; o de quem compartilha só livre/ocupado vem como \"Ocupado\" (`busy: true`): o conteúdo vem vazio (sem pessoas, processo, link, descrição e modalidade) e o evento trazido do Google vem na cor padrão. Gestor e Suporte veem tudo.","parameters":[{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"responsible","required":false,"description":"IDs dos responsáveis (vírgula ou repetido na query)"},{"schema":{"anyOf":[{"type":"string","enum":["true","false"]},{"type":"boolean"}]},"in":"query","name":"includeCreated","required":false,"description":"true inclui itens em que o filtrado é o dono, além de responsável ou participante"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"responsiblesMetrics","required":false,"description":"IDs para métricas (vírgula ou repetido na query)"},{"schema":{"type":"string"},"in":"query","name":"personId","required":false,"description":"Filtra por personId do evento/audiência"},{"schema":{"type":"string"},"in":"query","name":"lawSuitId","required":false,"description":"Filtra por processo"},{"schema":{"type":"string"},"in":"query","name":"workflowId","required":false,"description":"Filtra pela automação que criou o item"},{"schema":{"type":"string"},"in":"query","name":"workflowInstanceId","required":false,"description":"Filtra pela execução que criou o item"},{"schema":{"type":"string","enum":["initialDate","finalDate","all"]},"in":"query","name":"dateType","required":false,"description":"Campo de data para filtro"},{"schema":{"type":"string"},"in":"query","name":"start","required":false,"description":"Data inicial"},{"schema":{"type":"string"},"in":"query","name":"end","required":false,"description":"Data final"},{"schema":{"type":"string","enum":["all","completed","pending"],"default":"all"},"in":"query","name":"statusFilter","required":false,"description":"all = todas, completed = concluídas, pending = não concluídas"},{"schema":{"type":"string"},"in":"query","name":"fullQuery","required":false,"description":"true para resposta completa"},{"schema":{"type":"string"},"in":"query","name":"includeFutureCount","required":false,"description":"true para incluir eventsFuture (métricas); calendário não precisa"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"tag","required":false,"description":"IDs de tags"},{"schema":{"type":"string","enum":["all","tasks","events","audiences","google"],"default":"all"},"in":"query","name":"itemType","required":false,"description":"Filtro por tipo de item no calendário"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"taskPriority","required":false,"description":"Prioridades das tarefas"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"taskTag","required":false,"description":"IDs de etiquetas das tarefas"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"hiddenGoogleCalendarIds","required":false,"description":"Agendas do Google (até 100 ids, vírgula ou repetido) cujos eventos trazidos de lá saem da lista. Itens do Juridiq e eventos importados sem agenda continuam. Os ids vêm de GET /integration/google-calendar/calendars/enabled (login no painel; a chave de API não lista agendas)"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc"},{"schema":{"type":"string"},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação. date (data de ocorrência)"},{"schema":{"type":"integer","minimum":1},"in":"query","name":"page","required":false,"description":"Página (1-based)"},{"schema":{"type":"integer","minimum":1,"maximum":200},"in":"query","name":"limit","required":false,"description":"Limite por página (máx. 200)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do item"},"title":{"type":"string","description":"Título"},"start":{"type":"string","nullable":true,"description":"Início (ISO ou data)"},"end":{"type":"string","nullable":true,"description":"Fim (ISO ou data)"},"allDay":{"type":"boolean","nullable":true,"description":"Dia inteiro"},"textColor":{"type":"string","description":"Cor do texto"},"backgroundColor":{"type":"string","description":"Cor de fundo"},"borderColor":{"type":"string","description":"Cor da borda"},"classNames":{"type":"string","description":"Classes CSS do calendário"},"type":{"anyOf":[{"type":"string","enum":["event","task","audience","google-event","google-task"]},{"type":"string"}],"description":"Tipo do item"},"isPrivate":{"type":"boolean","description":"Privado"},"status":{"type":"string","nullable":true,"description":"Status"},"priority":{"type":"string","description":"Prioridade da tarefa"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name"],"additionalProperties":false},"description":"Etiquetas da tarefa"},"link":{"type":"string","description":"Link (Google)"},"initialHour":{"type":"string","description":"Hora inicial"},"finalHour":{"type":"string","description":"Hora final"},"date":{"type":"string","description":"Data"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"personIds":{"type":"array","items":{"type":"string"},"description":"IDs das pessoas vinculadas"},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false},"description":"Pessoas vinculadas"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa (fallback)"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Primeira pessoa vinculada (compatibilidade com listagens)"},"responsible":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome"},"avatar":{"type":"string","nullable":true,"description":"URL da foto"}},"required":["id","name"],"additionalProperties":false},"description":"Responsáveis / participantes"},"busy":{"type":"boolean","description":"Compromisso de colega que só compartilha livre/ocupado: título \"Ocupado\"; o conteúdo vem vazio (sem pessoas, processo, link, descrição e modalidade) e o evento trazido do Google vem na cor padrão"},"editable":{"type":"boolean","description":"false quando o item não se edita pelo painel: subtarefa, \"Ocupado\" ou agenda que não aceita edição de colegas (calculado fora das telas de processo e pessoa; a chave de API não segue a regra de escrita)"},"responsibleColor":{"type":"string","nullable":true,"description":"Cor da agenda do responsável (o primeiro com cor, preferindo os filtrados); só com fullQuery"}},"required":["id","type"],"additionalProperties":true},"description":"Itens do calendário"},"eventsFuture":{"type":"number","description":"Contagem de eventos futuros"},"totalResults":{"type":"number","description":"Total de itens antes da paginação"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar evento","tags":["Events"],"description":"Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os responsáveis compartilham \"Ver e editar\", e só entra responsável que compartilha \"Ver e editar\" (403 com o nome). Com chave de API a regra não vale.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Título"},"initialHour":{"type":"string","description":"Hora inicial"},"finalHour":{"type":"string","description":"Hora final"},"date":{"type":"string","description":"Data"},"responsibleIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos responsáveis. Precisam ser usuários do escritório da chave (senão 400)"},"description":{"type":"string","description":"Descrição"},"location":{"type":"string","description":"Local"},"lawSuitId":{"type":"string","format":"uuid","description":"ID do processo. Precisa ser do escritório da chave; processo de outro escritório ou inexistente: 404"},"personIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das pessoas"},"personId":{"type":"string","format":"uuid","description":"ID da pessoa (fallback de leitura/escrita)"},"consultingId":{"type":"string","format":"uuid","description":"ID do card do CRM"},"publicationMovementId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID da movimentação de publicação (o `id` de GET /publication) que originou o evento. Gravado como publicação de origem; movimentação de outro escritório ou inexistente: 404"},"allDay":{"type":"boolean","default":false,"description":"Dia inteiro"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório. Opcional; se enviado, precisa ser o escritório da chave (senão 403)"},"isPrivate":{"type":"boolean","default":false,"description":"Evento privado"},"remindClient":{"type":"boolean","description":"Enviar lembrete via WhatsApp (Jurichat) ao cliente do processo vinculado; sem processo, às pessoas vinculadas ao evento"},"points":{"type":"integer","minimum":0,"description":"Pontos"},"googleAttendees":{"type":"array","items":{"type":"string","format":"email"},"maxItems":50,"description":"E-mails convidados no Google Agenda"},"createMeet":{"type":"boolean","description":"Gerar link do Google Meet"},"sendUpdates":{"type":"string","enum":["none","all"],"description":"Enviar convite por e-mail aos convidados (padrão: none)"},"recurrence":{"type":"string","enum":["none","daily","weekly","monthly","weekdays"],"description":"Repetição do evento (padrão: none)"},"syncJurichat":{"type":"boolean","description":"Criar o evento também na agenda do Jurichat, no contato vinculado à primeira pessoa de `personIds` que tem vínculo (o vínculo mais antigo dela). O contato fica gravado no evento; edição por PATCH /event/:id e exclusão por DELETE /event passam a ser enviadas ao Jurichat. 409 quando nenhuma pessoa do evento tem contato vinculado ou a integração não está ativa; 400 em evento privado ou repetido. Se o envio falhar, o evento é salvo e a resposta traz `jurichatSyncError: true`; a próxima edição reenvia"}},"required":["title","initialHour","finalHour","date","responsibleIds"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do evento"},"title":{"type":"string","description":"Título"},"initialHour":{"type":"string","description":"Hora inicial"},"finalHour":{"type":"string","description":"Hora final"},"date":{"type":"string","description":"Data"},"allDay":{"type":"boolean","nullable":true,"description":"Dia inteiro"},"location":{"type":"string","nullable":true,"description":"Local"},"googleAttendees":{"type":"array","items":{"type":"string"},"description":"E-mails convidados no Google Agenda"},"meetLink":{"type":"string","nullable":true,"description":"Link do Google Meet"},"recurrence":{"type":"string","nullable":true,"description":"Repetição do evento"},"recurrenceGroupId":{"type":"string","nullable":true,"description":"ID da série de repetição"},"isPrivate":{"type":"boolean","description":"Evento privado"},"points":{"type":"number","nullable":true,"description":"Pontos"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"personIds":{"type":"array","items":{"type":"string"},"description":"IDs das pessoas"},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false},"description":"Pessoas vinculadas"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa (fallback)"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Primeira pessoa vinculada (compatibilidade)"},"responsible":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome"},"avatar":{"type":"string","nullable":true,"description":"URL da foto"}},"required":["id","name"],"additionalProperties":false},"description":"Responsáveis"},"consultingId":{"type":"string","nullable":true,"description":"ID do card do CRM"},"consulting":{"type":"object","properties":{"id":{"type":"string","description":"ID do card do CRM"},"subject":{"type":"string","description":"Assunto do card do CRM"}},"required":["id","subject"],"additionalProperties":false,"nullable":true,"description":"Card do CRM vinculado"},"jurichatContactId":{"type":"string","nullable":true,"description":"ID do contato do Jurichat em que o evento é mantido; null quando não é enviado"},"jurichatSynced":{"type":"boolean","description":"O evento existe no Jurichat: tem o ID do evento de lá gravado, ou o envio deste pedido foi concluído"},"jurichatSyncError":{"type":"boolean","description":"Só ao criar ou editar: o envio ao Jurichat feito neste pedido falhou"}},"required":["id","title","initialHour","finalHour","date"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir eventos","tags":["Events"],"description":"Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os responsáveis compartilham \"Ver e editar\" (403 com o nome). Com chave de API a regra não vale. Evento com contato do Jurichat gravado também é removido da agenda do Jurichat. Falha na remoção lá não impede a exclusão aqui.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs dos eventos"},"scope":{"type":"string","enum":["this","following","all"],"description":"Em evento repetido: só este, este e os seguintes ou todos (padrão: this)"}},"required":["id"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/event/{id}":{"get":{"summary":"Buscar evento","tags":["Events"],"description":"Evento sem processo nem pessoa da agenda de colega que não compartilha os detalhes responde 404 (a chave de API consulta como o dono dela). Gestor e Suporte veem tudo.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do evento"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do evento"},"title":{"type":"string","description":"Título"},"initialHour":{"type":"string","description":"Hora inicial"},"finalHour":{"type":"string","description":"Hora final"},"date":{"type":"string","description":"Data"},"allDay":{"type":"boolean","nullable":true,"description":"Dia inteiro"},"location":{"type":"string","nullable":true,"description":"Local"},"googleAttendees":{"type":"array","items":{"type":"string"},"description":"E-mails convidados no Google Agenda"},"meetLink":{"type":"string","nullable":true,"description":"Link do Google Meet"},"recurrence":{"type":"string","nullable":true,"description":"Repetição do evento"},"recurrenceGroupId":{"type":"string","nullable":true,"description":"ID da série de repetição"},"isPrivate":{"type":"boolean","description":"Evento privado"},"points":{"type":"number","nullable":true,"description":"Pontos"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"personIds":{"type":"array","items":{"type":"string"},"description":"IDs das pessoas"},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false},"description":"Pessoas vinculadas"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa (fallback)"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Primeira pessoa vinculada (compatibilidade)"},"responsible":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome"},"avatar":{"type":"string","nullable":true,"description":"URL da foto"}},"required":["id","name"],"additionalProperties":false},"description":"Responsáveis"},"consultingId":{"type":"string","nullable":true,"description":"ID do card do CRM"},"consulting":{"type":"object","properties":{"id":{"type":"string","description":"ID do card do CRM"},"subject":{"type":"string","description":"Assunto do card do CRM"}},"required":["id","subject"],"additionalProperties":false,"nullable":true,"description":"Card do CRM vinculado"},"jurichatContactId":{"type":"string","nullable":true,"description":"ID do contato do Jurichat em que o evento é mantido; null quando não é enviado"},"jurichatSynced":{"type":"boolean","description":"O evento existe no Jurichat: tem o ID do evento de lá gravado, ou o envio deste pedido foi concluído"},"jurichatSyncError":{"type":"boolean","description":"Só ao criar ou editar: o envio ao Jurichat feito neste pedido falhou"}},"required":["id","title","initialHour","finalHour","date"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar evento","tags":["Events"],"description":"Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os responsáveis compartilham \"Ver e editar\", e só entra responsável que compartilha \"Ver e editar\" (403 com o nome). Com chave de API a regra não vale.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"responsibleIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos responsáveis. Precisam ser usuários do escritório da chave (senão 400)"},"title":{"type":"string","description":"Título"},"description":{"type":"string","description":"Descrição"},"location":{"type":"string","description":"Local"},"lawSuitId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID do processo. `null` desvincula; ausente mantém o vínculo atual. Precisa ser do escritório da chave; processo de outro escritório ou inexistente: 404"},"personIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das pessoas"},"personId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID da pessoa (fallback de leitura/escrita)"},"consultingId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID do card do CRM. `null` desvincula; ausente mantém o vínculo atual"},"initialHour":{"type":"string","description":"Hora inicial"},"finalHour":{"type":"string","description":"Hora final"},"date":{"type":"string","description":"Data"},"allDay":{"type":"boolean","description":"Dia inteiro"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório. Opcional; se enviado, precisa ser o escritório da chave (senão 403)"},"isPrivate":{"type":"boolean","description":"Evento privado"},"completedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data de conclusão"},"remindClient":{"type":"boolean","description":"Enviar lembrete via WhatsApp (Jurichat) ao cliente do processo vinculado; sem processo, às pessoas vinculadas ao evento"},"points":{"type":"integer","minimum":0,"description":"Pontos"},"googleAttendees":{"type":"array","items":{"type":"string","format":"email"},"maxItems":50,"description":"E-mails convidados no Google Agenda"},"createMeet":{"type":"boolean","description":"Gerar link do Google Meet"},"sendUpdates":{"type":"string","enum":["none","all"],"description":"Enviar convite por e-mail aos convidados (padrão: none)"},"scope":{"type":"string","enum":["this","following","all"],"description":"Em evento repetido: só este, este e os seguintes ou todos (padrão: this)"},"syncJurichat":{"type":"boolean","description":"`true` em evento ainda sem contato do Jurichat grava o contato vinculado à primeira pessoa do evento que tem vínculo e envia o evento ao Jurichat (409 sem contato vinculado ou com a integração inativa; 400 em evento privado, repetido ou do Google); em evento que já tem contato, mantém o contato gravado e reenvia. `false` remove o evento do Jurichat e apaga o vínculo. Ausente mantém o estado: evento já vinculado é reenviado a cada edição, e torná-lo privado responde 400"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do evento"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do evento"},"title":{"type":"string","description":"Título"},"initialHour":{"type":"string","description":"Hora inicial"},"finalHour":{"type":"string","description":"Hora final"},"date":{"type":"string","description":"Data"},"allDay":{"type":"boolean","nullable":true,"description":"Dia inteiro"},"location":{"type":"string","nullable":true,"description":"Local"},"googleAttendees":{"type":"array","items":{"type":"string"},"description":"E-mails convidados no Google Agenda"},"meetLink":{"type":"string","nullable":true,"description":"Link do Google Meet"},"recurrence":{"type":"string","nullable":true,"description":"Repetição do evento"},"recurrenceGroupId":{"type":"string","nullable":true,"description":"ID da série de repetição"},"isPrivate":{"type":"boolean","description":"Evento privado"},"points":{"type":"number","nullable":true,"description":"Pontos"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"personIds":{"type":"array","items":{"type":"string"},"description":"IDs das pessoas"},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false},"description":"Pessoas vinculadas"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa (fallback)"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Primeira pessoa vinculada (compatibilidade)"},"responsible":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome"},"avatar":{"type":"string","nullable":true,"description":"URL da foto"}},"required":["id","name"],"additionalProperties":false},"description":"Responsáveis"},"consultingId":{"type":"string","nullable":true,"description":"ID do card do CRM"},"consulting":{"type":"object","properties":{"id":{"type":"string","description":"ID do card do CRM"},"subject":{"type":"string","description":"Assunto do card do CRM"}},"required":["id","subject"],"additionalProperties":false,"nullable":true,"description":"Card do CRM vinculado"},"jurichatContactId":{"type":"string","nullable":true,"description":"ID do contato do Jurichat em que o evento é mantido; null quando não é enviado"},"jurichatSynced":{"type":"boolean","description":"O evento existe no Jurichat: tem o ID do evento de lá gravado, ou o envio deste pedido foi concluído"},"jurichatSyncError":{"type":"boolean","description":"Só ao criar ou editar: o envio ao Jurichat feito neste pedido falhou"}},"required":["id","title","initialHour","finalHour","date"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/file/law-suits/{id}":{"get":{"summary":"Listar arquivos de um processo","tags":["Files"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra arquivos por nome"},{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da entidade (processo, cliente ou tarefa)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID interno do arquivo (quando existir no banco)"},"name":{"type":"string","description":"Nome do arquivo"},"previewUrl":{"type":"string","description":"URL temporária para visualização"},"downloadUrl":{"type":"string","description":"URL temporária para download"},"size":{"type":"string","description":"Tamanho formatado"},"type":{"type":"object","properties":{"extension":{"type":"string","description":"MIME type ou extensão"},"formatted":{"type":"string","description":"Tipo formatado (pdf, word, png, etc.)"}},"required":["extension","formatted"],"additionalProperties":false},"createdAt":{"type":"string","description":"Data de criação formatada"}},"required":["name","previewUrl","downloadUrl","size","type","createdAt"],"additionalProperties":false},"description":"Arquivos da entidade"}},"required":["files"],"additionalProperties":false},"totalResults":{"type":"number","description":"Total de arquivos (com paginação)"},"totalPages":{"type":"number","description":"Total de páginas (com paginação)"}},"required":["data"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Anexar arquivo a um processo (multipart/form-data, campo file)","tags":["Files"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"Arquivo enviado no multipart/form-data","type":"string","format":"binary"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da entidade (processo, cliente ou tarefa)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID interno do arquivo (quando existir no banco)"},"name":{"type":"string","description":"Nome do arquivo"},"previewUrl":{"type":"string","description":"URL temporária para visualização"},"downloadUrl":{"type":"string","description":"URL temporária para download"},"size":{"type":"string","description":"Tamanho formatado"},"type":{"type":"object","properties":{"extension":{"type":"string","description":"MIME type ou extensão"},"formatted":{"type":"string","description":"Tipo formatado (pdf, word, png, etc.)"}},"required":["extension","formatted"],"additionalProperties":false},"createdAt":{"type":"string","description":"Data de criação formatada"}},"required":["name","previewUrl","downloadUrl","size","type","createdAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/file/law-suits/{id}/json":{"post":{"summary":"Anexar arquivo a um processo com o conteúdo em JSON (base64)","tags":["Files"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Nome do arquivo com extensão. Ex: contrato-honorarios.pdf"},"content_base64":{"type":"string","minLength":1,"description":"Conteúdo do arquivo em base64. Aceita prefixo data:...;base64, e quebras de linha. Máximo de 10 MB decodificado"},"mime_type":{"type":"string","pattern":"^[\\w.+-]+\\/[\\w.+-]+$","description":"MIME type do arquivo. Ausente: application/pdf quando o conteúdo é PDF, senão application/octet-stream"}},"required":["name","content_base64"],"additionalProperties":false,"description":"Arquivo em base64"}},"required":["file"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da entidade (processo, cliente ou tarefa)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID interno do arquivo (quando existir no banco)"},"name":{"type":"string","description":"Nome do arquivo"},"previewUrl":{"type":"string","description":"URL temporária para visualização"},"downloadUrl":{"type":"string","description":"URL temporária para download"},"size":{"type":"string","description":"Tamanho formatado"},"type":{"type":"object","properties":{"extension":{"type":"string","description":"MIME type ou extensão"},"formatted":{"type":"string","description":"Tipo formatado (pdf, word, png, etc.)"}},"required":["extension","formatted"],"additionalProperties":false},"createdAt":{"type":"string","description":"Data de criação formatada"}},"required":["name","previewUrl","downloadUrl","size","type","createdAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"413":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/file/people/{id}":{"get":{"summary":"Listar arquivos de um cliente/pessoa","tags":["Files"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra arquivos por nome"},{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da entidade (processo, cliente ou tarefa)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID interno do arquivo (quando existir no banco)"},"name":{"type":"string","description":"Nome do arquivo"},"previewUrl":{"type":"string","description":"URL temporária para visualização"},"downloadUrl":{"type":"string","description":"URL temporária para download"},"size":{"type":"string","description":"Tamanho formatado"},"type":{"type":"object","properties":{"extension":{"type":"string","description":"MIME type ou extensão"},"formatted":{"type":"string","description":"Tipo formatado (pdf, word, png, etc.)"}},"required":["extension","formatted"],"additionalProperties":false},"createdAt":{"type":"string","description":"Data de criação formatada"}},"required":["name","previewUrl","downloadUrl","size","type","createdAt"],"additionalProperties":false},"description":"Arquivos da entidade"}},"required":["files"],"additionalProperties":false},"totalResults":{"type":"number","description":"Total de arquivos (com paginação)"},"totalPages":{"type":"number","description":"Total de páginas (com paginação)"}},"required":["data"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Anexar arquivo a um cliente/pessoa (multipart/form-data, campo file)","tags":["Files"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"Arquivo enviado no multipart/form-data","type":"string","format":"binary"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da entidade (processo, cliente ou tarefa)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID interno do arquivo (quando existir no banco)"},"name":{"type":"string","description":"Nome do arquivo"},"previewUrl":{"type":"string","description":"URL temporária para visualização"},"downloadUrl":{"type":"string","description":"URL temporária para download"},"size":{"type":"string","description":"Tamanho formatado"},"type":{"type":"object","properties":{"extension":{"type":"string","description":"MIME type ou extensão"},"formatted":{"type":"string","description":"Tipo formatado (pdf, word, png, etc.)"}},"required":["extension","formatted"],"additionalProperties":false},"createdAt":{"type":"string","description":"Data de criação formatada"}},"required":["name","previewUrl","downloadUrl","size","type","createdAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/file/people/{id}/json":{"post":{"summary":"Anexar arquivo a um cliente/pessoa com o conteúdo em JSON (base64)","tags":["Files"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Nome do arquivo com extensão. Ex: contrato-honorarios.pdf"},"content_base64":{"type":"string","minLength":1,"description":"Conteúdo do arquivo em base64. Aceita prefixo data:...;base64, e quebras de linha. Máximo de 10 MB decodificado"},"mime_type":{"type":"string","pattern":"^[\\w.+-]+\\/[\\w.+-]+$","description":"MIME type do arquivo. Ausente: application/pdf quando o conteúdo é PDF, senão application/octet-stream"}},"required":["name","content_base64"],"additionalProperties":false,"description":"Arquivo em base64"}},"required":["file"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da entidade (processo, cliente ou tarefa)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID interno do arquivo (quando existir no banco)"},"name":{"type":"string","description":"Nome do arquivo"},"previewUrl":{"type":"string","description":"URL temporária para visualização"},"downloadUrl":{"type":"string","description":"URL temporária para download"},"size":{"type":"string","description":"Tamanho formatado"},"type":{"type":"object","properties":{"extension":{"type":"string","description":"MIME type ou extensão"},"formatted":{"type":"string","description":"Tipo formatado (pdf, word, png, etc.)"}},"required":["extension","formatted"],"additionalProperties":false},"createdAt":{"type":"string","description":"Data de criação formatada"}},"required":["name","previewUrl","downloadUrl","size","type","createdAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"413":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/file/tasks/{id}":{"get":{"summary":"Listar arquivos de uma tarefa","tags":["Files"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra arquivos por nome"},{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da entidade (processo, cliente ou tarefa)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID interno do arquivo (quando existir no banco)"},"name":{"type":"string","description":"Nome do arquivo"},"previewUrl":{"type":"string","description":"URL temporária para visualização"},"downloadUrl":{"type":"string","description":"URL temporária para download"},"size":{"type":"string","description":"Tamanho formatado"},"type":{"type":"object","properties":{"extension":{"type":"string","description":"MIME type ou extensão"},"formatted":{"type":"string","description":"Tipo formatado (pdf, word, png, etc.)"}},"required":["extension","formatted"],"additionalProperties":false},"createdAt":{"type":"string","description":"Data de criação formatada"}},"required":["name","previewUrl","downloadUrl","size","type","createdAt"],"additionalProperties":false},"description":"Arquivos da entidade"}},"required":["files"],"additionalProperties":false},"totalResults":{"type":"number","description":"Total de arquivos (com paginação)"},"totalPages":{"type":"number","description":"Total de páginas (com paginação)"}},"required":["data"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Anexar arquivo a uma tarefa (multipart/form-data, campo file)","tags":["Files"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"Arquivo enviado no multipart/form-data","type":"string","format":"binary"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da entidade (processo, cliente ou tarefa)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID interno do arquivo (quando existir no banco)"},"name":{"type":"string","description":"Nome do arquivo"},"previewUrl":{"type":"string","description":"URL temporária para visualização"},"downloadUrl":{"type":"string","description":"URL temporária para download"},"size":{"type":"string","description":"Tamanho formatado"},"type":{"type":"object","properties":{"extension":{"type":"string","description":"MIME type ou extensão"},"formatted":{"type":"string","description":"Tipo formatado (pdf, word, png, etc.)"}},"required":["extension","formatted"],"additionalProperties":false},"createdAt":{"type":"string","description":"Data de criação formatada"}},"required":["name","previewUrl","downloadUrl","size","type","createdAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/lawSuit/":{"get":{"summary":"Listar processos","tags":["Law Suits"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"processNumber","required":false,"description":"Filtra por número CNJ"},{"schema":{"type":"string"},"in":"query","name":"person","required":false,"description":"Filtra por nome da parte"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"responsible","required":false,"description":"ID do responsável ou lista"},{"schema":{"type":"string"},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc"},{"schema":{"type":"string"},"in":"query","name":"hasMonitoring","required":false,"description":"true ou false"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"status","required":false,"description":"Status ou lista"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"tag","required":false,"description":"Tag ou lista de tags"},{"schema":{"type":"string"},"in":"query","name":"isUniqueResponsible","required":false,"description":"true para responsável único"},{"schema":{"type":"string"},"in":"query","name":"fullQuery","required":false,"description":"true para resposta completa"},{"schema":{"type":"string"},"in":"query","name":"isPrivate","required":false,"description":"true ou false"},{"schema":{"type":"string"},"in":"query","name":"isSecret","required":false,"description":"true ou false"},{"schema":{"type":"string"},"in":"query","name":"actionGroup","required":false,"description":"Filtra por grupo de ação"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"typeAction","required":false,"description":"Tipo de ação ou lista"},{"schema":{"type":"string"},"in":"query","name":"code","required":false,"description":"Filtra por código"},{"schema":{"type":"string"},"in":"query","name":"corretor","required":false,"description":"Filtra por corretor"},{"schema":{"type":"string"},"in":"query","name":"court","required":false,"description":"Filtra por tribunal"},{"schema":{"type":"string","enum":["all","administrative","administrative_inss","judicial","judicial_secret"]},"in":"query","name":"typeLawsuit","required":false,"description":"all, administrative, administrative_inss, judicial ou judicial_secret"},{"schema":{"type":"string"},"in":"query","name":"withoutPartner","required":false,"description":"true para processos sem partnerId e sem corretor legado"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"partnerId","required":false,"description":"Filtra processos vinculados a este parceiro financeiro"},{"schema":{"type":"string"},"in":"query","name":"partnerLinkedAtFrom","required":false,"description":"Início do vínculo (YYYY-MM-DD, dia inclusive)"},{"schema":{"type":"string"},"in":"query","name":"partnerLinkedAtTo","required":false,"description":"Fim do vínculo (YYYY-MM-DD, dia inclusive)"},{"schema":{"type":"string"},"in":"query","name":"customFields","required":false,"description":"Filtro por campos personalizados, em JSON. Texto, número, hora e seleção: [{\"fieldId\":\"<id>\",\"value\":\"ABC\"}] (texto casa por \"contém\"; multiSelect aceita lista em value). Data e data/hora: [{\"fieldId\":\"<id>\",\"from\":\"2026-01-01\",\"to\":\"2026-01-31\"}]. Os itens se combinam em E. O fieldId vem da listagem de campos personalizados do módulo."},{"schema":{"type":"string"},"in":"query","name":"workflowId","required":false,"description":"Filtra pelos que tiveram vínculo com esta automação"},{"schema":{"type":"string"},"in":"query","name":"workflowInstanceId","required":false,"description":"Filtra pelos que tiveram vínculo com esta execução"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do processo"},"processNumber":{"type":"string","nullable":true,"description":"Número CNJ"},"status":{"type":"string","nullable":true,"description":"Status"},"currentInstance":{"type":"number","nullable":true,"description":"Instância"},"court":{"type":"string","nullable":true,"description":"Tribunal"},"courtLawSuitDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data de distribuição"},"isPrivate":{"type":"boolean","description":"Processo privado"},"isSecret":{"type":"boolean","description":"Processo em segredo"},"officeId":{"type":"string","description":"ID do escritório"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"ID do parceiro financeiro"},"partnerLinkedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data do vínculo com o parceiro financeiro"},"customizePartnerCommission":{"type":"boolean","description":"true quando a comissão do parceiro foi personalizada neste processo"},"partnerCommissionType":{"type":"string","enum":["percentage","fixed","fixed_percentage"],"nullable":true,"description":"Tipo da comissão personalizada no processo"},"partnerCommissionPercentage":{"type":"number","nullable":true,"description":"Percentual da comissão personalizada no processo"},"partnerCommissionFixedValue":{"type":"number","nullable":true,"description":"Valor fixo da comissão personalizada no processo"},"partner":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"photoUrl":{"type":"string","nullable":true},"status":{"type":"string","enum":["active","under_review","blocked","inactive"],"nullable":true},"commissionType":{"type":"string","enum":["FIXED","PERCENTAGE","FIXED_AND_PERCENTAGE"],"nullable":true},"percentage":{"type":"number","nullable":true},"fixedValue":{"type":"number","nullable":true}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Parceiro financeiro (photoUrl + comissão padrão do cadastro; override personalizado fica no flat)"}},"required":["id"],"additionalProperties":true},"description":"Lista de processos"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar processo","tags":["Law Suits"],"description":"Cria um processo do escritório. Com consultingColumnId, também cria o atendimento no CRM nessa coluna, ligado ao processo e à primeira parte Cliente; o atendimento nasce privado se o processo ou o cliente for privado e vira o atendimento atual do cliente só quando ele não tem um. Com consultingId, liga o atendimento existente ao processo (e o move para consultingColumnId, se vier). O id do atendimento vem em consultingId na resposta.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"processNumber":{"type":"string","description":"Número CNJ"},"serviceStep":{"type":"string","description":"Fase do processo. Com consultingColumnId, vira o nome da coluna"},"responsibleIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos responsáveis"},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da pessoa existente"},"name":{"type":"string","description":"Nome da parte"},"personOrigin":{"type":"string","enum":["Cliente","Requerida"],"description":"Polo da parte no processo. \"Cliente\" = parte representada pelo escritório. \"Requerida\" = parte adversa. Use exatamente essas strings (case-sensitive)."},"document":{"type":"string","nullable":true,"description":"CPF/CNPJ da parte"},"inTitle":{"type":"boolean","description":"true marca a parte para compor o título do processo (\"Cliente x Parte adversa\"). Polo sem nenhuma parte marcada usa o título padrão. Na criação, omitido fica fora do título. Na atualização, omitido mantém a marcação que a pessoa já tinha no processo; parte nova sem o campo fica fora do título."}},"required":["name","personOrigin"],"additionalProperties":false},"description":"Partes do processo"},"otherParties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da pessoa existente"},"name":{"type":"string","minLength":1,"description":"Nome da outra parte"},"personOrigin":{"type":"string","minLength":1,"maxLength":100,"nullable":true,"description":"Tipo da pessoa no catálogo do escritório, diferente de Cliente e Requerida"}},"required":["name"],"additionalProperties":false},"description":"Pessoas do processo que não são Cliente nem Requerida"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório. Diferente do escritório da chave ou do token: 403"},"valueOfCause":{"type":"string","description":"Valor da causa"},"valueOfFees":{"type":"string","description":"Valor dos honorários"},"percentageOfFees":{"type":"string","description":"Percentual dos honorários"},"requerimentDate":{"type":"string","description":"Data do requerimento"},"protocolNumber":{"type":"string","description":"Número do protocolo"},"annotations":{"type":"string","description":"Anotações"},"originatingProcess":{"type":"string","description":"Processo originário"},"actionGroup":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["name"],"additionalProperties":false},{"type":"string","enum":[""]}],"description":"Grupo de ação"},"typeAction":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["name"],"additionalProperties":false},{"type":"string","enum":[""]}],"description":"Tipo de ação"},"currentInstance":{"type":"integer","minimum":1,"maximum":3,"description":"Instância"},"instance":{"type":"integer","minimum":1,"maximum":3,"description":"Alias legado de currentInstance"},"court":{"type":"string","description":"Tribunal"},"courtLawSuitDate":{"type":"string","description":"Data de distribuição"},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das tags"},"degreeOfRisk":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","enum":[""]}],"description":"ID do grau de risco (UUID). Liste opções em GET /degree-of-risk. Envie string vazia para omitir."},"isPrivate":{"type":"boolean","description":"Processo privado"},"isSecret":{"type":"boolean","description":"Processo em segredo"},"isProcessAdministrative":{"type":"boolean","description":"Processo administrativo"},"lawsuitType":{"type":"string","enum":["JURIDICAL","ADMINISTRATIVE_INSS","ADMINISTRATIVE_OTHER"],"description":"Tipo do processo. Administrativo INSS ou administrativo geral."},"linkedLawSuitId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs de processos vinculados"},"processUrl":{"type":"string","description":"URL do processo"},"courtBranch":{"type":"string","description":"Vara"},"precatoryNumbers":{"type":"array","items":{"type":"string"},"description":"Números de precatório"},"status":{"type":"string","description":"Status"},"publicationId":{"type":"string","description":"ID da movimentação da publicação (publication_movements) do escritório"},"createdByAutomation":{"type":"boolean","description":"Criado por automação"},"author":{"type":"string","description":"ID ou nome de uma parte vinculada que ocupa o papel de autor"},"defendant":{"type":"string","description":"ID ou nome de uma parte vinculada que ocupa o papel de réu"},"periciaResult":{"type":"string","description":"Resultado da perícia"},"periciaExpertName":{"type":"string","description":"Nome do perito"},"periciaExpertType":{"type":"string","description":"Tipo do perito"},"condemnationAmount":{"type":"string","description":"Valor da condenação"},"periciaExpertHonoraries":{"type":"string","description":"Honorários do perito"},"valueHonorariesSuccession":{"type":"string","description":"Honorários de sucessão"},"petition":{"type":"string","description":"Petição"},"valuePetition":{"type":"string","description":"Valor da petição"},"corretor":{"type":"string","description":"Corretor"},"partnerId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID do parceiro financeiro"},"customizePartnerCommission":{"type":"boolean","description":"true = comissão personalizada (badge); false = padrão (snapshot ainda é gravado)"},"partnerCommissionType":{"type":"string","enum":["percentage","fixed","fixed_percentage"],"nullable":true,"description":"Tipo de comissão do snapshot (percentage | fixed | fixed_percentage)"},"partnerCommissionPercentage":{"type":"number","nullable":true,"description":"Percentual do snapshot de comissão"},"partnerCommissionFixedValue":{"type":"number","nullable":true,"description":"Valor fixo do snapshot de comissão"},"code":{"type":"string","description":"Código interno"},"consultingId":{"type":"string","format":"uuid","description":"ID de um atendimento do escritório: passa a ser do processo criado e vira o atendimento atual dele. Com consultingColumnId, o atendimento é movido para a coluna e nenhum outro é criado. 404 se não for do escritório"},"consultingColumnId":{"type":"string","format":"uuid","description":"Coluna do CRM do escritório: sem consultingId, cria um atendimento nessa coluna ligado ao processo e à primeira parte Cliente, com consultingSubject, consultingTags e consultingRegister. 404 se a coluna não for do escritório; 400 sem parte Cliente"},"consultingSubject":{"type":"string","maxLength":255,"description":"Título do atendimento criado com consultingColumnId (padrão: número do processo; sem número, nome do cliente). Ignorado com consultingId"},"consultingTags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das etiquetas do atendimento criado com consultingColumnId. Etiquetas de outro escritório são ignoradas. Ignorado com consultingId"},"consultingRegister":{"type":"string","description":"Primeiro registro (HTML) do atendimento criado com consultingColumnId. Ignorado com consultingId"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"array","items":{"type":"string","maxLength":100},"maxItems":500}],"nullable":true,"description":"Valor do campo. Envie null para limpar"}},"required":["fieldId","value"],"additionalProperties":false},"maxItems":100,"description":"Valores dos campos personalizados"}},"required":["serviceStep","responsibleIds","persons"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do processo"},"consultingId":{"type":"string","nullable":true,"description":"Atendimento atual do processo. No POST com consultingColumnId ou consultingId, é o atendimento criado ou ligado"},"processNumber":{"type":"string","nullable":true,"description":"Número CNJ"},"valueOfCause":{"type":"string","nullable":true,"description":"Valor da causa"},"status":{"type":"string","nullable":true,"description":"Status"},"currentInstance":{"type":"number","nullable":true,"description":"Instância"},"court":{"type":"string","nullable":true,"description":"Tribunal"},"courtLawSuitDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data de distribuição"},"serviceStep":{"type":"string","nullable":true,"description":"Fase do processo"},"isPrivate":{"type":"boolean","description":"Processo privado"},"isSecret":{"type":"boolean","description":"Processo em segredo"},"officeId":{"type":"string","description":"ID do escritório"},"corretor":{"type":"string","nullable":true,"description":"Corretor"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"ID do parceiro financeiro"},"partnerLinkedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data do vínculo com o parceiro financeiro"},"customizePartnerCommission":{"type":"boolean","description":"true quando a comissão do parceiro foi personalizada neste processo"},"partnerCommissionType":{"type":"string","enum":["percentage","fixed","fixed_percentage"],"nullable":true,"description":"Tipo da comissão personalizada no processo"},"partnerCommissionPercentage":{"type":"number","nullable":true,"description":"Percentual da comissão personalizada no processo"},"partnerCommissionFixedValue":{"type":"number","nullable":true,"description":"Valor fixo da comissão personalizada no processo"},"partner":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"photoUrl":{"type":"string","nullable":true},"status":{"type":"string","enum":["active","under_review","blocked","inactive"],"nullable":true},"commissionType":{"type":"string","enum":["FIXED","PERCENTAGE","FIXED_AND_PERCENTAGE"]},"percentage":{"type":"number","nullable":true},"fixedValue":{"type":"number","nullable":true}},"required":["id","name","photoUrl","commissionType","percentage","fixedValue"],"additionalProperties":false,"nullable":true,"description":"Parceiro financeiro vinculado (comissão do snapshot no processo)"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string"},"options":{"type":"array","items":{"type":"string"},"nullable":true},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}]},"isArchived":{"type":"boolean"}},"required":["fieldId","name","type","options","value","isArchived"],"additionalProperties":false}},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome da parte"},"personOrigin":{"type":"string","enum":["Cliente","Requerida"],"description":"Polo da parte no processo. \"Cliente\" = parte representada pelo escritório. \"Requerida\" = parte adversa. Use exatamente essas strings (case-sensitive)."},"role":{"type":"string","enum":["AUTHOR","DEFENDANT"],"nullable":true,"description":"Papel da pessoa no processo"},"inTitle":{"type":"boolean","description":"true quando a parte compõe o título do processo; polo sem parte marcada usa o título padrão"}},"required":["name","personOrigin"],"additionalProperties":false},"description":"Partes do processo"},"otherParties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome da outra parte"},"personOrigin":{"type":"string","nullable":true,"description":"Tipo da pessoa, diferente de Cliente e Requerida"}},"required":["id","name","personOrigin"],"additionalProperties":false},"description":"Pessoas do processo que não são Cliente nem Requerida"}},"required":["id"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir processos","tags":["Law Suits"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs dos processos"}},"required":["id"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/lawSuit/movements/{lawSuitId}":{"get":{"summary":"Listar movimentações","tags":["Law Suits"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"tagId","required":false,"description":"Filtra por ID da tag"},{"schema":{"type":"string"},"in":"query","name":"content","required":false,"description":"Filtra por texto no conteúdo"},{"schema":{"type":"number"},"in":"query","name":"instance","required":false,"description":"Filtra por instância de origem (grau)"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"lawSuitId","required":true,"description":"ID do processo"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Movimentações do processo","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"ID da movimentação"},"conteudo":{"type":"string","description":"Texto da movimentação"},"data":{"type":"string","description":"Data da movimentação"},"instance":{"type":"number","nullable":true,"description":"Instância de origem da movimentação (grau)"},"lawSuitInstance":{"type":"object","properties":{"id":{"type":"string","description":"ID da instância"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo da instância"},"instance":{"type":"number","nullable":true,"description":"Grau da instância"}},"required":["id","processNumber","instance"],"additionalProperties":false,"nullable":true,"description":"Instância do processo vinculada ao andamento"},"tags":{"type":"array","items":{"type":"string"},"description":"IDs das tags"},"tagsDetails":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da tag"},"name":{"type":"string","description":"Nome da tag"},"color":{"type":"string","description":"Cor da tag"}},"required":["id"],"additionalProperties":false},"description":"Detalhes das tags"}},"required":["id","conteudo","data"],"additionalProperties":true},"description":"Movimentações do processo"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/lawSuit/{id}":{"get":{"summary":"Buscar processo","tags":["Law Suits"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"fullQuery","required":false,"description":"true para incluir relações completas"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do processo"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do processo"},"consultingId":{"type":"string","nullable":true,"description":"Atendimento atual do processo. No POST com consultingColumnId ou consultingId, é o atendimento criado ou ligado"},"processNumber":{"type":"string","nullable":true,"description":"Número CNJ"},"valueOfCause":{"type":"string","nullable":true,"description":"Valor da causa"},"status":{"type":"string","nullable":true,"description":"Status"},"currentInstance":{"type":"number","nullable":true,"description":"Instância"},"court":{"type":"string","nullable":true,"description":"Tribunal"},"courtLawSuitDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data de distribuição"},"serviceStep":{"type":"string","nullable":true,"description":"Fase do processo"},"isPrivate":{"type":"boolean","description":"Processo privado"},"isSecret":{"type":"boolean","description":"Processo em segredo"},"officeId":{"type":"string","description":"ID do escritório"},"corretor":{"type":"string","nullable":true,"description":"Corretor"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"ID do parceiro financeiro"},"partnerLinkedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data do vínculo com o parceiro financeiro"},"customizePartnerCommission":{"type":"boolean","description":"true quando a comissão do parceiro foi personalizada neste processo"},"partnerCommissionType":{"type":"string","enum":["percentage","fixed","fixed_percentage"],"nullable":true,"description":"Tipo da comissão personalizada no processo"},"partnerCommissionPercentage":{"type":"number","nullable":true,"description":"Percentual da comissão personalizada no processo"},"partnerCommissionFixedValue":{"type":"number","nullable":true,"description":"Valor fixo da comissão personalizada no processo"},"partner":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"photoUrl":{"type":"string","nullable":true},"status":{"type":"string","enum":["active","under_review","blocked","inactive"],"nullable":true},"commissionType":{"type":"string","enum":["FIXED","PERCENTAGE","FIXED_AND_PERCENTAGE"]},"percentage":{"type":"number","nullable":true},"fixedValue":{"type":"number","nullable":true}},"required":["id","name","photoUrl","commissionType","percentage","fixedValue"],"additionalProperties":false,"nullable":true,"description":"Parceiro financeiro vinculado (comissão do snapshot no processo)"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string"},"options":{"type":"array","items":{"type":"string"},"nullable":true},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}]},"isArchived":{"type":"boolean"}},"required":["fieldId","name","type","options","value","isArchived"],"additionalProperties":false}},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome da parte"},"personOrigin":{"type":"string","enum":["Cliente","Requerida"],"description":"Polo da parte no processo. \"Cliente\" = parte representada pelo escritório. \"Requerida\" = parte adversa. Use exatamente essas strings (case-sensitive)."},"role":{"type":"string","enum":["AUTHOR","DEFENDANT"],"nullable":true,"description":"Papel da pessoa no processo"},"inTitle":{"type":"boolean","description":"true quando a parte compõe o título do processo; polo sem parte marcada usa o título padrão"}},"required":["name","personOrigin"],"additionalProperties":false},"description":"Partes do processo"},"otherParties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome da outra parte"},"personOrigin":{"type":"string","nullable":true,"description":"Tipo da pessoa, diferente de Cliente e Requerida"}},"required":["id","name","personOrigin"],"additionalProperties":false},"description":"Pessoas do processo que não são Cliente nem Requerida"}},"required":["id"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar processo","tags":["Law Suits"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"serviceStep":{"type":"string","description":"Fase do processo"},"responsibleIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos responsáveis"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"processNumber":{"type":"string","nullable":true,"description":"Número CNJ"},"valueOfCause":{"type":"string","nullable":true,"description":"Valor da causa"},"valueOfFees":{"type":"string","nullable":true,"description":"Valor dos honorários"},"percentageOfFees":{"type":"string","nullable":true,"description":"Percentual dos honorários"},"requerimentDate":{"type":"string","nullable":true,"description":"Data do requerimento"},"protocolNumber":{"type":"string","nullable":true,"description":"Número do protocolo"},"annotations":{"type":"string","description":"Anotações"},"originatingProcess":{"type":"string","description":"Processo originário"},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da pessoa existente"},"name":{"type":"string","description":"Nome da parte"},"personOrigin":{"type":"string","enum":["Cliente","Requerida"],"description":"Polo da parte no processo. \"Cliente\" = parte representada pelo escritório. \"Requerida\" = parte adversa. Use exatamente essas strings (case-sensitive)."},"document":{"type":"string","nullable":true,"description":"CPF/CNPJ da parte"},"inTitle":{"type":"boolean","description":"true marca a parte para compor o título do processo (\"Cliente x Parte adversa\"). Polo sem nenhuma parte marcada usa o título padrão. Na criação, omitido fica fora do título. Na atualização, omitido mantém a marcação que a pessoa já tinha no processo; parte nova sem o campo fica fora do título."}},"required":["name","personOrigin"],"additionalProperties":false},"description":"Partes do processo"},"otherParties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da pessoa existente"},"name":{"type":"string","minLength":1,"description":"Nome da outra parte"},"personOrigin":{"type":"string","minLength":1,"maxLength":100,"nullable":true,"description":"Tipo da pessoa no catálogo do escritório, diferente de Cliente e Requerida"}},"required":["name"],"additionalProperties":false},"description":"Pessoas do processo que não são Cliente nem Requerida"},"actionGroup":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["name"],"additionalProperties":false},{"type":"string","enum":[""]}],"description":"Grupo de ação. Omita para manter o atual; envie string vazia para remover."},"typeAction":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["name"],"additionalProperties":false},{"type":"string","enum":[""]}],"description":"Tipo de ação. Omita para manter o atual; envie string vazia para remover."},"degreeOfRiskId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID do grau de risco. Liste opções em GET /degree-of-risk. Envie null ou string vazia para remover."},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das tags"},"court":{"type":"string","description":"Tribunal"},"currentInstance":{"type":"integer","minimum":1,"maximum":3,"nullable":true,"description":"Instância"},"instance":{"type":"integer","minimum":1,"maximum":3,"nullable":true,"description":"Alias legado de currentInstance"},"courtLawSuitDate":{"type":"string","description":"Data do processo no tribunal"},"status":{"type":"string","description":"Status"},"linkedLawSuitId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs de processos vinculados"},"isPrivate":{"type":"boolean","description":"Processo privado"},"isSecret":{"type":"boolean","description":"Processo em segredo"},"isProcessAdministrative":{"type":"boolean","description":"Processo administrativo. Sem número CNJ válido o processo é sempre administrativo."},"lawsuitType":{"type":"string","enum":["JURIDICAL","ADMINISTRATIVE_INSS","ADMINISTRATIVE_OTHER"],"description":"Tipo do processo. Administrativo INSS ou administrativo geral."},"processUrl":{"type":"string","description":"URL do processo"},"courtBranch":{"type":"string","description":"Vara"},"precatoryNumbers":{"type":"array","items":{"type":"string"},"description":"Números de precatório"},"author":{"type":"string","description":"ID ou nome de uma parte vinculada que ocupa o papel de autor"},"defendant":{"type":"string","description":"ID ou nome de uma parte vinculada que ocupa o papel de réu"},"periciaResult":{"type":"string","description":"Resultado da perícia"},"periciaExpertName":{"type":"string","description":"Nome do perito"},"periciaExpertType":{"type":"string","description":"Tipo do perito"},"condemnationAmount":{"type":"string","description":"Valor da condenação"},"periciaExpertHonoraries":{"type":"string","description":"Honorários do perito"},"valueHonorariesSuccession":{"type":"string","description":"Honorários de sucessão"},"petition":{"type":"string","description":"Petição"},"valuePetition":{"type":"string","description":"Valor da petição"},"corretor":{"type":"string","description":"Corretor"},"partnerId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID do parceiro financeiro (envie null para desvincular)"},"customizePartnerCommission":{"type":"boolean","description":"true = comissão personalizada (badge); false = padrão (snapshot ainda é gravado)"},"partnerCommissionType":{"type":"string","enum":["percentage","fixed","fixed_percentage"],"nullable":true,"description":"Tipo de comissão do snapshot (percentage | fixed | fixed_percentage)"},"partnerCommissionPercentage":{"type":"number","nullable":true,"description":"Percentual do snapshot de comissão"},"partnerCommissionFixedValue":{"type":"number","nullable":true,"description":"Valor fixo do snapshot de comissão"},"code":{"type":"string","description":"Código interno"},"consultingColumnId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID da coluna do CRM"},"consultingId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID da consultoria em atendimento atual (envie null para desvincular)"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"array","items":{"type":"string","maxLength":100},"maxItems":500}],"nullable":true,"description":"Valor do campo. Envie null para limpar"}},"required":["fieldId","value"],"additionalProperties":false},"maxItems":100,"description":"Valores dos campos personalizados"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do processo"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do processo"},"consultingId":{"type":"string","nullable":true,"description":"Atendimento atual do processo. No POST com consultingColumnId ou consultingId, é o atendimento criado ou ligado"},"processNumber":{"type":"string","nullable":true,"description":"Número CNJ"},"valueOfCause":{"type":"string","nullable":true,"description":"Valor da causa"},"status":{"type":"string","nullable":true,"description":"Status"},"currentInstance":{"type":"number","nullable":true,"description":"Instância"},"court":{"type":"string","nullable":true,"description":"Tribunal"},"courtLawSuitDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data de distribuição"},"serviceStep":{"type":"string","nullable":true,"description":"Fase do processo"},"isPrivate":{"type":"boolean","description":"Processo privado"},"isSecret":{"type":"boolean","description":"Processo em segredo"},"officeId":{"type":"string","description":"ID do escritório"},"corretor":{"type":"string","nullable":true,"description":"Corretor"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"ID do parceiro financeiro"},"partnerLinkedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data do vínculo com o parceiro financeiro"},"customizePartnerCommission":{"type":"boolean","description":"true quando a comissão do parceiro foi personalizada neste processo"},"partnerCommissionType":{"type":"string","enum":["percentage","fixed","fixed_percentage"],"nullable":true,"description":"Tipo da comissão personalizada no processo"},"partnerCommissionPercentage":{"type":"number","nullable":true,"description":"Percentual da comissão personalizada no processo"},"partnerCommissionFixedValue":{"type":"number","nullable":true,"description":"Valor fixo da comissão personalizada no processo"},"partner":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"photoUrl":{"type":"string","nullable":true},"status":{"type":"string","enum":["active","under_review","blocked","inactive"],"nullable":true},"commissionType":{"type":"string","enum":["FIXED","PERCENTAGE","FIXED_AND_PERCENTAGE"]},"percentage":{"type":"number","nullable":true},"fixedValue":{"type":"number","nullable":true}},"required":["id","name","photoUrl","commissionType","percentage","fixedValue"],"additionalProperties":false,"nullable":true,"description":"Parceiro financeiro vinculado (comissão do snapshot no processo)"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string"},"options":{"type":"array","items":{"type":"string"},"nullable":true},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}]},"isArchived":{"type":"boolean"}},"required":["fieldId","name","type","options","value","isArchived"],"additionalProperties":false}},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome da parte"},"personOrigin":{"type":"string","enum":["Cliente","Requerida"],"description":"Polo da parte no processo. \"Cliente\" = parte representada pelo escritório. \"Requerida\" = parte adversa. Use exatamente essas strings (case-sensitive)."},"role":{"type":"string","enum":["AUTHOR","DEFENDANT"],"nullable":true,"description":"Papel da pessoa no processo"},"inTitle":{"type":"boolean","description":"true quando a parte compõe o título do processo; polo sem parte marcada usa o título padrão"}},"required":["name","personOrigin"],"additionalProperties":false},"description":"Partes do processo"},"otherParties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome da outra parte"},"personOrigin":{"type":"string","nullable":true,"description":"Tipo da pessoa, diferente de Cliente e Requerida"}},"required":["id","name","personOrigin"],"additionalProperties":false},"description":"Pessoas do processo que não são Cliente nem Requerida"}},"required":["id"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/lawSuit/movements":{"post":{"summary":"Adicionar andamento manual","tags":["Law Suits"],"description":"Adiciona um andamento escrito manualmente ao processo. O andamento entra no topo da lista com `tipo: ANDAMENTO` e `origin: manual`, e nasce privado — só aparece para o cliente final no Jurichat se `sharedWithJurichat` for `true`.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"lawSuitId":{"type":"string","format":"uuid","description":"ID do processo que recebe o andamento"},"content":{"type":"string","description":"Texto do andamento"},"tags":{"type":"array","items":{"type":"string"},"description":"IDs das tags vinculadas ao andamento"},"sharedWithJurichat":{"type":"boolean","description":"Compartilha o andamento com o cliente final no Jurichat (padrão: false)"},"instance":{"type":"integer","minimum":1,"maximum":3,"description":"Instância do andamento (padrão: instância atual do processo)"}},"required":["lawSuitId","content"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"lawSuitId":{"type":"string","description":"ID do processo"},"movements":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"ID da movimentação"},"conteudo":{"type":"string","description":"Texto da movimentação"},"data":{"type":"string","nullable":true,"description":"Data da movimentação"},"instance":{"type":"number","nullable":true,"description":"Instância de origem da movimentação (grau)"},"lawSuitInstance":{"type":"object","properties":{"id":{"type":"string","description":"ID da instância"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo da instância"},"instance":{"type":"number","nullable":true,"description":"Grau da instância"}},"required":["id","processNumber","instance"],"additionalProperties":false,"nullable":true,"description":"Instância do processo vinculada ao andamento"},"tags":{"type":"array","items":{"type":"string"},"description":"IDs das tags"},"tagsDetails":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da tag"},"name":{"type":"string","description":"Nome da tag"},"color":{"type":"string","description":"Cor da tag"}},"required":["id"],"additionalProperties":false},"description":"Detalhes das tags"}},"additionalProperties":true},"description":"Todas as movimentações do processo, com o novo andamento no topo"},"lastUpdate":{"type":"string","format":"date-time","nullable":true,"description":"Data da movimentação mais recente"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação do registro"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última atualização do registro"}},"required":["lawSuitId","movements"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/lawSuit/v2/monitoring/queue":{"get":{"summary":"Listar fila de monitoramento","tags":["Law Suits"],"description":"Lista processos na fila de validação do monitoramento.","parameters":[{"schema":{"type":"string"},"in":"query","name":"processNumber","required":false},{"schema":{"type":"string"},"in":"query","name":"status","required":false}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response"},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/lawSuit/v2/monitoring/issues":{"get":{"summary":"Listar falhas de monitoramento","tags":["Law Suits"],"description":"Lista falhas na captura de andamentos do monitoramento.","parameters":[{"schema":{"type":"string"},"in":"query","name":"processNumber","required":false},{"schema":{"type":"string"},"in":"query","name":"status","required":false}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response"},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/lawSuit/v2/monitoring/batch":{"delete":{"summary":"Desativar monitoramento em lote","tags":["Law Suits"],"description":"Remove o monitoramento de andamentos para uma lista de processos.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs dos processos com monitoramento a desativar"}},"required":["ids"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Confirmação da remoção"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/lawSuit/v2/monitoring/{id}/instance/{instanceNumber}":{"post":{"summary":"Ativar monitoramento de uma instância","tags":["Law Suits"],"description":"Ativa o monitoramento apenas do grau informado (1, 2 ou 3). Não altera as demais instâncias.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do processo"},{"schema":{"type":"integer","minimum":1,"maximum":3},"in":"path","name":"instanceNumber","required":true,"description":"Grau da instância (1, 2 ou 3)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Confirmação do monitoramento"},"registeredDegrees":{"type":"array","items":{"type":"integer"},"description":"Instâncias efetivamente registradas"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Remover monitoramento de uma instância","tags":["Law Suits"],"description":"Remove o monitoramento apenas do grau informado (1, 2 ou 3). As demais instâncias permanecem ativas.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do processo"},{"schema":{"type":"integer","minimum":1,"maximum":3},"in":"path","name":"instanceNumber","required":true,"description":"Grau da instância (1, 2 ou 3)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Confirmação da remoção"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/lawSuit/v2/monitoring/{id}":{"post":{"summary":"Ativar monitoramento de processo","tags":["Law Suits"],"description":"Ativa o monitoramento de andamentos no tribunal. Envie `{ \"instances\": [1] }` para cadastrar só o 1º grau. Sem o campo, cadastra os três. Processos em segredo de justiça exigem credentialId. Processo administrativo INSS também é aceito: ativa o monitoramento INSS (1 crédito) e ignora `instances`.","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{"credentialId":{"type":"string","format":"uuid","nullable":true,"description":"ID da credencial. Obrigatório para processos em segredo de justiça"},"instances":{"type":"array","items":{"anyOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]}]},"minItems":1,"maxItems":3,"description":"Graus a monitorar (1, 2 e/ou 3). Sem este campo, cadastra os três."}},"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do processo"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Confirmação do monitoramento"},"registeredDegrees":{"type":"array","items":{"type":"integer"},"description":"Instâncias monitoradas (processos públicos)"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Remover monitoramento do processo","tags":["Law Suits"],"description":"Remove o monitoramento de todas as instâncias do processo. Para remover um grau específico, use DELETE /lawSuit/v2/monitoring/{id}/instance/{instanceNumber}. Processo administrativo INSS também é aceito: remove o monitoramento INSS e devolve o crédito.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do processo"}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/law-suit-custom-fields/":{"get":{"summary":"Listar campos personalizados de processos","tags":["Law Suit Custom Fields"],"description":"Lista as definições de campos personalizados de processos do escritório, incluindo as arquivadas. O `id` devolvido aqui é o `fieldId` usado em `customFields` ao criar ou atualizar um processo.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","createdAt","updatedAt"],"additionalProperties":false}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar campo personalizado de processos","tags":["Law Suit Custom Fields"],"description":"Cria uma definição de campo personalizado de processos. Os tipos `select` e `multiSelect` exigem `options` (até 500, sem repetir); os demais recusam `options`. O limite é de 100 campos ativos por escritório.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":100},"minItems":1,"maxItems":500,"description":"Opções, quando o tipo aceita"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"}},"required":["name","type"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/law-suit-custom-fields/{id}":{"patch":{"summary":"Atualizar campo personalizado de processos","tags":["Law Suit Custom Fields"],"description":"Altera um campo personalizado de processos: `name`, `options` (só `select` e `multiSelect`) e `isRequired`; informe ao menos um. O tipo não muda depois de criado. `options` é a lista completa, com até 500 opções: acrescentar é livre; tirar uma opção só é aceito se nenhum processo a usa — opção em uso responde 400 com a quantidade de registros.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do campo"},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":100},"minItems":1,"maxItems":500,"description":"Opções, quando o tipo aceita"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do campo personalizado"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Arquivar campo personalizado de processos","tags":["Law Suit Custom Fields"],"description":"Arquiva o campo: ele deixa de ser oferecido em novos processos, e os valores já gravados são preservados. Responde 204 sem corpo.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do campo personalizado"}],"security":[{"apiKeyAuth":[]}],"responses":{"204":{"description":"Campo arquivado.","content":{"application/json":{"schema":{"enum":["null"],"nullable":true,"description":"Campo arquivado."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-custom-fields/":{"get":{"summary":"Listar campos personalizados de tarefas","tags":["Task Custom Fields"],"description":"Lista as definições ativas de campos personalizados de tarefas do escritório. O `id` devolvido aqui é o `fieldId` usado em `customFields` ao criar ou atualizar uma tarefa.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","createdAt","updatedAt"],"additionalProperties":false}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar campo personalizado de tarefas","tags":["Task Custom Fields"],"description":"Cria uma definição de campo personalizado de tarefas. Os tipos `select` e `multiSelect` exigem `options` (até 500, sem repetir); os demais recusam `options`. O limite é de 100 campos ativos por escritório.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":100},"minItems":1,"maxItems":500,"description":"Opções, quando o tipo aceita"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"}},"required":["name","type"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-custom-fields/{id}":{"patch":{"summary":"Atualizar campo personalizado de tarefas","tags":["Task Custom Fields"],"description":"Altera um campo personalizado de tarefas: `name`, `options` (só `select` e `multiSelect`) e `isRequired`; informe ao menos um. O tipo não muda depois de criado. `options` é a lista completa, com até 500 opções: acrescentar é livre; tirar uma opção só é aceito se nenhuma tarefa a usa — opção em uso responde 400 com a quantidade de registros.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do campo"},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":100},"minItems":1,"maxItems":500,"description":"Opções, quando o tipo aceita"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do campo personalizado"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Arquivar campo personalizado de tarefas","tags":["Task Custom Fields"],"description":"Arquiva o campo: ele deixa de ser oferecido em novas tarefas, e os valores já gravados são preservados. Responde 204 sem corpo.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do campo personalizado"}],"security":[{"apiKeyAuth":[]}],"responses":{"204":{"description":"Campo arquivado.","content":{"application/json":{"schema":{"enum":["null"],"nullable":true,"description":"Campo arquivado."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/metrics/partners":{"get":{"summary":"Métricas de parceiros financeiros","tags":["Metrics"],"parameters":[{"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}]},"in":"query","name":"startDate","required":true,"description":"Início do período (YYYY-MM-DD)"},{"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}]},"in":"query","name":"endDate","required":true,"description":"Fim do período (YYYY-MM-DD)"},{"schema":{"type":"string","enum":["day","week","month","custom"]},"in":"query","name":"periodType","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"partnerId","required":false,"description":"Filtra métricas deste parceiro"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"totalPartners":{"type":"number","description":"Parceiros cadastrados (snapshot)"},"linkedLawsuitsCount":{"type":"number","description":"Processos com parceiro vinculado (snapshot)"},"commissionPending":{"type":"number","description":"Comissão a pagar (não paga)"},"commissionPaidByMonth":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string","description":"YYYY-MM"},"label":{"type":"string","description":"Mês abreviado"},"amount":{"type":"number","description":"Comissão paga no mês"}},"required":["month","label","amount"],"additionalProperties":false},"description":"Últimos 6 meses até endDate"},"lawsuitsByPartner":{"type":"array","items":{"type":"object","properties":{"partnerId":{"type":"string","format":"uuid"},"partnerName":{"type":"string"},"lawsuitsCount":{"type":"number"}},"required":["partnerId","partnerName","lawsuitsCount"],"additionalProperties":false},"description":"Ranking atual de processos vinculados"}},"required":["totalPartners","linkedLawsuitsCount","commissionPending","commissionPaidByMonth","lawsuitsByPartner"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/person/search":{"get":{"summary":"Buscar pessoa por telefone","tags":["Persons"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"phoneNumber","required":true,"description":"Telefone para busca"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"},"isLinkedToJurichat":{"type":"boolean"},"email":{"type":"string","nullable":true,"description":"E-mail"},"phone":{"type":"string","nullable":true,"description":"Telefone"},"personOrigin":{"type":"string","nullable":true,"description":"Nome do tipo de pessoa"},"personOriginId":{"type":"string","format":"uuid","nullable":true,"description":"ID do tipo de pessoa"},"systemKey":{"type":"string","enum":["CLIENTE","REQUERIDA"],"nullable":true,"description":"Tipo de sistema, quando a pessoa usa Cliente ou Requerida"},"isPrivate":{"type":"boolean","description":"Registro privado"},"ownerId":{"type":"string","nullable":true,"description":"ID do responsável"},"legalRepresentant":{"type":"string","nullable":true,"description":"Representante legal"},"corretor":{"type":"string","nullable":true,"description":"Corretor"},"code":{"type":"string","nullable":true,"description":"Código interno"},"govPassword":{"type":"string","nullable":true,"description":"Senha gov.br"}},"required":["id","name"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/person/":{"get":{"summary":"Listar pessoas","tags":["Persons"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra por nome"},{"schema":{"type":"string"},"in":"query","name":"type","required":false,"description":"Filtra por origem"},{"schema":{"type":"string"},"in":"query","name":"phone","required":false,"description":"Filtra por telefone"},{"schema":{"type":"string"},"in":"query","name":"email","required":false,"description":"Filtra por e-mail"},{"schema":{"type":"string"},"in":"query","name":"document","required":false,"description":"Filtra por documento"},{"schema":{"type":"string"},"in":"query","name":"code","required":false,"description":"Filtra por código"},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"Busca por nome ou documento (CPF/CNPJ, com ou sem máscara)"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"Ordenação. asc ou desc"},{"schema":{"type":"string"},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação. createdAt, updatedAt, name, email"},{"schema":{"type":"string"},"in":"query","name":"fullQuery","required":false,"description":"true para resposta completa com processos e tarefas"},{"schema":{"type":"string"},"in":"query","name":"isPrivate","required":false,"description":"true ou false"},{"schema":{"type":"string"},"in":"query","name":"legalRepresentant","required":false,"description":"Filtra por representante legal"},{"schema":{"type":"string"},"in":"query","name":"ownerId","required":false,"description":"Filtra por ID do responsável"},{"schema":{"type":"string"},"in":"query","name":"corretor","required":false,"description":"Filtra por corretor"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"tag","required":false,"description":"ID da tag ou lista de IDs"},{"schema":{"type":"string","enum":["active","desactive"]},"in":"query","name":"monitoring","required":false,"description":"active = com monitoringId, desactive = sem monitoringId"},{"schema":{"type":"string"},"in":"query","name":"customFields","required":false,"description":"Filtro por campos personalizados, em JSON. Texto, número, hora e seleção: [{\"fieldId\":\"<id>\",\"value\":\"ABC\"}] (texto casa por \"contém\"; multiSelect aceita lista em value). Data e data/hora: [{\"fieldId\":\"<id>\",\"from\":\"2026-01-01\",\"to\":\"2026-01-31\"}]. Os itens se combinam em E. O fieldId vem da listagem de campos personalizados do módulo."},{"schema":{"type":"string"},"in":"query","name":"workflowId","required":false,"description":"Filtra pelas que tiveram vínculo com esta automação"},{"schema":{"type":"string"},"in":"query","name":"workflowInstanceId","required":false,"description":"Filtra pelas que tiveram vínculo com esta execução"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"},"isLinkedToJurichat":{"type":"boolean"},"email":{"type":"string","nullable":true,"description":"E-mail"},"phone":{"type":"string","nullable":true,"description":"Telefone"},"personOrigin":{"type":"string","nullable":true,"description":"Nome do tipo de pessoa"},"personOriginId":{"type":"string","format":"uuid","nullable":true,"description":"ID do tipo de pessoa"},"systemKey":{"type":"string","enum":["CLIENTE","REQUERIDA"],"nullable":true,"description":"Tipo de sistema, quando a pessoa usa Cliente ou Requerida"},"isPrivate":{"type":"boolean","description":"Registro privado"},"ownerId":{"type":"string","nullable":true,"description":"ID do responsável"},"legalRepresentant":{"type":"string","nullable":true,"description":"Representante legal"},"corretor":{"type":"string","nullable":true,"description":"Corretor"},"code":{"type":"string","nullable":true,"description":"Código interno"},"govPassword":{"type":"string","nullable":true,"description":"Senha gov.br"}},"required":["id","name"],"additionalProperties":true},"description":"Lista de pessoas"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar pessoa","tags":["Persons"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome"},"personOrigin":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do tipo de pessoa cadastrado no escritório"},"email":{"type":"string","format":"email","description":"E-mail"},"imageUrl":{"type":"string","description":"URL da foto"},"document":{"type":"string","description":"CPF ou CNPJ"},"phone":{"type":"string","description":"Telefone"},"personType":{"type":"string","description":"Tipo. Ex: física, jurídica"},"maritalStatus":{"type":"string","description":"Estado civil"},"zipCode":{"type":"string","description":"CEP"},"state":{"type":"string","description":"Estado"},"city":{"type":"string","description":"Cidade"},"neighborhood":{"type":"string","description":"Bairro"},"streetAndNumber":{"type":"string","description":"Rua e número"},"clientDiscoverOffice":{"type":"string","description":"Como conheceu o escritório"},"annotation":{"type":"string","description":"Anotação em texto"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"rg":{"type":"string","description":"RG"},"nationality":{"type":"string","description":"Nacionalidade"},"profession":{"type":"string","description":"Profissão"},"birthDate":{"type":"string","description":"Data de nascimento"},"isPrivate":{"type":"boolean","description":"Registro privado"},"legalRepresentant":{"type":"string","description":"Representante legal"},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das tags"},"linkedPersonIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das pessoas vinculadas a esta pessoa"},"corretor":{"type":"string","description":"Corretor"},"code":{"type":"string","description":"Código interno"},"govPassword":{"type":"string","description":"Senha gov.br"},"addressComplement":{"type":"string","description":"Complemento do endereço"},"consultingId":{"type":"string","format":"uuid","description":"ID de um atendimento do escritório: passa a ser da pessoa criada e vira o atendimento atual dela (a pessoa anterior deixa de apontar para ele). 404 se não for do escritório"},"consultingColumnId":{"type":"string","format":"uuid","description":"Coluna do CRM do escritório: move o atendimento atual (ou o consultingId enviado) para ela; sem atendimento, cria um nessa coluna com consultingSubject, consultingTags e consultingRegister. 404 se a coluna não for do escritório"},"consultingSubject":{"type":"string","maxLength":255,"description":"Título do atendimento criado com consultingColumnId quando a pessoa ainda não tem atendimento (padrão: nome da pessoa). Ignorado ao mover um atendimento existente"},"consultingTags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das etiquetas do atendimento criado com consultingColumnId quando a pessoa ainda não tem atendimento. Ignorado ao mover um atendimento existente"},"consultingRegister":{"type":"string","description":"Primeiro registro (HTML) do atendimento criado com consultingColumnId quando a pessoa ainda não tem atendimento. Ignorado ao mover um atendimento existente"},"createAnyWay":{"type":"boolean","description":"Ignora validação de nome semelhante e cria a pessoa mesmo assim"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"array","items":{"type":"string","maxLength":100},"maxItems":500}],"nullable":true,"description":"Valor do campo. Envie null para limpar"}},"required":["fieldId","value"],"additionalProperties":false},"maxItems":100,"description":"Valores dos campos personalizados do escritório"}},"required":["name","personOrigin"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"},"isLinkedToJurichat":{"type":"boolean"},"email":{"type":"string","nullable":true,"description":"E-mail"},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ"},"phone":{"type":"string","nullable":true,"description":"Telefone"},"personOrigin":{"type":"string","nullable":true,"description":"Nome do tipo de pessoa"},"personOriginId":{"type":"string","format":"uuid","nullable":true,"description":"ID do tipo de pessoa"},"systemKey":{"type":"string","enum":["CLIENTE","REQUERIDA"],"nullable":true,"description":"Tipo de sistema, quando a pessoa usa Cliente ou Requerida"},"personType":{"type":"string","nullable":true,"description":"Tipo. Ex: física, jurídica"},"maritalStatus":{"type":"string","nullable":true,"description":"Estado civil"},"zipCode":{"type":"string","nullable":true,"description":"CEP"},"state":{"type":"string","nullable":true,"description":"Estado"},"city":{"type":"string","nullable":true,"description":"Cidade"},"neighborhood":{"type":"string","nullable":true,"description":"Bairro"},"streetAndNumber":{"type":"string","nullable":true,"description":"Rua e número"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"},"clientDiscoverOffice":{"type":"string","nullable":true,"description":"Como conheceu o escritório"},"annotation":{"description":"Anotações"},"officeId":{"type":"string","description":"ID do escritório"},"rg":{"type":"string","nullable":true,"description":"RG"},"nationality":{"type":"string","nullable":true,"description":"Nacionalidade"},"profession":{"type":"string","nullable":true,"description":"Profissão"},"birthDate":{"type":"string","nullable":true,"description":"Data de nascimento"},"isPrivate":{"type":"boolean","nullable":true,"description":"Registro privado"},"ownerId":{"type":"string","nullable":true,"description":"ID do responsável"},"legalRepresentant":{"type":"string","nullable":true,"description":"Representante legal"},"corretor":{"type":"string","nullable":true,"description":"Corretor"},"code":{"type":"string","nullable":true,"description":"Código interno"},"govPassword":{"type":"string","nullable":true,"description":"Senha gov.br"},"addressComplement":{"type":"string","nullable":true,"description":"Complemento do endereço"},"linkedPersons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"personOrigin":{"type":"string","nullable":true}},"required":["id","name","personOrigin"],"additionalProperties":false},"description":"Pessoas vinculadas visíveis ao usuário (em qualquer sentido do vínculo)"},"consultingId":{"type":"string","format":"uuid","nullable":true,"description":"Atendimento atual da pessoa. No POST/PATCH com consultingColumnId, é o atendimento criado ou movido"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Data de criação"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Data da última alteração"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string"},"options":{"type":"array","items":{"type":"string"},"nullable":true},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}]},"isArchived":{"type":"boolean"}},"required":["fieldId","name","type","options","value","isArchived"],"additionalProperties":false},"description":"Valores dos campos personalizados do escritório"}},"required":["id","name","officeId"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir pessoas em lote","tags":["Persons"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":200,"description":"IDs das pessoas"},"deleteLawSuit":{"type":"boolean","description":"true para excluir processos vinculados"}},"required":["id"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"204":{"description":"Sem conteúdo","content":{"application/json":{"schema":{"enum":["null"],"nullable":true,"description":"Sem conteúdo"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/person/{id}":{"get":{"summary":"Buscar pessoa","tags":["Persons"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da pessoa"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"},"isLinkedToJurichat":{"type":"boolean"},"email":{"type":"string","nullable":true,"description":"E-mail"},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ"},"phone":{"type":"string","nullable":true,"description":"Telefone"},"personOrigin":{"type":"string","nullable":true,"description":"Nome do tipo de pessoa"},"personOriginId":{"type":"string","format":"uuid","nullable":true,"description":"ID do tipo de pessoa"},"systemKey":{"type":"string","enum":["CLIENTE","REQUERIDA"],"nullable":true,"description":"Tipo de sistema, quando a pessoa usa Cliente ou Requerida"},"personType":{"type":"string","nullable":true,"description":"Tipo. Ex: física, jurídica"},"maritalStatus":{"type":"string","nullable":true,"description":"Estado civil"},"zipCode":{"type":"string","nullable":true,"description":"CEP"},"state":{"type":"string","nullable":true,"description":"Estado"},"city":{"type":"string","nullable":true,"description":"Cidade"},"neighborhood":{"type":"string","nullable":true,"description":"Bairro"},"streetAndNumber":{"type":"string","nullable":true,"description":"Rua e número"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"},"clientDiscoverOffice":{"type":"string","nullable":true,"description":"Como conheceu o escritório"},"annotation":{"description":"Anotações"},"officeId":{"type":"string","description":"ID do escritório"},"rg":{"type":"string","nullable":true,"description":"RG"},"nationality":{"type":"string","nullable":true,"description":"Nacionalidade"},"profession":{"type":"string","nullable":true,"description":"Profissão"},"birthDate":{"type":"string","nullable":true,"description":"Data de nascimento"},"isPrivate":{"type":"boolean","nullable":true,"description":"Registro privado"},"ownerId":{"type":"string","nullable":true,"description":"ID do responsável"},"legalRepresentant":{"type":"string","nullable":true,"description":"Representante legal"},"corretor":{"type":"string","nullable":true,"description":"Corretor"},"code":{"type":"string","nullable":true,"description":"Código interno"},"govPassword":{"type":"string","nullable":true,"description":"Senha gov.br"},"addressComplement":{"type":"string","nullable":true,"description":"Complemento do endereço"},"linkedPersons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"personOrigin":{"type":"string","nullable":true}},"required":["id","name","personOrigin"],"additionalProperties":false},"description":"Pessoas vinculadas visíveis ao usuário (em qualquer sentido do vínculo)"},"consultingId":{"type":"string","format":"uuid","nullable":true,"description":"Atendimento atual da pessoa. No POST/PATCH com consultingColumnId, é o atendimento criado ou movido"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Data de criação"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Data da última alteração"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string"},"options":{"type":"array","items":{"type":"string"},"nullable":true},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}]},"isArchived":{"type":"boolean"}},"required":["fieldId","name","type","options","value","isArchived"],"additionalProperties":false},"description":"Valores dos campos personalizados do escritório"}},"required":["id","name","officeId"],"additionalProperties":true}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar pessoa","tags":["Persons"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome"},"personOrigin":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do tipo de pessoa cadastrado no escritório"},"email":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"description":"E-mail"},"imageUrl":{"type":"string","description":"URL da foto"},"document":{"type":"string","description":"CPF ou CNPJ"},"phone":{"type":"string","description":"Telefone"},"personType":{"type":"string","description":"Tipo. Ex: física, jurídica"},"maritalStatus":{"type":"string","description":"Estado civil"},"zipCode":{"type":"string","description":"CEP"},"state":{"type":"string","description":"Estado"},"city":{"type":"string","description":"Cidade"},"neighborhood":{"type":"string","description":"Bairro"},"streetAndNumber":{"type":"string","description":"Rua e número"},"clientDiscoverOffice":{"type":"string","description":"Como conheceu o escritório"},"annotation":{"type":"string","description":"Anotação em texto"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"rg":{"type":"string","description":"RG"},"nationality":{"type":"string","description":"Nacionalidade"},"profession":{"type":"string","description":"Profissão"},"birthDate":{"type":"string","description":"Data de nascimento"},"isPrivate":{"type":"boolean","description":"Registro privado"},"legalRepresentant":{"type":"string","description":"Representante legal"},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das tags"},"linkedPersonIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das pessoas vinculadas (substitui todos os vínculos; [] remove todos)"},"corretor":{"type":"string","description":"Corretor"},"code":{"type":"string","description":"Código interno"},"govPassword":{"type":"string","description":"Senha gov.br"},"addressComplement":{"type":"string","description":"Complemento do endereço"},"consultingId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID de um atendimento do escritório: passa a ser desta pessoa e vira o atendimento atual dela (a pessoa anterior deixa de apontar para ele). Envie null para desvincular. 404 se não for do escritório"},"consultingColumnId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"Coluna do CRM do escritório: move o atendimento atual (ou o consultingId enviado) para ela; sem atendimento, cria um nessa coluna com consultingSubject, consultingTags e consultingRegister. null remove da coluna. 404 se a coluna não for do escritório"},"consultingSubject":{"type":"string","maxLength":255,"description":"Título do atendimento criado com consultingColumnId quando a pessoa ainda não tem atendimento (padrão: nome da pessoa). Ignorado ao mover um atendimento existente"},"consultingTags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das etiquetas do atendimento criado com consultingColumnId quando a pessoa ainda não tem atendimento. Ignorado ao mover um atendimento existente"},"consultingRegister":{"type":"string","description":"Primeiro registro (HTML) do atendimento criado com consultingColumnId quando a pessoa ainda não tem atendimento. Ignorado ao mover um atendimento existente"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"array","items":{"type":"string","maxLength":100},"maxItems":500}],"nullable":true,"description":"Valor do campo. Envie null para limpar"}},"required":["fieldId","value"],"additionalProperties":false},"maxItems":100,"description":"Valores dos campos personalizados do escritório"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da pessoa"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"},"isLinkedToJurichat":{"type":"boolean"},"email":{"type":"string","nullable":true,"description":"E-mail"},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ"},"phone":{"type":"string","nullable":true,"description":"Telefone"},"personOrigin":{"type":"string","nullable":true,"description":"Nome do tipo de pessoa"},"personOriginId":{"type":"string","format":"uuid","nullable":true,"description":"ID do tipo de pessoa"},"systemKey":{"type":"string","enum":["CLIENTE","REQUERIDA"],"nullable":true,"description":"Tipo de sistema, quando a pessoa usa Cliente ou Requerida"},"personType":{"type":"string","nullable":true,"description":"Tipo. Ex: física, jurídica"},"maritalStatus":{"type":"string","nullable":true,"description":"Estado civil"},"zipCode":{"type":"string","nullable":true,"description":"CEP"},"state":{"type":"string","nullable":true,"description":"Estado"},"city":{"type":"string","nullable":true,"description":"Cidade"},"neighborhood":{"type":"string","nullable":true,"description":"Bairro"},"streetAndNumber":{"type":"string","nullable":true,"description":"Rua e número"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"},"clientDiscoverOffice":{"type":"string","nullable":true,"description":"Como conheceu o escritório"},"annotation":{"description":"Anotações"},"officeId":{"type":"string","description":"ID do escritório"},"rg":{"type":"string","nullable":true,"description":"RG"},"nationality":{"type":"string","nullable":true,"description":"Nacionalidade"},"profession":{"type":"string","nullable":true,"description":"Profissão"},"birthDate":{"type":"string","nullable":true,"description":"Data de nascimento"},"isPrivate":{"type":"boolean","nullable":true,"description":"Registro privado"},"ownerId":{"type":"string","nullable":true,"description":"ID do responsável"},"legalRepresentant":{"type":"string","nullable":true,"description":"Representante legal"},"corretor":{"type":"string","nullable":true,"description":"Corretor"},"code":{"type":"string","nullable":true,"description":"Código interno"},"govPassword":{"type":"string","nullable":true,"description":"Senha gov.br"},"addressComplement":{"type":"string","nullable":true,"description":"Complemento do endereço"},"linkedPersons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"personOrigin":{"type":"string","nullable":true}},"required":["id","name","personOrigin"],"additionalProperties":false},"description":"Pessoas vinculadas visíveis ao usuário (em qualquer sentido do vínculo)"},"consultingId":{"type":"string","format":"uuid","nullable":true,"description":"Atendimento atual da pessoa. No POST/PATCH com consultingColumnId, é o atendimento criado ou movido"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Data de criação"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Data da última alteração"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string"},"options":{"type":"array","items":{"type":"string"},"nullable":true},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}]},"isArchived":{"type":"boolean"}},"required":["fieldId","name","type","options","value","isArchived"],"additionalProperties":false},"description":"Valores dos campos personalizados do escritório"}},"required":["id","name","officeId"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir pessoa","tags":["Persons"],"parameters":[{"schema":{"type":"boolean"},"in":"query","name":"deleteLawSuit","required":false,"description":"true para excluir processos vinculados"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da pessoa"}],"security":[{"apiKeyAuth":[]}],"responses":{"204":{"description":"Sem conteúdo","content":{"application/json":{"schema":{"enum":["null"],"nullable":true,"description":"Sem conteúdo"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/person/batch-update":{"patch":{"summary":"Atualizar pessoas em lote","tags":["Persons"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs das pessoas"},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das tags a adicionar"}},"required":["ids"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"number"}},"required":["updated"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/person-origin/":{"get":{"summary":"Listar tipos de pessoa","tags":["Person origins"],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do tipo"},"name":{"type":"string","description":"Nome exibido"},"systemKey":{"type":"string","enum":["CLIENTE","REQUERIDA"],"nullable":true,"description":"Tipo de sistema, quando houver"},"position":{"type":"number","description":"Ordem de exibição"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","systemKey","position","officeId","createdAt","updatedAt"],"additionalProperties":true},"description":"Tipos de pessoa do escritório"}},"required":["data"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar tipo de pessoa","tags":["Person origins"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do tipo"}},"required":["name"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do tipo"},"name":{"type":"string","description":"Nome exibido"},"systemKey":{"type":"string","enum":["CLIENTE","REQUERIDA"],"nullable":true,"description":"Tipo de sistema, quando houver"},"position":{"type":"number","description":"Ordem de exibição"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","systemKey","position","officeId","createdAt","updatedAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/person-origin/{id}":{"patch":{"summary":"Renomear tipo de pessoa","tags":["Person origins"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Novo nome do tipo"}},"required":["name"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do tipo"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do tipo"},"name":{"type":"string","description":"Nome exibido"},"systemKey":{"type":"string","enum":["CLIENTE","REQUERIDA"],"nullable":true,"description":"Tipo de sistema, quando houver"},"position":{"type":"number","description":"Ordem de exibição"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","systemKey","position","officeId","createdAt","updatedAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir tipo de pessoa","tags":["Person origins"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do tipo"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do tipo removido"},"unlinked":{"type":"number","description":"Pessoas desvinculadas do tipo"}},"required":["id","unlinked"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/person-custom-fields/":{"get":{"summary":"Listar campos personalizados de pessoas","tags":["Person Custom Fields"],"description":"Lista as definições de campos personalizados de pessoas do escritório, incluindo as arquivadas. O `id` devolvido aqui é o `fieldId` usado em `customFields` ao criar ou atualizar uma pessoa.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"requiredPersonOriginIds":{"type":"array","items":{"type":"string"},"description":"Origens em que o campo é obrigatório. Vazio = todas. Só vale com isRequired"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","requiredPersonOriginIds","createdAt","updatedAt"],"additionalProperties":false}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar campo personalizado de pessoas","tags":["Person Custom Fields"],"description":"Cria uma definição de campo personalizado de pessoas. Os tipos `select` e `multiSelect` exigem `options` (até 500, sem repetir); os demais recusam `options`. O limite é de 100 campos ativos por escritório.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":100},"minItems":1,"maxItems":500,"description":"Opções, quando o tipo aceita"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"requiredPersonOriginIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":100,"description":"Origens em que o campo é obrigatório. Vazio = todas. Só vale com isRequired"}},"required":["name","type"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"requiredPersonOriginIds":{"type":"array","items":{"type":"string"},"description":"Origens em que o campo é obrigatório. Vazio = todas. Só vale com isRequired"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","requiredPersonOriginIds","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/person-custom-fields/{id}":{"patch":{"summary":"Atualizar campo personalizado de pessoas","tags":["Person Custom Fields"],"description":"Altera um campo personalizado de pessoas: `name`, `options` (só `select` e `multiSelect`), `isRequired` e `requiredPersonOriginIds`; informe ao menos um. O tipo não muda depois de criado. `options` é a lista completa, com até 500 opções: acrescentar é livre; tirar uma opção só é aceito se nenhuma pessoa a usa — opção em uso responde 400 com a quantidade de registros.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do campo"},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":100},"minItems":1,"maxItems":500,"description":"Opções, quando o tipo aceita"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"requiredPersonOriginIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":100,"description":"Origens em que o campo é obrigatório. Vazio = todas. Só vale com isRequired"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do campo personalizado"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"requiredPersonOriginIds":{"type":"array","items":{"type":"string"},"description":"Origens em que o campo é obrigatório. Vazio = todas. Só vale com isRequired"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","requiredPersonOriginIds","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Arquivar campo personalizado de pessoas","tags":["Person Custom Fields"],"description":"Arquiva o campo: ele deixa de ser oferecido em novas pessoas, e os valores já gravados são preservados. Responde 204 sem corpo.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do campo personalizado"}],"security":[{"apiKeyAuth":[]}],"responses":{"204":{"description":"Campo arquivado.","content":{"application/json":{"schema":{"enum":["null"],"nullable":true,"description":"Campo arquivado."}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/consulting-custom-fields/":{"get":{"summary":"Listar campos personalizados de atendimentos e casos","tags":["Consulting Custom Fields"],"description":"Lista definições ativas do escritório para preenchimento em atendimentos e casos.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","createdAt","updatedAt"],"additionalProperties":false}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar campo personalizado de atendimentos e casos","tags":["Consulting Custom Fields"],"description":"Cria definição de campo para atendimentos e casos, limitada ao escritório autenticado. Os tipos `select` e `multiSelect` exigem `options` (até 500, sem repetir); os demais recusam `options`.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":100},"minItems":1,"maxItems":500,"description":"Opções, quando o tipo aceita"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"}},"required":["name","type"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/consulting-custom-fields/{id}":{"patch":{"summary":"Atualizar campo personalizado de atendimentos e casos","tags":["Consulting Custom Fields"],"description":"Altera um campo de atendimentos e casos: `name`, `options` (só `select` e `multiSelect`) e `isRequired`; informe ao menos um. O tipo não muda depois de criado. `options` é a lista completa, com até 500 opções: acrescentar é livre; tirar uma opção só é aceito se nenhum atendimento a usa — opção em uso responde 400 com a quantidade de registros.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Nome do campo"},"options":{"type":"array","items":{"type":"string","minLength":1,"maxLength":100},"minItems":1,"maxItems":500,"description":"Opções, quando o tipo aceita"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do campo personalizado"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"name":{"type":"string","description":"Nome do campo"},"type":{"type":"string","enum":["text","longText","date","time","dateTime","number","select","multiSelect"],"description":"Tipo do campo"},"options":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Opções, quando o tipo aceita"},"isArchived":{"type":"boolean","description":"Campo arquivado"},"isRequired":{"type":"boolean","description":"Obrigatório ao criar o item pelo app ou pela API"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última alteração"}},"required":["id","name","type","options","isArchived","isRequired","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Arquivar campo personalizado de atendimentos e casos","tags":["Consulting Custom Fields"],"description":"Arquiva definição sem apagar valores já registrados em atendimentos e casos.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do campo personalizado"}],"security":[{"apiKeyAuth":[]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{"enum":["null"],"nullable":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task/":{"get":{"summary":"Listar tarefas","tags":["Tasks"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"title","required":false,"description":"Filtra por título"},{"schema":{"type":"string"},"in":"query","name":"responsible","required":false,"description":"Filtra por responsável"},{"schema":{"type":"string"},"in":"query","name":"priority","required":false,"description":"Filtra por prioridade"},{"schema":{"type":"string"},"in":"query","name":"lawSuit","required":false,"description":"Filtra por processo"},{"schema":{"type":"string"},"in":"query","name":"workflowId","required":false,"description":"Filtra por workflow"},{"schema":{"type":"string"},"in":"query","name":"workflowInstanceId","required":false,"description":"Filtra por execução de workflow"},{"schema":{"type":"string","enum":["ANY","CREATED"]},"in":"query","name":"workflowMatch","required":false,"description":"Com workflowId: ANY (tudo com vínculo com a automação) ou CREATED (padrão, só o que ela criou)"},{"schema":{"type":"string"},"in":"query","name":"taskTemplateId","required":false,"description":"Filtra pelo modelo que criou a tarefa"},{"schema":{"type":"string"},"in":"query","name":"isHome","required":false,"description":"true para tarefas da home"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc"},{"schema":{"type":"string"},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação"},{"schema":{"type":"string"},"in":"query","name":"isUniqueResponsible","required":false,"description":"true para responsável único"},{"schema":{"type":"string"},"in":"query","name":"isArchived","required":false,"description":"true ou false"},{"schema":{"type":"string"},"in":"query","name":"isPrivate","required":false,"description":"true ou false"},{"schema":{"type":"string"},"in":"query","name":"start","required":false,"description":"Data inicial do filtro"},{"schema":{"type":"string"},"in":"query","name":"end","required":false,"description":"Data final do filtro"},{"schema":{"type":"string"},"in":"query","name":"tag","required":false,"description":"Filtra por tag"},{"schema":{"type":"string","enum":["all","initialDate","finalDate","completedAt","subtaskFinalDate","createdAt"]},"in":"query","name":"dateMethod","required":false,"description":"Método de filtro por data"},{"schema":{"type":"string"},"in":"query","name":"personId","required":false,"description":"Filtra por pessoa"},{"schema":{"type":"string"},"in":"query","name":"points","required":false,"description":"Filtra por pontos"},{"schema":{"type":"string"},"in":"query","name":"parentTaskId","required":false,"description":"ID da tarefa pai"},{"schema":{"type":"string"},"in":"query","name":"taskColumnId","required":false,"description":"ID da coluna"},{"schema":{"type":"string"},"in":"query","name":"folderId","required":false,"description":"ID da pasta do kanban"},{"schema":{"type":"string"},"in":"query","name":"boardId","required":false,"description":"ID do quadro kanban"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"taskKanbanColumnIds","required":false,"description":"IDs das colunas kanban"},{"schema":{"type":"string"},"in":"query","name":"customFields","required":false,"description":"Filtro por campos personalizados, em JSON. Texto, número, hora e seleção: [{\"fieldId\":\"<id>\",\"value\":\"ABC\"}] (texto casa por \"contém\"; multiSelect aceita lista em value). Data e data/hora: [{\"fieldId\":\"<id>\",\"from\":\"2026-01-01\",\"to\":\"2026-01-31\"}]. Os itens se combinam em E. O fieldId vem da listagem de campos personalizados do módulo."}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da tarefa"},"title":{"type":"string","description":"Título"},"priority":{"type":"string","description":"Prioridade"},"status":{"type":"string","description":"Status"},"hasSheet":{"type":"boolean","description":"Possui apontamento (TimeSheet)"},"initialDate":{"type":"string","nullable":true,"description":"Data inicial"},"finalDate":{"type":"string","nullable":true,"description":"Data final"},"isArchived":{"type":"boolean","description":"Arquivada"},"isPrivate":{"type":"boolean","description":"Privada"},"ownerId":{"type":"string","description":"ID do criador"},"points":{"type":"number","description":"Pontos"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data de arquivamento (ISO): o primeiro arquivamento entre a tarefa e a coluna, o quadro e a pasta arquivados dela; a data de um desses pais nunca é anterior à entrada da tarefa na coluna. null: nada arquivado, ou algum nível arquivado antes de existir o campo"}},"required":["id","title","priority"],"additionalProperties":true},"description":"Lista de tarefas"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar tarefa","tags":["Tasks"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Título"},"priority":{"type":"string","minLength":1,"description":"Prioridade"},"columnId":{"type":"string","format":"uuid","description":"ID da coluna kanban (`task_kanban_columns`). Obtenha em GET /tasks-columns?isSettings=true"},"initialDate":{"type":"string","description":"Data inicial"},"description":{"description":"Descrição em texto ou HTML, devolvida como enviada. Texto que já começa e termina com aspas duplas é tratado como delimitado e volta sem elas"},"finalDate":{"type":"string","description":"Data final"},"initialHour":{"type":"string","description":"Hora inicial"},"finalHour":{"type":"string","description":"Hora final"},"lawSuitId":{"type":"string","format":"uuid","nullable":true,"description":"ID do processo"},"responsiblesId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos responsáveis"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"isPrivate":{"type":"boolean","description":"Tarefa privada"},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das tags"},"points":{"type":"number","description":"Pontos"},"needValidation":{"type":"boolean","description":"Exige validação"},"isValidated":{"type":"boolean","description":"Já validada"},"validatorsId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos validadores"},"personIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das pessoas"},"estimatedTimeMinutes":{"type":"integer","minimum":0,"description":"Tempo estimado em minutos"},"createSheet":{"type":"boolean","description":"Cria o apontamento (TimeSheet) da tarefa ao criá-la"},"consultingId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID do CRM/atendimento vinculado"},"publicationMovementId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID da movimentação de publicação (o `id` de GET /publication) que originou a tarefa. Gravado como publicação de origem; movimentação de outro escritório ou inexistente: 404"},"taskTemplateId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID do modelo aplicado. Libera os pontos dele sem a permissão de pontuar e grava a origem da tarefa"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"array","items":{"type":"string","maxLength":100},"maxItems":500}],"nullable":true,"description":"Valor do campo — null limpa o valor gravado"}},"required":["fieldId","value"],"additionalProperties":false},"maxItems":100,"description":"Valores dos campos personalizados do escritório"}},"required":["title","priority","columnId","initialDate"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da tarefa"},"title":{"type":"string","description":"Título"},"priority":{"type":"string","description":"Prioridade"},"status":{"type":"string","description":"Status"},"hasSheet":{"type":"boolean","description":"Possui apontamento (TimeSheet)"},"initialDate":{"type":"string","nullable":true,"description":"Data inicial"},"finalDate":{"type":"string","nullable":true,"description":"Data final"},"isArchived":{"type":"boolean","description":"Arquivada"},"isPrivate":{"type":"boolean","description":"Privada"},"ownerId":{"type":"string","description":"ID do criador"},"points":{"type":"number","description":"Pontos"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string"},"options":{"type":"array","items":{"type":"string"},"nullable":true},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}]},"isArchived":{"type":"boolean"}},"required":["fieldId","name","type","options","value","isArchived"],"additionalProperties":false},"description":"Valores dos campos personalizados do escritório"}},"required":["id","title","priority"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir tarefas","tags":["Tasks"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs das tarefas"}},"required":["id"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task/kanban":{"get":{"summary":"Listar tarefas no kanban","tags":["Tasks"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"title","required":false,"description":"Filtra por título"},{"schema":{"type":"string"},"in":"query","name":"responsible","required":false,"description":"Filtra por responsável"},{"schema":{"type":"string"},"in":"query","name":"priority","required":false,"description":"Filtra por prioridade"},{"schema":{"type":"string"},"in":"query","name":"lawSuit","required":false,"description":"Filtra por processo"},{"schema":{"type":"string"},"in":"query","name":"workflowId","required":false,"description":"Filtra por workflow"},{"schema":{"type":"string"},"in":"query","name":"workflowInstanceId","required":false,"description":"Filtra por execução de workflow"},{"schema":{"type":"string","enum":["ANY","CREATED"]},"in":"query","name":"workflowMatch","required":false,"description":"Com workflowId: ANY (tudo com vínculo com a automação) ou CREATED (padrão, só o que ela criou)"},{"schema":{"type":"string"},"in":"query","name":"taskTemplateId","required":false,"description":"Filtra pelo modelo que criou a tarefa"},{"schema":{"type":"string"},"in":"query","name":"isHome","required":false,"description":"Filtra tarefas da home"},{"schema":{"type":"string"},"in":"query","name":"isUniqueResponsible","required":false,"description":"true ou false"},{"schema":{"type":"string"},"in":"query","name":"start","required":false,"description":"Data inicial"},{"schema":{"type":"string"},"in":"query","name":"end","required":false,"description":"Data final"},{"schema":{"type":"string"},"in":"query","name":"tag","required":false,"description":"Filtra por tag"},{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"status","required":false,"description":"Filtra por status"},{"schema":{"type":"string"},"in":"query","name":"points","required":false,"description":"Filtra por pontos"},{"schema":{"type":"string"},"in":"query","name":"parentTaskId","required":false,"description":"ID da tarefa pai"},{"schema":{"type":"string"},"in":"query","name":"orderBy","required":false,"description":"Ordenação"},{"schema":{"type":"string"},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação"},{"schema":{"type":"string"},"in":"query","name":"dateMethod","required":false,"description":"Método de filtro por data"},{"schema":{"type":"string"},"in":"query","name":"taskColumnId","required":false,"description":"ID da coluna"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"Pendente":{"type":"object","properties":{"name":{"type":"string","description":"Nome do status"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da tarefa"},"title":{"type":"string","description":"Título"},"priority":{"type":"string","description":"Prioridade"},"status":{"type":"string","description":"Status"},"hasSheet":{"type":"boolean","description":"Possui apontamento (TimeSheet)"},"initialDate":{"type":"string","nullable":true,"description":"Data inicial"},"finalDate":{"type":"string","nullable":true,"description":"Data final"},"isArchived":{"type":"boolean","description":"Arquivada"},"isPrivate":{"type":"boolean","description":"Privada"},"ownerId":{"type":"string","description":"ID do criador"},"points":{"type":"number","description":"Pontos"}},"required":["id","title","priority"],"additionalProperties":true},"description":"Tarefas"},"total":{"type":"number","description":"Total de tarefas"},"page":{"type":"number","description":"Página atual"},"hasMore":{"type":"boolean","description":"Possui mais páginas"}},"required":["name","items","total","page","hasMore"],"additionalProperties":false,"description":"Tarefas pendentes"},"Em progresso":{"type":"object","properties":{"name":{"type":"string","description":"Nome do status"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da tarefa"},"title":{"type":"string","description":"Título"},"priority":{"type":"string","description":"Prioridade"},"status":{"type":"string","description":"Status"},"hasSheet":{"type":"boolean","description":"Possui apontamento (TimeSheet)"},"initialDate":{"type":"string","nullable":true,"description":"Data inicial"},"finalDate":{"type":"string","nullable":true,"description":"Data final"},"isArchived":{"type":"boolean","description":"Arquivada"},"isPrivate":{"type":"boolean","description":"Privada"},"ownerId":{"type":"string","description":"ID do criador"},"points":{"type":"number","description":"Pontos"}},"required":["id","title","priority"],"additionalProperties":true},"description":"Tarefas"},"total":{"type":"number","description":"Total de tarefas"},"page":{"type":"number","description":"Página atual"},"hasMore":{"type":"boolean","description":"Possui mais páginas"}},"required":["name","items","total","page","hasMore"],"additionalProperties":false,"description":"Tarefas em progresso"},"Concluída":{"type":"object","properties":{"name":{"type":"string","description":"Nome do status"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da tarefa"},"title":{"type":"string","description":"Título"},"priority":{"type":"string","description":"Prioridade"},"status":{"type":"string","description":"Status"},"hasSheet":{"type":"boolean","description":"Possui apontamento (TimeSheet)"},"initialDate":{"type":"string","nullable":true,"description":"Data inicial"},"finalDate":{"type":"string","nullable":true,"description":"Data final"},"isArchived":{"type":"boolean","description":"Arquivada"},"isPrivate":{"type":"boolean","description":"Privada"},"ownerId":{"type":"string","description":"ID do criador"},"points":{"type":"number","description":"Pontos"}},"required":["id","title","priority"],"additionalProperties":true},"description":"Tarefas"},"total":{"type":"number","description":"Total de tarefas"},"page":{"type":"number","description":"Página atual"},"hasMore":{"type":"boolean","description":"Possui mais páginas"}},"required":["name","items","total","page","hasMore"],"additionalProperties":false,"description":"Tarefas concluídas"}},"required":["Pendente","Em progresso","Concluída"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/task/{id}":{"get":{"summary":"Buscar tarefa","tags":["Tasks"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página de arquivos"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Limite de arquivos"},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"includeFiles","required":false,"description":"Quando false, omite listagem GCS/DB de arquivos no first paint"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da tarefa"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da tarefa"},"title":{"type":"string","description":"Título"},"priority":{"type":"string","description":"Prioridade"},"status":{"type":"string","description":"Status"},"hasSheet":{"type":"boolean","description":"Possui apontamento (TimeSheet)"},"initialDate":{"type":"string","nullable":true,"description":"Data inicial"},"finalDate":{"type":"string","nullable":true,"description":"Data final"},"isArchived":{"type":"boolean","description":"Arquivada"},"isPrivate":{"type":"boolean","description":"Privada"},"ownerId":{"type":"string","description":"ID do criador"},"points":{"type":"number","description":"Pontos"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string"},"options":{"type":"array","items":{"type":"string"},"nullable":true},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}]},"isArchived":{"type":"boolean"}},"required":["fieldId","name","type","options","value","isArchived"],"additionalProperties":false},"description":"Valores dos campos personalizados do escritório"}},"required":["id","title","priority"],"additionalProperties":true}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar tarefa","tags":["Tasks"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Título"},"priority":{"type":"string","minLength":1,"description":"Prioridade"},"status":{"type":"string","minLength":1,"description":"Status"},"initialDate":{"type":"string","description":"Data inicial"},"lawSuitId":{"type":"string","format":"uuid","nullable":true,"description":"ID do processo"},"responsiblesId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos responsáveis"},"isArchived":{"type":"boolean","description":"Arquivada"},"isPrivate":{"type":"boolean","description":"Privada"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"description":{"description":"Descrição em texto ou HTML, devolvida como enviada. Texto que já começa e termina com aspas duplas é tratado como delimitado e volta sem elas"},"finalDate":{"type":"string","nullable":true,"description":"Data final"},"initialHour":{"type":"string","nullable":true,"description":"Hora inicial"},"finalHour":{"type":"string","nullable":true,"description":"Hora final"},"currentIndex":{"type":"number","description":"Índice na coluna kanban"},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das tags"},"points":{"type":"number","description":"Pontos"},"taskTemplateId":{"type":"string","format":"uuid","description":"ID do modelo aplicado (libera os pontos dele sem a permissão de pontuar)"},"needValidation":{"type":"boolean","description":"Exige validação"},"isValidated":{"type":"boolean","description":"Já validada"},"validatorsId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos validadores"},"personIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das pessoas"},"estimatedTimeMinutes":{"type":"integer","minimum":0,"description":"Tempo estimado em minutos"},"columnId":{"type":"string","format":"uuid","description":"ID da coluna kanban"},"consultingId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID do CRM/atendimento vinculado (null para desvincular)"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"array","items":{"type":"string","maxLength":100},"maxItems":500}],"nullable":true,"description":"Valor do campo — null limpa o valor gravado"}},"required":["fieldId","value"],"additionalProperties":false},"maxItems":100,"description":"Valores dos campos personalizados do escritório"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da tarefa"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da tarefa"},"title":{"type":"string","description":"Título"},"priority":{"type":"string","description":"Prioridade"},"status":{"type":"string","description":"Status"},"hasSheet":{"type":"boolean","description":"Possui apontamento (TimeSheet)"},"initialDate":{"type":"string","nullable":true,"description":"Data inicial"},"finalDate":{"type":"string","nullable":true,"description":"Data final"},"isArchived":{"type":"boolean","description":"Arquivada"},"isPrivate":{"type":"boolean","description":"Privada"},"ownerId":{"type":"string","description":"ID do criador"},"points":{"type":"number","description":"Pontos"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string"},"options":{"type":"array","items":{"type":"string"},"nullable":true},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}]},"isArchived":{"type":"boolean"}},"required":["fieldId","name","type","options","value","isArchived"],"additionalProperties":false},"description":"Valores dos campos personalizados do escritório"}},"required":["id","title","priority"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task/{id}/view":{"post":{"summary":"Registrar abertura da tarefa no histórico","tags":["Tasks"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da tarefa"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando registrado","content":{"application/json":{"schema":{"type":"string","description":"ok quando registrado"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task/{id}/workflow-releases":{"get":{"summary":"Automações paradas esperando esta tarefa que podem ser liberadas nela","tags":["Tasks"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da tarefa"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"instanceId":{"type":"string"},"workflowId":{"type":"string"},"workflowName":{"type":"string"},"stepId":{"type":"string"},"nextStepId":{"type":"string"},"nextStepLabel":{"type":"string"},"kind":{"type":"string","enum":["HELD_BY_STEP","WAITING_NEXT"]}},"required":["instanceId","workflowId","workflowName","stepId","nextStepId","nextStepLabel","kind"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task/{id}/workflow-releases/{instanceId}":{"post":{"summary":"Continuar a automação sem concluir a tarefa","tags":["Tasks"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da tarefa"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"instanceId","required":true,"description":"ID da execução da automação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"released":{"type":"boolean"}},"required":["released"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task/batch-update":{"patch":{"summary":"Arquivar ou desarquivar tarefas em lote","tags":["Tasks"],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da tarefa"},"isArchived":{"type":"boolean","description":"Arquivada"}},"required":["id","isArchived"],"additionalProperties":false},"minItems":1,"description":"Tarefas a atualizar"}}},"description":"Tarefas a atualizar"},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"number"}},"required":["updated"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task/kanban/{id}":{"patch":{"summary":"Atualizar posição de tarefa no kanban","tags":["Tasks"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"columnId":{"type":"string","format":"uuid","description":"ID da coluna"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"currentIndex":{"type":"integer","minimum":0,"description":"Índice atual na coluna"},"isSameColumnReorder":{"type":"boolean","description":"Reordenar na mesma coluna"}},"required":["columnId","officeId","currentIndex"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da tarefa"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Operação concluída"}},"required":["success"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task/subtasks":{"post":{"summary":"Criar subtarefa","tags":["Tasks"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Título"},"description":{"description":"Descrição em texto ou HTML, devolvida como enviada"},"status":{"type":"string","minLength":1,"description":"Status"},"initialDate":{"type":"string","description":"Data inicial"},"finalDate":{"type":"string","description":"Data final"},"taskId":{"type":"string","format":"uuid","description":"ID da tarefa pai"},"responsiblesId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos responsáveis"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"priority":{"type":"string","minLength":1,"description":"Prioridade"},"points":{"type":"number","description":"Pontos"},"taskTemplateId":{"type":"string","format":"uuid","description":"ID do modelo aplicado (libera os pontos dele sem a permissão de pontuar)"},"createSheet":{"type":"boolean","description":"Cria o apontamento (TimeSheet) da subtarefa ao criá-la"}},"required":["title","status","initialDate","taskId","priority"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir subtarefas","tags":["Tasks"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs das subtarefas"}},"required":["id"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task/subtasks/{id}":{"patch":{"summary":"Atualizar subtarefa","tags":["Tasks"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Título"},"description":{"description":"Descrição em texto ou HTML, devolvida como enviada"},"status":{"type":"string","minLength":1,"description":"Status"},"initialDate":{"type":"string","description":"Data inicial"},"finalDate":{"type":"string","description":"Data final"},"taskId":{"type":"string","format":"uuid","description":"ID da tarefa pai"},"responsiblesId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos responsáveis"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"priority":{"type":"string","minLength":1,"description":"Prioridade"},"points":{"type":"number","description":"Pontos"},"completeTaskColumnId":{"type":"string","format":"uuid","description":"Coluna (do quadro da tarefa pai) para onde mover a tarefa pai se esta for a última subtarefa a ser concluída"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da subtarefa"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task/task-templates":{"get":{"summary":"Listar modelos de tarefa","tags":["Tasks"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"keySearch","required":false,"description":"Filtra por título"},{"schema":{"type":"number","default":1},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"number","default":10},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"in":"query","name":"orderBy","required":false,"description":"Ordenação por título"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"tagIds","required":false,"description":"Ids de etiquetas separados por vírgula: modelos com qualquer uma delas"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true},"description":"Lista de modelos de tarefa"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar modelo de tarefa","tags":["Tasks"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string"},"title":{"type":"string"},"points":{"type":"number"},"priority":{"type":"string"},"daysForDue":{"type":"number"},"daysForStart":{"type":"number"},"createSheet":{"type":"boolean"},"estimatedTimeMinutes":{"type":"number"},"tags":{"type":"array","items":{"type":"string"}},"responsiblesId":{"type":"array","items":{"type":"string"}},"isBusinessDay":{"type":"boolean"},"columnId":{"type":"string","format":"uuid","nullable":true},"subtasks":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"priority":{"type":"string"},"daysForDue":{"type":"number"},"isBusinessDay":{"type":"boolean"},"points":{"type":"number"},"responsiblesId":{"type":"array","items":{"type":"string"}}},"required":["title","description","status","priority","daysForDue","isBusinessDay","responsiblesId"],"additionalProperties":false}}},"required":["description","title","points","priority","daysForDue","tags","responsiblesId","isBusinessDay"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task/task-templates/{id}":{"patch":{"summary":"Atualizar modelo de tarefa","tags":["Tasks"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string"},"title":{"type":"string"},"points":{"type":"number"},"priority":{"type":"string"},"daysForDue":{"type":"number"},"daysForStart":{"type":"number"},"createSheet":{"type":"boolean"},"estimatedTimeMinutes":{"type":"number"},"columnId":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"responsiblesId":{"type":"array","items":{"type":"string"}},"isBusinessDay":{"type":"boolean"},"subtasks":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"priority":{"type":"string"},"daysForDue":{"type":"number"},"isBusinessDay":{"type":"boolean"},"points":{"type":"number"},"responsiblesId":{"type":"array","items":{"type":"string"}}},"required":["title","description","status","priority","daysForDue","isBusinessDay","responsiblesId"],"additionalProperties":false}}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do modelo de tarefa"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir modelo de tarefa","tags":["Tasks"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do modelo de tarefa"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/tasks-columns/":{"get":{"summary":"Listar colunas do kanban de tarefas","tags":["Tasks"],"description":"Retorna colunas do kanban atual (`task_kanban_columns`) para obter `columnId` em `POST /task`. Prefira `isSettings=true` para metadados (id, nome, quadro, pasta) sem carregar tarefas. Escritórios antigos sem kanban caem no legado `tasks_columns`.","parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra por nome da coluna"},{"schema":{"type":"string"},"in":"query","name":"title","required":false},{"schema":{"type":"string"},"in":"query","name":"priority","required":false},{"schema":{"type":"string"},"in":"query","name":"status","required":false},{"schema":{"type":"string"},"in":"query","name":"isPrivate","required":false,"description":"true ou false"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"taskColumnId","required":false},{"schema":{"type":"string"},"in":"query","name":"isSettings","required":false,"description":"true = só metadados das colunas (recomendado para obter columnId)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"columns":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da coluna kanban — use como columnId em POST /task"},"name":{"type":"string","nullable":true},"index":{"type":"number","nullable":true},"officeId":{"type":"string"},"boardId":{"type":"string","format":"uuid","description":"ID do quadro kanban"},"boardName":{"type":"string","description":"Nome do quadro kanban"},"folderId":{"type":"string","format":"uuid","description":"ID da pasta kanban"},"folderName":{"type":"string","description":"Nome da pasta kanban"},"hexColor":{"type":"string"},"isDoneColumn":{"type":"boolean"},"isFirstColumn":{"type":"boolean"},"tasks":{"type":"array","items":{}},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]}},"required":["id","name"],"additionalProperties":true},"description":"Mapa id → coluna. Use o id como columnId em POST /task"},"total":{"type":"number","description":"Total de colunas"}},"required":["columns","total"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/typeAction/":{"get":{"summary":"Listar tipos de ação","tags":["Type Actions"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra por nome"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do tipo de ação"},"name":{"type":"string","description":"Nome"},"actionGroupId":{"type":"string","description":"ID do grupo de ação"},"actionGroupName":{"type":"string","nullable":true,"description":"Nome do grupo de ação"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","actionGroupId","officeId","updatedAt","createdAt"],"additionalProperties":true},"description":"Lista de tipos de ação"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar tipo de ação","tags":["Type Actions"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome"},"actionGroupId":{"type":"string","format":"uuid","description":"ID do grupo de ação"}},"required":["name","actionGroupId"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do tipo de ação"},"name":{"type":"string","description":"Nome"},"actionGroupId":{"type":"string","description":"ID do grupo de ação"},"actionGroupName":{"type":"string","nullable":true,"description":"Nome do grupo de ação"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","actionGroupId","officeId","updatedAt","createdAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir tipos de ação","tags":["Type Actions"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs dos tipos de ação"}},"required":["id"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/typeAction/{id}":{"get":{"summary":"Buscar tipo de ação","tags":["Type Actions"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do tipo de ação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do tipo de ação"},"name":{"type":"string","description":"Nome"},"actionGroupId":{"type":"string","description":"ID do grupo de ação"},"actionGroupName":{"type":"string","nullable":true,"description":"Nome do grupo de ação"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","actionGroupId","officeId","updatedAt","createdAt"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar tipo de ação","tags":["Type Actions"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome"},"actionGroupId":{"type":"string","format":"uuid","description":"ID do grupo de ação"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do tipo de ação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do tipo de ação"},"name":{"type":"string","description":"Nome"},"actionGroupId":{"type":"string","description":"ID do grupo de ação"},"actionGroupName":{"type":"string","nullable":true,"description":"Nome do grupo de ação"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","actionGroupId","officeId","updatedAt","createdAt"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/user/me":{"get":{"summary":"Me","tags":["Users"],"parameters":[{"schema":{"type":"string","enum":["office","user"]},"in":"query","name":"scope","required":false,"description":"user, office ou vazio para retornar os dois"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"office":{"type":"object","properties":{"id":{"type":"string","description":"ID do escritório"},"name":{"type":"string","nullable":true,"description":"Nome do escritório"},"email":{"type":"string","description":"E-mail do escritório"},"logo":{"type":"string","nullable":true,"description":"URL do logo"},"site":{"type":"string","nullable":true,"description":"Site"},"document":{"type":"string","nullable":true,"description":"CNPJ do escritório"},"contact":{"type":"string","nullable":true,"description":"Contato"},"isArchived":{"type":"boolean","description":"Escritório arquivado"},"referralToken":{"type":"string","nullable":true,"description":"Token de indicação"},"archivedAt":{"type":"string","nullable":true,"description":"Data do arquivamento"},"onboardingEmailSent":{"type":"number","nullable":true,"description":"E-mails de onboarding enviados"},"isDefaultDataImported":{"type":"boolean","nullable":true,"description":"Dados padrão importados"},"hasPromotion":{"type":"boolean","nullable":true,"description":"Tem promoção ativa"},"trainingRewardsEnabled":{"type":"boolean","description":"Programa de créditos por treinamento ligado"},"productivityReportsDate":{"type":"string","nullable":true,"description":"Data dos relatórios de produtividade"},"autoCompleteCalendarItems":{"type":"boolean","nullable":true,"description":"Completar itens do calendário automaticamente"},"practiceAreas":{"type":"array","items":{"type":"string"},"description":"Áreas de atuação"},"sizeBand":{"type":"string","nullable":true,"description":"Faixa de tamanho do escritório"},"stateUf":{"type":"string","nullable":true,"description":"UF do escritório"},"timezone":{"type":"string","description":"Fuso horário do escritório"},"onboardingVersion":{"type":"number","nullable":true,"description":"Versão do onboarding (2 = /comecar)"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"}},"required":["id","name","email","logo","site","document","contact","isArchived","referralToken","onboardingEmailSent","isDefaultDataImported","hasPromotion","trainingRewardsEnabled","productivityReportsDate","autoCompleteCalendarItems","practiceAreas","sizeBand","stateUf","timezone","onboardingVersion","createdAt"],"additionalProperties":false,"description":"Dados do escritório"},"user":{"type":"object","properties":{"id":{"type":"string","description":"ID do usuário"},"name":{"type":"string","description":"Nome completo"},"email":{"type":"string","description":"E-mail de login"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"},"firstLogin":{"type":"boolean","description":"Primeiro acesso pendente"},"showBannerAsaas":{"type":"boolean","description":"Exibir banner Asaas"},"role":{"type":"string","description":"Cargo no escritório"},"referralToken":{"type":"string","nullable":true,"description":"Token de indicação"},"googleIntegrationType":{"type":"string","nullable":true,"description":"Tipo de integração Google Calendar"},"emailVerifiedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data da confirmação do e-mail"},"oabNumber":{"type":"string","nullable":true,"description":"OAB informada no cadastro"},"profile":{"type":"object","properties":{"id":{"type":"string","description":"ID do perfil"},"name":{"type":"string","description":"Nome do perfil"},"permissions":{"description":"Permissões do perfil"}},"required":["id","name"],"additionalProperties":false}},"required":["id","name","email","imageUrl","firstLogin","showBannerAsaas","role","referralToken","googleIntegrationType","emailVerifiedAt","oabNumber","profile"],"additionalProperties":false,"description":"Dados do usuário"},"onboarding":{"type":"object","properties":{"flow":{"type":"string","enum":["owner","invitee"],"nullable":true,"description":"Fluxo do usuário"},"state":{"type":"string","nullable":true,"description":"Estado atual do fluxo"},"mustResume":{"type":"boolean","description":"Levar o usuário para /comecar"}},"required":["flow","state","mustResume"],"additionalProperties":false,"description":"Onboarding v2 do usuário"}},"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/user/":{"get":{"summary":"Listar usuários","tags":["Users"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra por nome"},{"schema":{"type":"string"},"in":"query","name":"profile","required":false,"description":"Filtra por nome do perfil"},{"schema":{"type":"string"},"in":"query","name":"orderBy","required":false,"description":"Ordenação por criação. asc ou desc"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do usuário"},"name":{"type":"string","description":"Nome completo"},"email":{"type":"string","description":"E-mail de login"},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ"},"contact":{"type":"string","nullable":true,"description":"Telefone ou contato"},"role":{"type":"string","description":"Cargo no escritório"},"admissionDate":{"type":"string","nullable":true,"description":"Data de admissão"},"resignationDate":{"type":"string","nullable":true,"description":"Data de demissão"},"dateOfBirth":{"type":"string","nullable":true,"description":"Data de nascimento"},"ctpsNumber":{"type":"string","nullable":true,"description":"Número da CTPS"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"},"oabNumber":{"type":"string","nullable":true,"description":"Número da OAB"},"personType":{"type":"string","nullable":true,"description":"Tipo de pessoa: PF ou PJ"},"salary":{"type":"string","nullable":true,"description":"Salário"},"description":{"type":"string","nullable":true,"description":"Descrição do colaborador: funções, áreas de atuação e tipos de caso que assume. Use para sugerir o responsável de tarefas e processos"},"postalCode":{"type":"string","nullable":true,"description":"CEP"},"addressNumber":{"type":"string","nullable":true,"description":"Número do endereço"},"firstLogin":{"type":"boolean","nullable":true,"description":"Primeiro acesso pendente"},"showBannerAsaas":{"type":"boolean","nullable":true,"description":"Exibir banner Asaas"},"officeId":{"type":"string","description":"ID do escritório"},"referralToken":{"type":"string","nullable":true,"description":"Token de indicação"},"googleIntegrationType":{"type":"string","enum":["full-sync"],"nullable":true,"description":"Tipo de integração Google"},"profile":{"type":"object","properties":{"id":{"type":"string","description":"ID do perfil"},"name":{"type":"string","description":"Nome do perfil"}},"required":["id","name"],"additionalProperties":false},"createdAt":{"type":"string","description":"Data de criação (ISO 8601)"},"updatedAt":{"type":"string","description":"Data da última alteração (ISO 8601)"},"hasGoogleLinked":{"type":"boolean","description":"Possui conta Google vinculada"},"googleEmail":{"type":"string","nullable":true,"description":"E-mail da conta Google vinculada"},"hasPassword":{"type":"boolean","description":"Possui senha cadastrada"},"calendarColor":{"type":"string","nullable":true,"description":"Cor da agenda do usuário (hex); null = sem cor"},"calendarSharing":{"type":"string","enum":["NONE","FREE_BUSY","READ","WRITE"],"description":"O que os colegas veem da agenda: NONE, FREE_BUSY (\"Ocupado\"), READ ou WRITE (com edição); ausente = WRITE"}},"required":["id","name","email","role","officeId","profile","createdAt","updatedAt","hasGoogleLinked","hasPassword"],"additionalProperties":false},"description":"Lista de usuários"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar usuário","tags":["Users"],"description":"Cria um usuário no escritório da chave. O e-mail é único entre todos os escritórios (um usuário excluído que ainda pode ser restaurado também ocupa o e-mail). O profileId precisa ser um perfil deste escritório; officeId é opcional e, se enviado, precisa ser o do escritório da chave. document vazio é aceito; preenchido, segue personType: PF ou Pessoa Física exige CPF de 11 dígitos, PJ ou Pessoa Jurídica exige CNPJ de 14 caracteres e, sem personType, vale um dos dois. A descrição do colaborador orienta a IA na escolha do responsável.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome completo"},"email":{"type":"string","format":"email","description":"E-mail de login"},"password":{"type":"string","minLength":1,"description":"Senha de acesso"},"document":{"type":"string","description":"CPF ou CNPJ"},"contact":{"type":"string","description":"Telefone ou contato"},"role":{"type":"string","description":"Cargo no escritório"},"profileId":{"type":"string","format":"uuid","description":"ID do perfil de permissões"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"admissionDate":{"type":"string","description":"Data de admissão"},"resignationDate":{"type":"string","description":"Data de demissão"},"dateOfBirth":{"type":"string","description":"Data de nascimento"},"ctpsNumber":{"type":"string","description":"Número da CTPS"},"imageUrl":{"type":"string","description":"URL da foto"},"oabNumber":{"type":"string","description":"Número da OAB"},"personType":{"type":"string","description":"Tipo de pessoa: PF ou PJ"},"salary":{"type":"string","description":"Salário"},"description":{"type":"string","maxLength":1000,"nullable":true,"description":"Descrição do colaborador: funções, áreas de atuação e tipos de caso que assume. Até 1000 caracteres; espaços nas pontas são removidos e texto em branco grava nulo"},"postalCode":{"type":"string","description":"CEP"},"addressNumber":{"type":"string","description":"Número do endereço"},"kanbanBoardsIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos quadros Kanban"}},"required":["name","email","password","document","contact","profileId"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do usuário"},"name":{"type":"string","description":"Nome completo"},"email":{"type":"string","description":"E-mail de login"},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ"},"contact":{"type":"string","nullable":true,"description":"Telefone ou contato"},"role":{"type":"string","description":"Cargo no escritório"},"admissionDate":{"type":"string","nullable":true,"description":"Data de admissão"},"resignationDate":{"type":"string","nullable":true,"description":"Data de demissão"},"dateOfBirth":{"type":"string","nullable":true,"description":"Data de nascimento"},"ctpsNumber":{"type":"string","nullable":true,"description":"Número da CTPS"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"},"oabNumber":{"type":"string","nullable":true,"description":"Número da OAB"},"personType":{"type":"string","nullable":true,"description":"Tipo de pessoa: PF ou PJ"},"salary":{"type":"string","nullable":true,"description":"Salário"},"description":{"type":"string","nullable":true,"description":"Descrição do colaborador: funções, áreas de atuação e tipos de caso que assume. Use para sugerir o responsável de tarefas e processos"},"postalCode":{"type":"string","nullable":true,"description":"CEP"},"addressNumber":{"type":"string","nullable":true,"description":"Número do endereço"},"firstLogin":{"type":"boolean","nullable":true,"description":"Primeiro acesso pendente"},"showBannerAsaas":{"type":"boolean","nullable":true,"description":"Exibir banner Asaas"},"officeId":{"type":"string","description":"ID do escritório"},"referralToken":{"type":"string","nullable":true,"description":"Token de indicação"},"googleIntegrationType":{"type":"string","enum":["full-sync"],"nullable":true,"description":"Tipo de integração Google"},"profile":{"type":"object","properties":{"id":{"type":"string","description":"ID do perfil"},"name":{"type":"string","description":"Nome do perfil"}},"required":["id","name"],"additionalProperties":false},"createdAt":{"type":"string","description":"Data de criação (ISO 8601)"},"updatedAt":{"type":"string","description":"Data da última alteração (ISO 8601)"},"hasGoogleLinked":{"type":"boolean","description":"Possui conta Google vinculada"},"googleEmail":{"type":"string","nullable":true,"description":"E-mail da conta Google vinculada"},"hasPassword":{"type":"boolean","description":"Possui senha cadastrada"},"calendarColor":{"type":"string","nullable":true,"description":"Cor da agenda do usuário (hex); null = sem cor"},"calendarSharing":{"type":"string","enum":["NONE","FREE_BUSY","READ","WRITE"],"description":"O que os colegas veem da agenda: NONE, FREE_BUSY (\"Ocupado\"), READ ou WRITE (com edição); ausente = WRITE"}},"required":["id","name","email","role","officeId","profile","createdAt","updatedAt","hasGoogleLinked","hasPassword"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/user/{id}":{"get":{"summary":"Buscar usuário","tags":["Users"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do usuário"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do usuário"},"name":{"type":"string","description":"Nome completo"},"email":{"type":"string","description":"E-mail de login"},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ"},"contact":{"type":"string","nullable":true,"description":"Telefone ou contato"},"role":{"type":"string","description":"Cargo no escritório"},"admissionDate":{"type":"string","nullable":true,"description":"Data de admissão"},"resignationDate":{"type":"string","nullable":true,"description":"Data de demissão"},"dateOfBirth":{"type":"string","nullable":true,"description":"Data de nascimento"},"ctpsNumber":{"type":"string","nullable":true,"description":"Número da CTPS"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"},"oabNumber":{"type":"string","nullable":true,"description":"Número da OAB"},"personType":{"type":"string","nullable":true,"description":"Tipo de pessoa: PF ou PJ"},"salary":{"type":"string","nullable":true,"description":"Salário"},"description":{"type":"string","nullable":true,"description":"Descrição do colaborador: funções, áreas de atuação e tipos de caso que assume. Use para sugerir o responsável de tarefas e processos"},"postalCode":{"type":"string","nullable":true,"description":"CEP"},"addressNumber":{"type":"string","nullable":true,"description":"Número do endereço"},"firstLogin":{"type":"boolean","nullable":true,"description":"Primeiro acesso pendente"},"showBannerAsaas":{"type":"boolean","nullable":true,"description":"Exibir banner Asaas"},"officeId":{"type":"string","description":"ID do escritório"},"referralToken":{"type":"string","nullable":true,"description":"Token de indicação"},"googleIntegrationType":{"type":"string","enum":["full-sync"],"nullable":true,"description":"Tipo de integração Google"},"profile":{"type":"object","properties":{"id":{"type":"string","description":"ID do perfil"},"name":{"type":"string","description":"Nome do perfil"}},"required":["id","name"],"additionalProperties":false},"createdAt":{"type":"string","description":"Data de criação (ISO 8601)"},"updatedAt":{"type":"string","description":"Data da última alteração (ISO 8601)"},"hasGoogleLinked":{"type":"boolean","description":"Possui conta Google vinculada"},"googleEmail":{"type":"string","nullable":true,"description":"E-mail da conta Google vinculada"},"hasPassword":{"type":"boolean","description":"Possui senha cadastrada"},"calendarColor":{"type":"string","nullable":true,"description":"Cor da agenda do usuário (hex); null = sem cor"},"calendarSharing":{"type":"string","enum":["NONE","FREE_BUSY","READ","WRITE"],"description":"O que os colegas veem da agenda: NONE, FREE_BUSY (\"Ocupado\"), READ ou WRITE (com edição); ausente = WRITE"}},"required":["id","name","email","role","officeId","profile","createdAt","updatedAt","hasGoogleLinked","hasPassword"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/history/{id}":{"get":{"summary":"Listar histórico da tarefa","tags":["Tasks"],"description":"Retorna o histórico vinculado ao ID informado. Para tasks, passe o ID da tarefa (`GET /history/{taskId}`). Também funciona para outros módulos que gravam histórico no mesmo endpoint.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da entidade vinculada (ex.: ID da tarefa para histórico de tasks)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"module":{"type":"string","description":"Módulo do histórico (ex.: task)"},"linkedId":{"type":"string","description":"ID da entidade vinculada"},"history":{"type":"array","items":{"type":"object","properties":{"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data do evento"},"action":{"type":"string","description":"Descrição da ação"},"type":{"type":"string","description":"Tipo do evento"},"taskKanban":{},"fromTaskKanban":{},"toTaskKanban":{},"taskKanbanFolder":{},"taskKanbanBoard":{},"fromTaskKanbanBoard":{},"toTaskKanbanBoard":{},"user":{"type":"object","properties":{"name":{"type":"string","nullable":true,"description":"Nome do autor. 'Sistema' quando a entrada não tem autor humano (notificação enviada pela plataforma ou automação sem responsável); 'Usuário removido' quando o autor não existe mais no escritório"},"avatar":{"type":"string","nullable":true}},"additionalProperties":true}},"additionalProperties":true},"description":"Eventos do histórico"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]}},"required":["history"],"additionalProperties":true},{"type":"string","description":"Mensagem quando não há histórico"}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/audit-log/":{"get":{"summary":"Listar logs de auditoria","tags":["Audit Log"],"description":"Lista o registro de auditoria do escritório: criações (CREATE), alterações (UPDATE), exclusões (DELETE) e revelações de dado sensível (REVEAL) dos tipos de `entityType`, com autor, data e campos. Ação feita por automação ou por chave de API traz `origin`.\n\n**Permissão:** Gestor ou \"Configurações - Usuários › Visualizar\". Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403. A lista inclui registros de itens privados.\n\n**Ordem e paginação:** mais recentes primeiro (`createdAt` decrescente, empate por `id`). `page` começa em 1 e `limit` vai até 100; use `totalPages` para saber quando parar.\n\n**Retenção:** 90 dias. Registros de pessoas (`person`) e de publicações (`publication`) não expiram.\n\n**Tarefas excluídas:** `entityType=task&action=DELETE` com `startDate` e `endDate`. Toda exclusão de tarefa grava um registro, inclusive a que vem da exclusão da coluna, do quadro ou da pasta; `entityId` é o id da tarefa e `changes` traz os campos auditados dela em `before`.\nA gravação é assíncrona e sem garantia de entrega: feche a janela com folga (`endDate` pelo menos 5 minutos no passado), comece a próxima no `endDate` anterior e descarte repetidos pelo `id` do registro.\nAntes de apagar a sua cópia, confirme com `GET /task/{id}`: só 404 significa excluída (403 é tarefa privada que quem criou a chave não vê, ou chave sem permissão de visualizar tarefas).","parameters":[{"schema":{"type":"integer","default":1,"exclusiveMinimum":0},"in":"query","name":"page","required":false,"description":"Página, começa em 1"},{"schema":{"type":"integer","maximum":100,"default":20,"exclusiveMinimum":0},"in":"query","name":"limit","required":false,"description":"Itens por página, de 1 a 100 (padrão 20)"},{"schema":{"type":"string","enum":["CREATE","UPDATE","DELETE","REVEAL"]},"in":"query","name":"action","required":false,"description":"CREATE (criação), UPDATE (alteração), DELETE (exclusão) ou REVEAL (revelação de dado sensível, como o código do Autenticador)"},{"schema":{"type":"array","items":{"type":"string","enum":["person","task","lawSuit","financialBill","financialPartner","financialTransaction","financialPeriod","financialSettings","financialBankConnection","authenticatorAccount","officeCredit","consulting","consultingRegister","consultingColumn","publication","funnel","event","audience","alert","juridiqSettings","workflow","workflowWebhook","calculation","wikiPage","wikiComment","customField"]}},"in":"query","name":"entityType","required":false,"description":"Tipo do item auditado; aceita vários separados por vírgula (ex.: task,event). Sem ele, vêm todos os tipos menos officeCredit (consumo de créditos)"},{"schema":{"type":"string","enum":["JURIDICAL","ADMINISTRATIVE_INSS","ADMINISTRATIVE_OTHER"]},"in":"query","name":"lawSuitType","required":false,"description":"Compara o tipo de processo gravado em changes.lawsuitType.after. Registro sem esse valor (exclusão, edição sem troca de tipo) conta como JURIDICAL. Sem entityType, a lista fica só com processos (lawSuit); com entityType sem lawSuit, é ignorado"},{"schema":{"type":"string"},"in":"query","name":"entityLabel","required":false,"description":"Busca no nome ou título do item gravado no registro, sem diferenciar acento"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"entityId","required":false,"description":"ID do item auditado (ex.: o id da tarefa)"},{"schema":{"type":"array","items":{"type":"string","format":"uuid"}},"in":"query","name":"userId","required":false,"description":"Autor da ação; aceita vários UUIDs separados por vírgula"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"lawSuitId","required":false,"description":"Registros do processo, dos itens ligados a ele hoje (tarefas, eventos, audiências, atendimentos e lançamentos) e dos registros que gravaram este lawSuitId em changes. Item já excluído só entra por esse último caminho"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"personId","required":false,"description":"Registros da pessoa, dos itens ligados a ela hoje (tarefas, eventos, audiências, atendimentos e lançamentos) e dos registros que gravaram este personId em changes. Item já excluído só entra por esse último caminho; tarefa não grava personId"},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"startDate","required":false,"description":"Início da janela por createdAt, inclusive. Instante ISO 8601 com fuso (ex.: 2026-10-26T00:00:00-03:00); data sem horário vale 00:00 UTC"},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"endDate","required":false,"description":"Fim da janela por createdAt, inclusive. Mesmo formato de startDate; anterior a startDate devolve lista vazia"},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"createdAt","required":false,"description":"Dia inteiro em UTC (00:00 a 24:00 UTC) do instante enviado. Quando enviado, startDate e endDate são ignorados"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"partnerId","required":false,"description":"Só registros de lançamentos financeiros (financialTransaction) que hoje são deste parceiro"},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"paidMarkOnly","required":false,"description":"true: só alterações (UPDATE) que marcaram o lançamento como pago (isPaid de não pago para pago)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do registro de auditoria; é o id usado em POST /audit-log/{id}/restore"},"officeId":{"type":"string","format":"uuid","description":"Escritório"},"userId":{"type":"string","format":"uuid","nullable":true,"description":"Autor da ação; null quando não há usuário"},"userName":{"type":"string","nullable":true,"description":"Nome do autor no momento da ação"},"action":{"type":"string","enum":["CREATE","UPDATE","DELETE","REVEAL"],"description":"CREATE, UPDATE, DELETE ou REVEAL"},"entityType":{"type":"string","enum":["person","task","lawSuit","financialBill","financialPartner","financialTransaction","financialPeriod","financialSettings","financialBankConnection","authenticatorAccount","officeCredit","consulting","consultingRegister","consultingColumn","publication","funnel","event","audience","alert","juridiqSettings","workflow","workflowWebhook","calculation","wikiPage","wikiComment","customField"],"description":"Tipo do item auditado"},"entityId":{"type":"string","format":"uuid","description":"ID do item auditado; continua o mesmo depois da exclusão e da restauração"},"entityLabel":{"type":"string","nullable":true,"description":"Nome ou título do item no momento da ação"},"changes":{"type":"object","additionalProperties":{},"nullable":true,"description":"Campos auditados de cada tipo, no formato { campo: { before, after } }. CREATE: valores em after (before null). UPDATE: before e after dos campos alterados e, em alguns tipos, de campos de contexto. DELETE: valores em before (after null). Nunca entram: password, govPassword, apiKey, token, refreshToken, secret, stripeSubscriptionId e asaasSubscriptionId. null quando o registro não guarda campos (ex.: REVEAL)"},"origin":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["workflow"]},"workflowId":{"type":"string"},"workflowName":{"type":"string"},"workflowInstanceId":{"type":"string"}},"required":["type","workflowId","workflowName","workflowInstanceId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["apiKey"]},"channel":{"type":"string","enum":["api","mcp"],"description":"mcp: Claude e outros clientes MCP; api: integração"}},"required":["type","channel"],"additionalProperties":false}],"nullable":true,"description":"Preenchido quando a ação foi feita por uma automação ou por uma chave de API"},"createdAt":{"type":"string","format":"date-time","description":"Data e hora da ação (UTC)"}},"required":["id","officeId","userId","userName","action","entityType","entityId","entityLabel","changes","createdAt"],"additionalProperties":false},"description":"Registros da página"},"totalResults":{"type":"number","description":"Total de registros com os filtros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/audit-log/{id}/restore":{"post":{"summary":"Recuperar item excluído a partir de log de auditoria","tags":["Audit Log"],"description":"Recria um item excluído a partir do registro DELETE dele. Vale para task, consulting, consultingColumn e funnel. O registro DELETE fica 90 dias; depois disso, a resposta é 404.\n\nO item volta com o mesmo `id` e só com estes campos de `changes.before` (campo nulo conta como ausente):\n- task: title, description, status, priority, initialDate, finalDate, initialHour, finalHour, taskKanbanColumnId, lawSuitId, isPrivate, points, needValidation, isValidated e ownerId. Sem title, usa entityLabel. Ausentes: status Pendente, priority Normal, initialDate a data atual em UTC, points 0, isPrivate, needValidation e isValidated false; os demais ficam vazios. Sem ownerId, a tarefa volta sem dono;\n- consulting: subject, personId, lawSuitId, consultingColumnId, ownerId, isPrivate, currentIndex, tagIds e taskIds. Sem subject, usa entityLabel. Ausentes: isPrivate false; lawSuitId, consultingColumnId, currentIndex, tagIds e taskIds ficam vazios; sem ownerId, o dono passa a ser quem recupera; sem personId, 400. A conclusão segue a coluna: fora da coluna de concluídos fica vazia; na de concluídos, mantém completedAt (e completedById, se o usuário ainda existe) ou, sem conclusão no registro, conclui agora em nome de quem recupera. As tarefas de taskIds saem do atendimento em que estiverem e passam para este;\n- consultingColumn: name, color, timeLimitDays, showBadgeProgress, index e kind. Sem name, usa entityLabel ou \"Coluna recuperada\". Ausentes: timeLimitDays 30, showBadgeProgress true, kind IN_PROGRESS; color e index ficam vazios. Volta sem funil;\n- funnel: name, index e isDefault. Sem name, usa entityLabel. Ausentes: isDefault false; index fica vazio. Volta com as colunas padrão.\n\nRelações e vínculos fora dessa lista não voltam (ex.: responsáveis, comentários, anexos, subtarefas, campos personalizados, registros do atendimento e histórico). A recuperação grava um registro CREATE.\n\n**Permissão:** Gestor ou \"Configurações - Usuários › Criar e Editar\". Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403.\n\n**Erros:** 404 quando o registro não existe neste escritório. 400 quando: o registro não é DELETE; o tipo não é recuperável; o registro não guarda dados; falta a pessoa do atendimento; falta o título da tarefa, o assunto do atendimento ou o nome do funil e também o entityLabel; um vínculo guardado não existe mais (coluna, processo, pessoa, dono, etiqueta ou tarefa); ou já existe funil padrão. 409 quando já existe item com o mesmo `id` (já recuperado ou ainda existe) ou funil com o mesmo nome.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do registro de auditoria DELETE (campo id da listagem), não o do item"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"entityId":{"type":"string","format":"uuid","description":"ID do item recriado, o mesmo de antes da exclusão"},"entityType":{"type":"string","description":"Tipo do item recriado"},"message":{"type":"string","description":"Mensagem de sucesso"}},"required":["entityId","entityType","message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/tag/":{"get":{"summary":"Listar etiquetas","tags":["Tags"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra por nome"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc"},{"schema":{"type":"string"},"in":"query","name":"module","required":false,"description":"Filtra por módulo"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da etiqueta"},"name":{"type":"string","description":"Nome"},"color":{"type":"string","description":"Cor"},"modules":{"type":"array","items":{"type":"string"},"description":"Módulos vinculados"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","color","officeId","updatedAt","createdAt"],"additionalProperties":true},"description":"Lista de etiquetas"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar etiqueta","tags":["Tags"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome"},"color":{"type":"string","minLength":1,"description":"Cor"},"modules":{"type":"array","items":{"type":"string"},"description":"Módulos. Padrão: lawSuit"}},"required":["name","color"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da etiqueta"},"name":{"type":"string","description":"Nome"},"color":{"type":"string","description":"Cor"},"modules":{"type":"array","items":{"type":"string"},"description":"Módulos vinculados"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","color","officeId","updatedAt","createdAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"delete":{"summary":"Excluir etiquetas","tags":["Tags"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs das etiquetas"}},"required":["id"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/tag/{id}":{"get":{"summary":"Buscar etiqueta","tags":["Tags"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da etiqueta"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da etiqueta"},"name":{"type":"string","description":"Nome"},"color":{"type":"string","description":"Cor"},"modules":{"type":"array","items":{"type":"string"},"description":"Módulos vinculados"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","color","officeId","updatedAt","createdAt"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar etiqueta","tags":["Tags"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome"},"color":{"type":"string","minLength":1,"description":"Cor"},"modules":{"type":"array","items":{"type":"string"},"description":"Módulos"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da etiqueta"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da etiqueta"},"name":{"type":"string","description":"Nome"},"color":{"type":"string","description":"Cor"},"modules":{"type":"array","items":{"type":"string"},"description":"Módulos vinculados"},"officeId":{"type":"string","description":"ID do escritório"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"}},"required":["id","name","color","officeId","updatedAt","createdAt"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/signature/":{"get":{"summary":"Listar assinaturas individuais","tags":["Signatures"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"status","required":false,"description":"Filtra por status"},{"schema":{"type":"boolean"},"in":"query","name":"isPrivate","required":false,"description":"Filtra por privacidade"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"personId","required":false,"description":"Filtra por pessoa vinculada"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"responsibleId","required":false,"description":"Filtra por responsável"},{"schema":{"type":"string"},"in":"query","name":"startDate","required":false,"description":"Data inicial do filtro"},{"schema":{"type":"string"},"in":"query","name":"endDate","required":false,"description":"Data final do filtro"},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"Busca por título ou nome do documento"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da assinatura"},"documentName":{"type":"string","description":"Nome do documento"},"signName":{"type":"string","nullable":true,"description":"Nome exibido da assinatura"},"documentKey":{"type":"string","description":"Chave do documento no PlugSign"},"signingKey":{"type":"string","nullable":true,"description":"Chave de assinatura"},"status":{"type":"string","description":"Status. Ex: pending, signed, cancelled"},"signatories":{"description":"Lista de signatários"},"responsibleId":{"type":"string","nullable":true,"description":"ID do responsável"},"responsible":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"Foto do responsável"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"isPrivate":{"type":"boolean","nullable":true,"description":"Documento privado"},"autoSendLink":{"type":"boolean","description":"Envio automático do link de assinatura aos signatários"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"personOnSignatures":{"description":"Pessoas vinculadas"}},"required":["id","documentName","documentKey","status","updatedAt","createdAt"],"additionalProperties":true},"description":"Assinaturas individuais"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Enviar documento para assinatura","tags":["Signatures"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"Arquivo PDF obrigatório","type":"string","format":"binary"},"signatories":{"type":"string","description":"E-mails ou telefones dos signatários, separados por vírgula"},"people":{"type":"string","description":"JSON com contatos vinculados. Ex: [{ \"id\": \"uuid\", \"value\": \"email@...\", \"type\": \"email\", \"request_selfie\": true, \"request_document\": false }]"},"signatory_options":{"type":"string","description":"JSON com overrides por signatário (livre ou cadastrado). Ex: [{ \"value\": \"email@...\", \"request_selfie\": true, \"request_document\": false }]"},"subject":{"type":"string","description":"Assunto do envio"},"message":{"type":"string","description":"Mensagem enviada aos signatários"},"expire_date":{"type":"string","description":"Data de expiração do pedido de assinatura"},"request_selfie":{"type":"string","description":"true para solicitar selfie do signatário (padrão global)"},"request_document":{"type":"string","description":"true para solicitar documento com foto (padrão global)"},"request_rubric":{"type":"string","description":"true para solicitar rubrica desenhada"},"due_months":{"type":"string","description":"Meses de validade do documento assinado"},"has_chain":{"type":"string","description":"true para assinatura em cadeia"},"isPrivate":{"type":"string","description":"true para documento privado no escritório"},"fields":{"type":"string","description":"JSON com posições dos campos de assinatura por signatário"},"width_page":{"type":"string","description":"Largura da página em pixels. Padrão: 596"},"auto_send_link":{"type":"string","description":"false para não enviar o link de assinatura automaticamente. Padrão: true"},"signName":{"type":"string","description":"Nome exibido do documento"}},"additionalProperties":false}}}},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Resposta do PlugSign","content":{"application/json":{"schema":{"description":"Resposta do PlugSign"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/signature/count":{"get":{"summary":"Contagem de assinaturas por status","tags":["Signatures"],"parameters":[{"schema":{"type":"string","enum":["individual","batch","total"]},"in":"query","name":"context","required":false,"description":"individual (padrão), batch ou total"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Contagem por status","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"number"},"description":"Contagem por status"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/signature/download/{documentKey}":{"get":{"summary":"Baixar PDF assinado","tags":["Signatures"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"documentKey","required":true,"description":"Chave do documento no PlugSign"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Arquivo PDF","content":{"application/json":{"schema":{"type":"string","description":"Arquivo PDF"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/signature/history/{id}":{"get":{"summary":"Histórico de assinatura no PlugSign","tags":["Signatures"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da assinatura"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Histórico do PlugSign","content":{"application/json":{"schema":{"description":"Histórico do PlugSign"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/signature/batch":{"get":{"summary":"Listar lotes de assinatura","tags":["Signatures"],"parameters":[{"schema":{"type":"integer","minimum":1},"in":"query","name":"page","required":false,"description":"Página. Começa em 1. Padrão 1"},{"schema":{"type":"integer","minimum":1},"in":"query","name":"pageSize","required":false,"description":"Itens por página. Padrão 30"},{"schema":{"type":"string"},"in":"query","name":"status","required":false,"description":"Filtra por status"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"responsibleId","required":false,"description":"Filtra por responsável"},{"schema":{"type":"string"},"in":"query","name":"startDate","required":false,"description":"Data inicial do filtro"},{"schema":{"type":"string"},"in":"query","name":"endDate","required":false,"description":"Data final do filtro"},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"Busca por nome do lote"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do lote"},"name":{"type":"string","description":"Nome do lote"},"plugsignLoteId":{"type":"string","description":"ID do lote no PlugSign"},"status":{"type":"string","description":"Status do lote"},"signatories":{"description":"Signatários do lote"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"responsibleId":{"type":"string","nullable":true,"description":"ID do responsável"},"isPrivate":{"type":"boolean","nullable":true,"description":"Lote privado"},"autoSendLink":{"type":"boolean","description":"Envio automático do link de assinatura aos signatários"},"expireDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data de expiração"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"responsible":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"Foto do responsável"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"personOnBatches":{"description":"Pessoas vinculadas ao lote"},"signatures":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da assinatura"},"status":{"type":"string","description":"Status do documento no lote"},"documentName":{"type":"string","description":"Nome do documento"},"signName":{"type":"string","nullable":true,"description":"Nome exibido da assinatura"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"}},"required":["id","status","documentName","createdAt"],"additionalProperties":true},"description":"Documentos do lote (resumo na listagem)"}},"required":["id","name","plugsignLoteId","status","officeId","createdAt","updatedAt"],"additionalProperties":true},"description":"Lotes de assinatura"},"totalPages":{"type":"number","description":"Total de páginas"},"totalResults":{"type":"number","description":"Total de registros"}},"required":["data","totalPages","totalResults"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar lote de assinaturas","tags":["Signatures"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"files":{"type":"array","items":{"description":"Arquivo enviado no multipart/form-data","type":"string","format":"binary"},"minItems":2,"maxItems":15,"description":"Arquivos PDF do lote (mínimo 2, máximo 15, campo files)"},"name":{"type":"string","description":"Nome do lote"},"signatories":{"type":"string","description":"E-mails ou telefones dos signatários, separados por vírgula"},"people":{"type":"string","description":"JSON com contatos vinculados. Ex: [{ \"id\": \"uuid\", \"value\": \"email@...\", \"type\": \"email\", \"request_selfie\": true, \"request_document\": false }]"},"signatory_options":{"type":"string","description":"JSON com overrides por signatário (livre ou cadastrado). Ex: [{ \"value\": \"email@...\", \"request_selfie\": true, \"request_document\": false }]"},"subject":{"type":"string","description":"Assunto do envio"},"message":{"type":"string","description":"Mensagem enviada aos signatários"},"has_chain":{"type":"string","description":"true para assinatura em cadeia"},"request_selfie":{"type":"string","description":"true para solicitar selfie do signatário (padrão global)"},"request_document":{"type":"string","description":"true para solicitar documento com foto (padrão global)"},"request_rubric":{"type":"string","description":"false para desabilitar rubrica desenhada"},"isPrivate":{"type":"string","description":"true para lote privado no escritório"},"due_months":{"type":"string","description":"Meses de validade dos documentos assinados"},"expire_date":{"type":"string","description":"Data de expiração do pedido de assinatura"},"width_page":{"type":"string","description":"Largura da página em pixels. Padrão: 596"},"auto_send_link":{"type":"string","description":"false para não enviar o link de assinatura automaticamente. Padrão: true"}},"required":["files","name"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do lote"},"name":{"type":"string","description":"Nome do lote"},"plugsignLoteId":{"type":"string","description":"ID do lote no PlugSign"},"status":{"type":"string","description":"Status do lote"},"signatories":{"description":"Signatários do lote"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"responsibleId":{"type":"string","nullable":true,"description":"ID do responsável"},"isPrivate":{"type":"boolean","nullable":true,"description":"Lote privado"},"autoSendLink":{"type":"boolean","description":"Envio automático do link de assinatura aos signatários"},"expireDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data de expiração"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"responsible":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"Foto do responsável"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"personOnBatches":{"description":"Pessoas vinculadas ao lote"},"signatures":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da assinatura"},"documentName":{"type":"string","description":"Nome do documento"},"signName":{"type":"string","nullable":true,"description":"Nome exibido da assinatura"},"documentKey":{"type":"string","description":"Chave do documento no PlugSign"},"signingKey":{"type":"string","nullable":true,"description":"Chave de assinatura"},"status":{"type":"string","description":"Status. Ex: pending, signed, cancelled"},"signatories":{"type":"array","items":{"type":"object","properties":{"contact":{"type":"string"},"contactType":{"type":"string","enum":["whatsapp","email","unknown"]},"signed":{"type":"boolean"},"hasLinkedPerson":{"type":"boolean"},"linkedPersonId":{"type":"string","nullable":true},"linkedPersonName":{"type":"string","nullable":true},"linkedPersonImageUrl":{"type":"string","nullable":true},"signingKey":{"type":"string","nullable":true},"url":{"type":"string","nullable":true}},"additionalProperties":true},"description":"Signatários com status e link"},"responsibleId":{"type":"string","nullable":true,"description":"ID do responsável"},"responsible":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"Foto do responsável"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"isPrivate":{"type":"boolean","nullable":true,"description":"Documento privado"},"autoSendLink":{"type":"boolean","description":"Envio automático do link de assinatura aos signatários"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"personOnSignatures":{"description":"Pessoas vinculadas"},"history":{"description":"Histórico do PlugSign"},"plugsignUnavailable":{"type":"boolean","description":"true quando o detalhe veio só do banco (PlugSign falhou ou em skip)"}},"required":["id","documentName","documentKey","status","updatedAt","createdAt"],"additionalProperties":true},"description":"Documentos do lote"}},"required":["id","name","plugsignLoteId","status","officeId","createdAt","updatedAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/signature/batch/{id}":{"get":{"summary":"Buscar lote de assinatura","tags":["Signatures"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do lote"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do lote"},"name":{"type":"string","description":"Nome do lote"},"plugsignLoteId":{"type":"string","description":"ID do lote no PlugSign"},"status":{"type":"string","description":"Status do lote"},"signatories":{"description":"Signatários do lote"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"responsibleId":{"type":"string","nullable":true,"description":"ID do responsável"},"isPrivate":{"type":"boolean","nullable":true,"description":"Lote privado"},"autoSendLink":{"type":"boolean","description":"Envio automático do link de assinatura aos signatários"},"expireDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data de expiração"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"responsible":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"Foto do responsável"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"personOnBatches":{"description":"Pessoas vinculadas ao lote"},"signatures":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da assinatura"},"documentName":{"type":"string","description":"Nome do documento"},"signName":{"type":"string","nullable":true,"description":"Nome exibido da assinatura"},"documentKey":{"type":"string","description":"Chave do documento no PlugSign"},"signingKey":{"type":"string","nullable":true,"description":"Chave de assinatura"},"status":{"type":"string","description":"Status. Ex: pending, signed, cancelled"},"signatories":{"type":"array","items":{"type":"object","properties":{"contact":{"type":"string"},"contactType":{"type":"string","enum":["whatsapp","email","unknown"]},"signed":{"type":"boolean"},"hasLinkedPerson":{"type":"boolean"},"linkedPersonId":{"type":"string","nullable":true},"linkedPersonName":{"type":"string","nullable":true},"linkedPersonImageUrl":{"type":"string","nullable":true},"signingKey":{"type":"string","nullable":true},"url":{"type":"string","nullable":true}},"additionalProperties":true},"description":"Signatários com status e link"},"responsibleId":{"type":"string","nullable":true,"description":"ID do responsável"},"responsible":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"Foto do responsável"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"isPrivate":{"type":"boolean","nullable":true,"description":"Documento privado"},"autoSendLink":{"type":"boolean","description":"Envio automático do link de assinatura aos signatários"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"personOnSignatures":{"description":"Pessoas vinculadas"},"history":{"description":"Histórico do PlugSign"},"plugsignUnavailable":{"type":"boolean","description":"true quando o detalhe veio só do banco (PlugSign falhou ou em skip)"}},"required":["id","documentName","documentKey","status","updatedAt","createdAt"],"additionalProperties":true},"description":"Documentos do lote"}},"required":["id","name","plugsignLoteId","status","officeId","createdAt","updatedAt"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar lote de assinatura","tags":["Signatures"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome do lote"},"isPrivate":{"type":"boolean","description":"Lote privado"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do lote"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do lote"},"name":{"type":"string","description":"Nome do lote"},"plugsignLoteId":{"type":"string","description":"ID do lote no PlugSign"},"status":{"type":"string","description":"Status do lote"},"signatories":{"description":"Signatários do lote"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"responsibleId":{"type":"string","nullable":true,"description":"ID do responsável"},"isPrivate":{"type":"boolean","nullable":true,"description":"Lote privado"},"autoSendLink":{"type":"boolean","description":"Envio automático do link de assinatura aos signatários"},"expireDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"nullable":true,"description":"Data de expiração"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"responsible":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"Foto do responsável"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"personOnBatches":{"description":"Pessoas vinculadas ao lote"},"signatures":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da assinatura"},"documentName":{"type":"string","description":"Nome do documento"},"signName":{"type":"string","nullable":true,"description":"Nome exibido da assinatura"},"documentKey":{"type":"string","description":"Chave do documento no PlugSign"},"signingKey":{"type":"string","nullable":true,"description":"Chave de assinatura"},"status":{"type":"string","description":"Status. Ex: pending, signed, cancelled"},"signatories":{"type":"array","items":{"type":"object","properties":{"contact":{"type":"string"},"contactType":{"type":"string","enum":["whatsapp","email","unknown"]},"signed":{"type":"boolean"},"hasLinkedPerson":{"type":"boolean"},"linkedPersonId":{"type":"string","nullable":true},"linkedPersonName":{"type":"string","nullable":true},"linkedPersonImageUrl":{"type":"string","nullable":true},"signingKey":{"type":"string","nullable":true},"url":{"type":"string","nullable":true}},"additionalProperties":true},"description":"Signatários com status e link"},"responsibleId":{"type":"string","nullable":true,"description":"ID do responsável"},"responsible":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"Foto do responsável"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"isPrivate":{"type":"boolean","nullable":true,"description":"Documento privado"},"autoSendLink":{"type":"boolean","description":"Envio automático do link de assinatura aos signatários"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"personOnSignatures":{"description":"Pessoas vinculadas"},"history":{"description":"Histórico do PlugSign"},"plugsignUnavailable":{"type":"boolean","description":"true quando o detalhe veio só do banco (PlugSign falhou ou em skip)"}},"required":["id","documentName","documentKey","status","updatedAt","createdAt"],"additionalProperties":true},"description":"Documentos do lote"}},"required":["id","name","plugsignLoteId","status","officeId","createdAt","updatedAt"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir lote de assinatura","tags":["Signatures"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do lote"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Mensagem de confirmação"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/signature/batch/cancel/{id}":{"post":{"summary":"Cancelar lote de assinatura","tags":["Signatures"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do lote"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Lote cancelado","content":{"application/json":{"schema":{"description":"Lote cancelado"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/signature/json":{"post":{"summary":"Enviar documento para assinatura com o PDF em JSON (base64)","tags":["Signatures"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Nome do arquivo com extensão. Ex: contrato-honorarios.pdf"},"content_base64":{"type":"string","minLength":1,"description":"Conteúdo do arquivo em base64. Aceita prefixo data:...;base64, e quebras de linha. Máximo de 10 MB decodificado"}},"required":["name","content_base64"],"additionalProperties":false,"description":"Documento PDF em base64"},"signatories":{"type":"array","items":{"type":"string","minLength":1,"pattern":"^[^,]+$"},"description":"E-mails ou telefones dos signatários"},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da pessoa cadastrada no escritório"},"value":{"type":"string","minLength":1,"description":"E-mail ou telefone da pessoa usado no envio"},"type":{"type":"string","minLength":1,"description":"Canal do contato. Ex: email, phone"},"request_selfie":{"type":"boolean","description":"Override de selfie para esta pessoa"},"request_document":{"type":"boolean","description":"Override de documento com foto para esta pessoa"}},"required":["id","value","type"],"additionalProperties":false},"description":"Pessoas cadastradas que assinam; ficam vinculadas à assinatura"},"signatory_options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","minLength":1,"description":"E-mail ou telefone do signatário"},"request_selfie":{"type":"boolean","description":"Override de selfie para este signatário"},"request_document":{"type":"boolean","description":"Override de documento com foto para este signatário"}},"required":["value"],"additionalProperties":false},"description":"Overrides de selfie e documento por signatário livre"},"subject":{"type":"string","description":"Assunto do envio"},"message":{"type":"string","description":"Mensagem enviada aos signatários"},"expire_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data de expiração do pedido de assinatura, no formato AAAA-MM-DD"},"request_selfie":{"type":"boolean","description":"Solicitar selfie do signatário. Padrão: false"},"request_document":{"type":"boolean","description":"Solicitar documento com foto. Padrão: false"},"request_rubric":{"type":"boolean","description":"Assinatura desenhada. Padrão: false (assinatura por texto)"},"due_months":{"type":"integer","minimum":0,"description":"Meses de validade do documento assinado"},"has_chain":{"type":"boolean","description":"Assinatura em cadeia. Padrão: false"},"isPrivate":{"type":"boolean","description":"Documento privado no escritório. Padrão: false"},"fields":{"type":"array","items":{"type":"object","properties":{"signer":{"type":"string","description":"E-mail ou telefone do signatário dono do campo"},"page":{"type":"integer","description":"Página do campo","exclusiveMinimum":0},"type":{"type":"string","description":"Tipo do campo. Ex: signature, text"},"width":{"type":"number"},"height":{"type":"number"},"xPos":{"type":"number"},"yPos":{"type":"number"}},"additionalProperties":false},"description":"Posições dos campos de assinatura por signatário"},"width_page":{"type":"integer","description":"Largura da página em pixels. Padrão: 596","exclusiveMinimum":0},"signName":{"type":"string","minLength":1,"description":"Nome exibido do documento. Padrão: nome do arquivo"}},"required":["file"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Resposta do PlugSign","content":{"application/json":{"schema":{"description":"Resposta do PlugSign"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"413":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/signature/reminder":{"post":{"summary":"Reenviar lembrete de assinatura","tags":["Signatures"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da assinatura"},"singKey":{"type":"string","description":"Chave de assinatura do signatário"},"subject":{"type":"string","description":"Assunto do lembrete"},"message":{"type":"string","description":"Mensagem do lembrete"},"contact":{"type":"string","description":"E-mail ou telefone do signatário"},"resendingType":{"type":"string","description":"Tipo de reenvio"}},"required":["id","singKey","contact","resendingType"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Resposta do PlugSign","content":{"application/json":{"schema":{"description":"Resposta do PlugSign"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/signature/cancel/{id}":{"post":{"summary":"Cancelar assinatura pendente","tags":["Signatures"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da assinatura"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Cancelamento confirmado","content":{"application/json":{"schema":{"type":"string","enum":["ok"],"description":"Cancelamento confirmado"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/signature/{id}/people":{"post":{"summary":"Vincular pessoas a uma assinatura","tags":["Signatures"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"description":"ID da pessoa"},"value":{"type":"string","minLength":1,"description":"E-mail ou telefone"},"type":{"type":"string","enum":["email","contact"],"description":"email ou contact"}},"required":["id","value","type"],"additionalProperties":false},"minItems":1,"description":"Pessoas a vincular à assinatura"}},"required":["people"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da assinatura"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Assinatura atualizada","content":{"application/json":{"schema":{"description":"Assinatura atualizada"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/signature/{id}/link-signatory":{"post":{"summary":"Vincular signatário a uma pessoa do CRM","tags":["Signatures"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contact":{"type":"string","minLength":1,"description":"E-mail ou telefone do signatário"},"contactType":{"type":"string","enum":["email","whatsapp"],"description":"email ou whatsapp"},"personId":{"type":"string","format":"uuid","description":"ID da pessoa existente"},"personName":{"type":"string","minLength":1,"description":"Nome para criar nova pessoa"}},"required":["contact","contactType"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da assinatura"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Vínculo criado","content":{"application/json":{"schema":{"description":"Vínculo criado"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/signature/{id}":{"get":{"summary":"Buscar assinatura","tags":["Signatures"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da assinatura"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da assinatura"},"documentName":{"type":"string","description":"Nome do documento"},"signName":{"type":"string","nullable":true,"description":"Nome exibido da assinatura"},"documentKey":{"type":"string","description":"Chave do documento no PlugSign"},"signingKey":{"type":"string","nullable":true,"description":"Chave de assinatura"},"status":{"type":"string","description":"Status. Ex: pending, signed, cancelled"},"signatories":{"type":"array","items":{"type":"object","properties":{"contact":{"type":"string"},"contactType":{"type":"string","enum":["whatsapp","email","unknown"]},"signed":{"type":"boolean"},"hasLinkedPerson":{"type":"boolean"},"linkedPersonId":{"type":"string","nullable":true},"linkedPersonName":{"type":"string","nullable":true},"linkedPersonImageUrl":{"type":"string","nullable":true},"signingKey":{"type":"string","nullable":true},"url":{"type":"string","nullable":true}},"additionalProperties":true},"description":"Signatários com status e link"},"responsibleId":{"type":"string","nullable":true,"description":"ID do responsável"},"responsible":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"Foto do responsável"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"isPrivate":{"type":"boolean","nullable":true,"description":"Documento privado"},"autoSendLink":{"type":"boolean","description":"Envio automático do link de assinatura aos signatários"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"personOnSignatures":{"description":"Pessoas vinculadas"},"history":{"description":"Histórico do PlugSign"},"plugsignUnavailable":{"type":"boolean","description":"true quando o detalhe veio só do banco (PlugSign falhou ou em skip)"}},"required":["id","documentName","documentKey","status","updatedAt","createdAt"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar assinatura","tags":["Signatures"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"observation":{"description":"Observações"},"expireVigencyDate":{"type":"string","format":"date-time","description":"Data de vigência"},"signName":{"type":"string","description":"Nome exibido da assinatura"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da assinatura"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da assinatura"},"documentName":{"type":"string","description":"Nome do documento"},"signName":{"type":"string","nullable":true,"description":"Nome exibido da assinatura"},"documentKey":{"type":"string","description":"Chave do documento no PlugSign"},"signingKey":{"type":"string","nullable":true,"description":"Chave de assinatura"},"status":{"type":"string","description":"Status. Ex: pending, signed, cancelled"},"signatories":{"description":"Lista de signatários"},"responsibleId":{"type":"string","nullable":true,"description":"ID do responsável"},"responsible":{"type":"object","properties":{"id":{"type":"string","description":"ID do responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"Foto do responsável"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"isPrivate":{"type":"boolean","nullable":true,"description":"Documento privado"},"autoSendLink":{"type":"boolean","description":"Envio automático do link de assinatura aos signatários"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"personOnSignatures":{"description":"Pessoas vinculadas"}},"required":["id","documentName","documentKey","status","updatedAt","createdAt"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir assinatura finalizada ou cancelada","tags":["Signatures"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da assinatura"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Mensagem de confirmação"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/publication/":{"get":{"summary":"Listar publicações","tags":["Publications"],"description":"Lista as movimentações de publicação do escritório autenticado, com paginação e totais. Aceita JWT ou o header `x-juridiq-api-key`. Filtros opcionais: texto/CNJ, tribunal ou diário, termo monitorado, tipos de ação, lida ou não, período de publicação e período de leitura (`readStart`/`readEnd` no fuso America/Sao_Paulo).","parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc"},{"schema":{"type":"string"},"in":"query","name":"keySearch","required":false,"description":"Trecho literal (`%` e `_` não são curingas) buscado no resumo, no conteúdo ou no CNJ do processo vinculado"},{"schema":{"type":"string","minLength":1,"maxLength":200},"in":"query","name":"courtOrDiary","required":false,"description":"Trecho literal (`%` e `_` não são curingas) buscado no tribunal ou no diário oficial"},{"schema":{"type":"string"},"in":"query","name":"isHandled","required":false,"description":"true ou false"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"monitoredTermId","required":false,"description":"ID do termo monitorado"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"lawSuitId","required":false,"description":"ID do processo: só as publicações vinculadas a ele"},{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":100},"in":"query","name":"typeActionIds","required":false,"description":"IDs dos tipos de ação do processo (separados por vírgula)"},{"schema":{"type":"string","format":"date"},"in":"query","name":"start","required":false,"description":"Data inicial da data efetiva da publicação (a menor entre disponibilização e publicação, ou a data de captura quando não há nenhuma das duas). Formato YYYY-MM-DD"},{"schema":{"type":"string","format":"date"},"in":"query","name":"end","required":false,"description":"Data final da data efetiva da publicação, inclusive. Formato YYYY-MM-DD. Anterior a `start` devolve lista vazia"},{"schema":{"type":"string","format":"date"},"in":"query","name":"readStart","required":false,"description":"Data inicial de leitura, no fuso America/Sao_Paulo. Formato YYYY-MM-DD"},{"schema":{"type":"string","format":"date"},"in":"query","name":"readEnd","required":false,"description":"Data final de leitura, no fuso America/Sao_Paulo. Formato YYYY-MM-DD"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da movimentação"},"title":{"type":"string","nullable":true,"description":"Título"},"content":{"type":"string","nullable":true,"description":"Conteúdo"},"descriptionSmall":{"type":"string","nullable":true,"description":"Resumo"},"officialDiary":{"type":"string","nullable":true,"description":"Diário oficial"},"availabilityDate":{"type":"string","nullable":true,"description":"Data de disponibilização"},"publicationDate":{"type":"string","nullable":true,"description":"Data da publicação"},"location":{"type":"string","nullable":true,"description":"Local"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo"},"type":{"type":"string","enum":["oab","name_adv","name_parties","lawsuit","content"],"nullable":true,"description":"Tipo do monitoramento"},"term":{"type":"string","nullable":true,"description":"Termo monitorado"},"name":{"type":"string","nullable":true,"description":"Nome monitorado (legado)"},"variations":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Variações do termo"},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","nullable":true}},"required":["id","name"],"additionalProperties":false},"description":"Partes do processo, com os clientes do escritório primeiro"},"lawsuitId":{"type":"string","nullable":true,"description":"ID do processo"},"prevId":{"type":"string","nullable":true},"nextId":{"type":"string","nullable":true},"prevUnreadId":{"type":"string","nullable":true},"nextUnreadId":{"type":"string","nullable":true},"unreadPosition":{"type":"number","nullable":true},"unreadTotal":{"type":"number","nullable":true},"isHandled":{"type":"boolean","nullable":true,"description":"Já tratada"},"readAt":{"type":"string","format":"date-time","nullable":true,"description":"Data da leitura"},"readBy":{"type":"object","properties":{"id":{"type":"string","description":"ID do usuário que leu"},"name":{"type":"string","nullable":true,"description":"Nome do usuário que leu"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"}},"required":["id"],"additionalProperties":false,"nullable":true,"description":"Usuário que leu"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"hasSimilarity":{"type":"boolean","nullable":true,"description":"Tem similaridade"},"createdAt":{"type":"string","format":"date-time"}},"required":["id"],"additionalProperties":false},"description":"Publicações"},"sum":{"type":"object","properties":{"total":{"type":"number","description":"Total"},"read":{"type":"number","description":"Lidas"},"unread":{"type":"number","description":"Não lidas"},"readInPeriod":{"type":"number","description":"Lidas dentro do intervalo de readStart/readEnd. Ausente sem o filtro"}},"required":["total","read","unread"],"additionalProperties":false,"description":"Totais"},"totalPages":{"type":"number","description":"Total de páginas"},"totalResults":{"type":"number","description":"Total de registros"}},"required":["data","sum","totalPages","totalResults"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/publication/read-movement/{id}/law-suit-prefill":{"get":{"summary":"Obter dados para criar processo a partir de uma movimentação de publicação","tags":["Publications"],"description":"Lê as colunas da movimentação (processo, tribunal, órgão, partes quando o content for estruturado) e resolve pessoas já cadastradas no escritório. Serve para pré-preencher a criação de processo sem consultar API externa. O parâmetro `id` é o ID da movimentação (`publication_movements`), o mesmo usado em PATCH /publication/read-movement/:id — não o ID da publicação. Vale para qualquer provider; o content Juridiq DJEN é mais completo que o da Solucionare. Location Solucionare (`estado - uf`) não é interpretada como tribunal/vara. Não cria nem altera registros.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da movimentação de publicação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"publicationMovementId":{"type":"string","format":"uuid"},"processNumber":{"type":"string","nullable":true},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"personOrigin":{"type":"string","enum":["Cliente","Requerida"],"description":"Polo da parte no processo. \"Cliente\" = parte representada pelo escritório. \"Requerida\" = parte adversa. Use exatamente essas strings (case-sensitive)."},"document":{"type":"string","nullable":true},"poloLabel":{"type":"string"}},"required":["name","personOrigin","document","poloLabel"],"additionalProperties":false}},"opposingParties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"personOrigin":{"type":"string","enum":["Cliente","Requerida"],"description":"Polo da parte no processo. \"Cliente\" = parte representada pelo escritório. \"Requerida\" = parte adversa. Use exatamente essas strings (case-sensitive)."},"document":{"type":"string","nullable":true},"poloLabel":{"type":"string"}},"required":["name","personOrigin","document","poloLabel"],"additionalProperties":false}},"court":{"type":"string","nullable":true},"courtBranch":{"type":"string","nullable":true},"actionGroup":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["name"],"additionalProperties":false,"nullable":true},"typeAction":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["name"],"additionalProperties":false,"nullable":true},"lawSuitId":{"type":"string","format":"uuid","nullable":true},"existsInApi":{"type":"boolean","enum":[false]}},"required":["publicationMovementId","processNumber","persons","opposingParties","court","courtBranch","actionGroup","typeAction","lawSuitId","existsInApi"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/publication/{id}":{"get":{"summary":"Buscar publicação","tags":["Publications"],"description":"Devolve o detalhe de uma movimentação de publicação do escritório autenticado. O parâmetro `id` é o ID da movimentação (`publication_movements`), o mesmo da listagem — não o ID da publicação. Em `lawSuit.persons`, os clientes do escritório vêm primeiro. `prevUnreadId`, `nextUnreadId`, `unreadPosition` e `unreadTotal` navegam pelas não lidas do usuário autenticado (o dono da chave de API) nas publicações monitoradas em que ele é responsável, sem as arquivadas, ordenadas pela data efetiva (a menor entre disponibilização e publicação, ou a data de captura quando não há nenhuma das duas) da mais recente para a mais antiga — a ordem padrão de GET /publication. Vêm null quando a movimentação está fora dessa navegação (já lida, sem título, de publicação arquivada ou de monitoramento em que o usuário não é responsável). Aceita JWT ou o header `x-juridiq-api-key`.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da movimentação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da movimentação"},"title":{"type":"string","nullable":true,"description":"Título"},"content":{"type":"string","nullable":true,"description":"Conteúdo"},"descriptionSmall":{"type":"string","nullable":true,"description":"Resumo"},"officialDiary":{"type":"string","nullable":true,"description":"Diário oficial"},"availabilityDate":{"type":"string","nullable":true,"description":"Data de disponibilização"},"publicationDate":{"type":"string","nullable":true,"description":"Data da publicação"},"location":{"type":"string","nullable":true,"description":"Local"},"type":{"type":"string","enum":["oab","name_adv","name_parties","lawsuit","content"],"nullable":true,"description":"Tipo do monitoramento"},"term":{"type":"string","nullable":true,"description":"Termo monitorado"},"name":{"type":"string","nullable":true,"description":"Nome monitorado (legado)"},"variations":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Variações do termo"},"prevUnreadId":{"type":"string","nullable":true,"description":"Não lida anterior na navegação. null na primeira ou quando esta movimentação está fora da navegação"},"nextUnreadId":{"type":"string","nullable":true,"description":"Próxima não lida na navegação. null na última ou quando esta movimentação está fora da navegação"},"unreadPosition":{"type":"number","nullable":true,"description":"Posição desta entre as não lidas, começando em 1. null quando esta movimentação está fora da navegação"},"unreadTotal":{"type":"number","nullable":true,"description":"Total de não lidas da navegação. null quando esta movimentação está fora da navegação"},"isHandled":{"type":"boolean","nullable":true,"description":"Já tratada"},"readAt":{"type":"string","format":"date-time","nullable":true,"description":"Data da leitura"},"readBy":{"type":"object","properties":{"id":{"type":"string","description":"ID do usuário que leu"},"name":{"type":"string","nullable":true,"description":"Nome do usuário que leu"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"}},"required":["id"],"additionalProperties":false,"nullable":true,"description":"Usuário que leu"},"createdAt":{"type":"string","format":"date-time"},"diaryId":{"type":"string","nullable":true,"description":"ID da publicação ou do diário no provedor de origem"},"pageFound":{"type":"number","nullable":true,"description":"Página do diário em que a publicação foi encontrada"},"lawSuit":{"type":"object","properties":{"id":{"type":"string","description":"ID do processo"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo"},"typeAction":{"type":"string","nullable":true,"description":"Tipo de ação"},"actionGroup":{"type":"string","nullable":true,"description":"Grupo de ação"},"responsibles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"imageUrl":{"type":"string","nullable":true}},"required":["id","name"],"additionalProperties":false},"description":"Responsáveis do processo"},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"description":"Partes do processo, com os clientes do escritório primeiro"}},"required":["id","responsibles","persons"],"additionalProperties":false,"nullable":true,"description":"Processo vinculado. null quando não há vínculo"}},"required":["id"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/publication/read-movements-many":{"patch":{"summary":"Marcar publicações como lidas","tags":["Publications"],"description":"Marca como lidas as movimentações de publicação do escritório autenticado. `ids` são IDs de movimentação (os da listagem), não de publicação. Tudo ou nada: se algum id não existe no escritório, responde 404 e nenhuma é marcada; os ids não encontrados vêm no texto de `translateMessage`. Id repetido no corpo também responde 404, sem id listado. O leitor gravado é o usuário autenticado (o dono da chave de API) e a data de leitura é a do momento da chamada, inclusive nas já lidas. Aceita JWT ou o header `x-juridiq-api-key`.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs das movimentações"}},"required":["ids"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Mensagem de sucesso"},"updatedCount":{"type":"number","description":"Quantidade atualizada"},"processedIds":{"type":"array","items":{"type":"string"},"description":"IDs processados"}},"required":["message","updatedCount","processedIds"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/publication/discard":{"delete":{"summary":"Descartar publicações","tags":["Publications"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs das movimentações"}},"required":["ids"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/degree-of-risk/":{"get":{"summary":"Listar graus de risco","tags":["Degree of Risk"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra por nome"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do grau de risco"},"name":{"type":"string","description":"Nome"},"officeId":{"type":"string","description":"ID do escritório"}},"required":["id","name","officeId"],"additionalProperties":true},"description":"Lista de graus de risco"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar grau de risco","tags":["Degree of Risk"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome"}},"required":["name"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do grau de risco"},"name":{"type":"string","description":"Nome"},"officeId":{"type":"string","description":"ID do escritório"}},"required":["id","name","officeId"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"delete":{"summary":"Excluir graus de risco","tags":["Degree of Risk"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs dos graus de risco"}},"required":["id"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/degree-of-risk/{id}":{"get":{"summary":"Buscar grau de risco","tags":["Degree of Risk"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do grau de risco"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do grau de risco"},"name":{"type":"string","description":"Nome"},"officeId":{"type":"string","description":"ID do escritório"}},"required":["id","name","officeId"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar grau de risco","tags":["Degree of Risk"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome"}},"required":["name"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do grau de risco"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do grau de risco"},"name":{"type":"string","description":"Nome"},"officeId":{"type":"string","description":"ID do escritório"}},"required":["id","name","officeId"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/integration/":{"get":{"summary":"Listar integrações do escritório","tags":["Integrations"],"description":"Retorna o status das integrações vinculadas ao escritório.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response"},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/financial/bills":{"get":{"summary":"Listar contas financeiras","tags":["Financial"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra por nome"},{"schema":{"type":"string"},"in":"query","name":"icon","required":false,"description":"Filtra por ícone"},{"schema":{"type":"string"},"in":"query","name":"isPrivate","required":false,"description":"true ou false"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"Ordenação"},{"schema":{"type":"string"},"in":"query","name":"includeInactive","required":false,"description":"true inclui carteiras arquivadas"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da conta"},"name":{"type":"string","description":"Nome"},"icon":{"type":"string","description":"Ícone"},"isPrivate":{"type":"boolean","description":"Conta privada"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"value":{"type":"number","description":"Saldo realizado"},"type":{"type":"string","enum":["positive","negative"],"description":"Tipo de saldo"},"openingBalance":{"type":"number","description":"Saldo inicial"},"openingDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data do saldo inicial"},"active":{"type":"boolean","description":"Carteira ativa"},"bankAccount":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"bankName":{"type":"string"},"accountNumber":{"type":"string"},"branch":{"type":"string","nullable":true}},"required":["id","bankName","accountNumber","branch"],"additionalProperties":false,"nullable":true,"description":"Conta bancária ligada"},"responsibles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do responsável"},"name":{"type":"string","description":"Nome"},"avatar":{"type":"string","nullable":true,"description":"Avatar"}},"required":["id","name"],"additionalProperties":false},"description":"Responsáveis"}},"required":["id","name","icon","isPrivate","officeId","createdAt","updatedAt","value","type","responsibles"],"additionalProperties":true},"description":"Contas"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar conta financeira","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome"},"icon":{"type":"string","description":"Ícone"},"isPrivate":{"type":"boolean","description":"Conta privada"},"openingBalance":{"type":"number","description":"Saldo inicial"},"openingDate":{"type":"string","description":"Data do saldo inicial (AAAA-MM-DD)"},"active":{"type":"boolean","description":"false arquiva a carteira"},"responsibles":{"type":"array","items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false}]},"nullable":true,"description":"Responsáveis pela conta"}},"required":["name","icon"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da conta"},"name":{"type":"string","description":"Nome"},"icon":{"type":"string","description":"Ícone"},"isPrivate":{"type":"boolean","description":"Conta privada"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"responsibles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do responsável"},"responsibleId":{"type":"string","format":"uuid","description":"ID do responsável (formato legado)"},"name":{"type":"string","description":"Nome"},"avatar":{"type":"string","nullable":true,"description":"Avatar"}},"additionalProperties":true},"description":"Responsáveis"}},"required":["id","name","icon","isPrivate","officeId","createdAt","updatedAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bills/{id}":{"get":{"summary":"Obter conta financeira","tags":["Financial"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da conta"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da conta"},"name":{"type":"string","description":"Nome"},"icon":{"type":"string","description":"Ícone"},"isPrivate":{"type":"boolean","description":"Conta privada"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","icon","isPrivate","officeId","createdAt","updatedAt"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar conta financeira","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome"},"icon":{"type":"string","description":"Ícone"},"isPrivate":{"type":"boolean","description":"Conta privada"},"openingBalance":{"type":"number","description":"Saldo inicial"},"openingDate":{"type":"string","description":"Data do saldo inicial (AAAA-MM-DD)"},"active":{"type":"boolean","description":"false arquiva a carteira"},"responsibles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"nullable":true,"description":"Responsáveis pela conta"}},"required":["name"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da conta"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da conta"},"name":{"type":"string","description":"Nome"},"icon":{"type":"string","description":"Ícone"},"isPrivate":{"type":"boolean","description":"Conta privada"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"},"responsibles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do responsável"},"responsibleId":{"type":"string","format":"uuid","description":"ID do responsável (formato legado)"},"name":{"type":"string","description":"Nome"},"avatar":{"type":"string","nullable":true,"description":"Avatar"}},"additionalProperties":true},"description":"Responsáveis"}},"required":["id","name","icon","isPrivate","officeId","createdAt","updatedAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir conta financeira","tags":["Financial"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da conta"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/categories":{"get":{"summary":"Listar categorias financeiras","tags":["Financial"],"description":"Lista as categorias financeiras do escritório da credencial, da mais recente para a mais antiga. Sem limit, devolve todas. O filtro type=incoming ou outcoming inclui as categorias compartilhadas (both).","parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página, começa em 1; só vale junto com limit. Ausente, zero, negativo ou não numérico é ignorado"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página; ausente, zero, negativo ou não numérico devolve todas"},{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra por nome, sem diferenciar acento nem maiúscula"},{"schema":{"type":"string"},"in":"query","name":"color","required":false,"description":"Filtra por cor"},{"schema":{"type":"string"},"in":"query","name":"icon","required":false,"description":"Filtra por ícone"},{"schema":{"type":"string"},"in":"query","name":"type","required":false,"description":"incoming ou outcoming trazem também as compartilhadas (both); both traz só as compartilhadas; outro valor filtra por trecho do texto"},{"schema":{"type":"string"},"in":"query","name":"orderBy","required":false,"description":"Sem efeito: a lista vem da mais recente para a mais antiga"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da categoria"},"name":{"type":"string","description":"Nome"},"color":{"type":"string","description":"Cor"},"icon":{"type":"string","description":"Ícone"},"type":{"type":"string","description":"incoming (receita), outcoming (despesa) ou both (receita e despesa); categorias de importações antigas podem trazer outro texto"},"nature":{"type":"string","enum":["revenue","deduction","direct_cost","operating_expense","third_party","equity_movement"],"description":"Natureza; third_party e equity_movement ficam fora do DRE"},"equityKind":{"type":"string","enum":["financing","partners","investment","adjustment"],"nullable":true,"description":"Só em movimentação patrimonial (equity_movement): financing, partners, investment ou adjustment"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"nullable":true,"description":"Só em dinheiro de cliente: a espécie que a categoria costuma ter (a mais usada no escritório ou a que o nome diz). Vazio quando a categoria é genérica e a espécie precisa ser escolhida no lançamento."},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Categoria pai"},"active":{"type":"boolean","description":"Ativa"},"systemKey":{"type":"string","nullable":true,"description":"Chave de sistema"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","color","icon","type","officeId"],"additionalProperties":true},"description":"Categorias"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Criar categoria financeira","tags":["Financial"],"description":"Cria uma categoria financeira no escritório da credencial; o escritório vem do token ou da chave de API, nunca do corpo. type both deixa a categoria disponível em receitas e despesas. Nome igual a outro do mesmo escritório responde 409 quando os tipos se sobrepõem: incoming e outcoming podem repetir nome entre si, mas both colide com qualquer tipo.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome"},"color":{"type":"string","description":"Cor"},"icon":{"type":"string","description":"Ícone"},"type":{"type":"string","enum":["incoming","outcoming","both"],"description":"incoming (receita), outcoming (despesa) ou both (receita e despesa)"},"nature":{"type":"string","enum":["revenue","deduction","direct_cost","operating_expense","third_party","equity_movement"],"description":"Natureza. third_party (dinheiro de cliente) e equity_movement (movimentação patrimonial: empréstimos, sócios, investimentos, ajustes) ficam fora do DRE e aparecem no fluxo de caixa."},"equityKind":{"type":"string","enum":["financing","partners","investment","adjustment"],"nullable":true,"description":"Espécie, obrigatória em equity_movement: financing (empréstimos e amortizações), partners (aporte, integralização, antecipação e distribuição de lucros), investment (equipamentos, móveis, reformas, veículos, imóveis) ou adjustment (estornos, restituições, valores a identificar). Nas demais naturezas fica vazia."},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Categoria pai"}},"required":["name","color","icon","type"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da categoria"},"name":{"type":"string","description":"Nome"},"color":{"type":"string","description":"Cor"},"icon":{"type":"string","description":"Ícone"},"type":{"type":"string","description":"incoming (receita), outcoming (despesa) ou both (receita e despesa); categorias de importações antigas podem trazer outro texto"},"nature":{"type":"string","enum":["revenue","deduction","direct_cost","operating_expense","third_party","equity_movement"],"description":"Natureza; third_party e equity_movement ficam fora do DRE"},"equityKind":{"type":"string","enum":["financing","partners","investment","adjustment"],"nullable":true,"description":"Só em movimentação patrimonial (equity_movement): financing, partners, investment ou adjustment"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"nullable":true,"description":"Só em dinheiro de cliente: a espécie que a categoria costuma ter (a mais usada no escritório ou a que o nome diz). Vazio quando a categoria é genérica e a espécie precisa ser escolhida no lançamento."},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Categoria pai"},"active":{"type":"boolean","description":"Ativa"},"systemKey":{"type":"string","nullable":true,"description":"Chave de sistema"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","color","icon","type","officeId"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/categories/{id}":{"get":{"summary":"Obter categoria financeira","tags":["Financial"],"description":"Devolve uma categoria financeira do escritório da credencial. Categoria de outro escritório responde 404.","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da categoria"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da categoria"},"name":{"type":"string","description":"Nome"},"color":{"type":"string","description":"Cor"},"icon":{"type":"string","description":"Ícone"},"type":{"type":"string","description":"incoming (receita), outcoming (despesa) ou both (receita e despesa); categorias de importações antigas podem trazer outro texto"},"nature":{"type":"string","enum":["revenue","deduction","direct_cost","operating_expense","third_party","equity_movement"],"description":"Natureza; third_party e equity_movement ficam fora do DRE"},"equityKind":{"type":"string","enum":["financing","partners","investment","adjustment"],"nullable":true,"description":"Só em movimentação patrimonial (equity_movement): financing, partners, investment ou adjustment"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"nullable":true,"description":"Só em dinheiro de cliente: a espécie que a categoria costuma ter (a mais usada no escritório ou a que o nome diz). Vazio quando a categoria é genérica e a espécie precisa ser escolhida no lançamento."},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Categoria pai"},"active":{"type":"boolean","description":"Ativa"},"systemKey":{"type":"string","nullable":true,"description":"Chave de sistema"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","color","icon","type","officeId"],"additionalProperties":true}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar categoria financeira","tags":["Financial"],"description":"Substitui nome, cor, ícone e tipo de uma categoria do escritório da credencial; os quatro campos são obrigatórios. Trocar nome ou tipo para um nome que já existe no escritório em tipo que se sobrepõe (both colide com qualquer tipo) responde 409; categoria de outro escritório responde 404. Mudar o tipo não altera os lançamentos já feitos.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome"},"color":{"type":"string","description":"Cor"},"icon":{"type":"string","description":"Ícone"},"type":{"type":"string","enum":["incoming","outcoming","both"],"description":"incoming (receita), outcoming (despesa) ou both (receita e despesa)"},"nature":{"type":"string","enum":["revenue","deduction","direct_cost","operating_expense","third_party","equity_movement"],"description":"Natureza. third_party (dinheiro de cliente) e equity_movement (movimentação patrimonial: empréstimos, sócios, investimentos, ajustes) ficam fora do DRE e aparecem no fluxo de caixa."},"equityKind":{"type":"string","enum":["financing","partners","investment","adjustment"],"nullable":true,"description":"Espécie, obrigatória em equity_movement: financing (empréstimos e amortizações), partners (aporte, integralização, antecipação e distribuição de lucros), investment (equipamentos, móveis, reformas, veículos, imóveis) ou adjustment (estornos, restituições, valores a identificar). Nas demais naturezas fica vazia."},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Categoria pai"},"active":{"type":"boolean","description":"Ativa"}},"required":["name","color","icon","type"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da categoria"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da categoria"},"name":{"type":"string","description":"Nome"},"color":{"type":"string","description":"Cor"},"icon":{"type":"string","description":"Ícone"},"type":{"type":"string","description":"incoming (receita), outcoming (despesa) ou both (receita e despesa); categorias de importações antigas podem trazer outro texto"},"nature":{"type":"string","enum":["revenue","deduction","direct_cost","operating_expense","third_party","equity_movement"],"description":"Natureza; third_party e equity_movement ficam fora do DRE"},"equityKind":{"type":"string","enum":["financing","partners","investment","adjustment"],"nullable":true,"description":"Só em movimentação patrimonial (equity_movement): financing, partners, investment ou adjustment"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"nullable":true,"description":"Só em dinheiro de cliente: a espécie que a categoria costuma ter (a mais usada no escritório ou a que o nome diz). Vazio quando a categoria é genérica e a espécie precisa ser escolhida no lançamento."},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Categoria pai"},"active":{"type":"boolean","description":"Ativa"},"systemKey":{"type":"string","nullable":true,"description":"Chave de sistema"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","color","icon","type","officeId"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir categoria financeira","tags":["Financial"],"description":"Exclui uma categoria do escritório da credencial sem lançamentos nem subcategorias. Categoria com lançamentos, pagamentos registrados ou subcategorias responde 409. Categoria de outro escritório responde 404.","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da categoria"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/partners":{"get":{"summary":"Listar parceiros financeiros","tags":["Financial"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra por nome de exibição"},{"schema":{"type":"string"},"in":"query","name":"lawsuitSearch","required":false,"description":"Parceiros com processo (número ou código) contendo o termo"},{"schema":{"type":"string"},"in":"query","name":"transactionDescription","required":false,"description":"Parceiros com lançamento cuja descrição contém o termo"},{"schema":{"type":"string","enum":["active","inactive","suspended"]},"in":"query","name":"oabStatus","required":false,"description":"Situação da OAB"},{"schema":{"type":"string","enum":["correspondent","partner","associated","expert","dispatcher","translator","other"]},"in":"query","name":"practiceType","required":false,"description":"Tipo de atuação"},{"schema":{"type":"string","enum":["FIXED","PERCENTAGE","FIXED_AND_PERCENTAGE"]},"in":"query","name":"commissionType","required":false,"description":"Tipo de comissão"},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"excludeInactive","required":false,"description":"true = omite parceiros com status inactive (select de processo)"},{"schema":{"type":"string","enum":["name","updatedAt"]},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação (default updatedAt)"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"Direção (default desc)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do parceiro"},"name":{"type":"string","description":"Nome de exibição"},"photoUrl":{"type":"string","nullable":true,"description":"URL da foto"},"personType":{"type":"string","enum":["PF","PJ"],"nullable":true,"description":"PF ou PJ"},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ"},"phone":{"type":"string","nullable":true,"description":"Telefone"},"email":{"type":"string","nullable":true,"description":"E-mail"},"oabNumber":{"type":"string","nullable":true,"description":"Número da OAB"},"oabState":{"type":"string","nullable":true,"description":"UF da OAB"},"oabStatus":{"type":"string","enum":["active","inactive","suspended"],"nullable":true,"description":"Situação da OAB"},"practiceType":{"type":"string","enum":["correspondent","partner","associated","expert","dispatcher","translator","other"],"nullable":true,"description":"Tipo de atuação"},"pixKeyType":{"type":"string","enum":["cpf","cnpj","email","phone","random"],"nullable":true,"description":"Tipo da chave PIX"},"pixKey":{"type":"string","nullable":true,"description":"Chave PIX"},"pixHolderName":{"type":"string","nullable":true,"description":"Titular da chave PIX"},"city":{"type":"string","nullable":true,"description":"Cidade da comarca"},"state":{"type":"string","nullable":true,"description":"UF da comarca"},"status":{"type":"string","enum":["active","under_review","blocked","inactive"],"description":"Status de gestão"},"observation":{"type":"string","nullable":true,"description":"Observação interna do escritório"},"commissionType":{"type":"string","enum":["FIXED","PERCENTAGE","FIXED_AND_PERCENTAGE"],"description":"Tipo de comissão"},"percentage":{"type":"number","nullable":true,"description":"Percentual"},"fixedValue":{"type":"number","nullable":true,"description":"Valor fixo"},"commissionPaid":{"type":"number","description":"Comissão paga"},"commissionTotal":{"type":"number","description":"Comissão total"},"lawSuitCount":{"type":"number","description":"Quantidade de processos vinculados"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","photoUrl","personType","document","phone","email","oabNumber","oabState","oabStatus","practiceType","pixKeyType","pixKey","pixHolderName","city","state","status","observation","commissionType","percentage","fixedValue","commissionPaid","commissionTotal","lawSuitCount","createdAt","updatedAt"],"additionalProperties":false},"description":"Parceiros"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar parceiro financeiro","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Nome de exibição"},"photoUrl":{"anyOf":[{"type":"string","maxLength":2048},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"URL da foto"},"personType":{"anyOf":[{"type":"string","enum":["PF","PJ"]},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"PF ou PJ"},"document":{"anyOf":[{"type":"string","maxLength":32},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"CPF ou CNPJ"},"phone":{"anyOf":[{"type":"string","maxLength":32},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Telefone"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":255},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"E-mail"},"oabNumber":{"anyOf":[{"type":"string","maxLength":32},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Número da OAB"},"oabState":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"UF da OAB"},"oabStatus":{"anyOf":[{"type":"string","enum":["active","inactive","suspended"]},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Situação da OAB"},"practiceType":{"anyOf":[{"type":"string","enum":["correspondent","partner","associated","expert","dispatcher","translator","other"]},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Tipo de atuação"},"pixKeyType":{"anyOf":[{"type":"string","enum":["cpf","cnpj","email","phone","random"]},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Tipo da chave PIX"},"pixKey":{"anyOf":[{"type":"string","maxLength":255},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Chave PIX"},"city":{"anyOf":[{"type":"string","maxLength":255},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Cidade da comarca"},"state":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"UF da comarca"},"observation":{"anyOf":[{"type":"string","maxLength":5000},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Observação interna do escritório"},"commissionType":{"type":"string","enum":["FIXED","PERCENTAGE","FIXED_AND_PERCENTAGE"],"description":"Tipo de comissão"},"percentage":{"type":"number","nullable":true,"description":"Percentual"},"fixedValue":{"type":"number","nullable":true,"description":"Valor fixo"}},"required":["name","commissionType"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do parceiro"},"name":{"type":"string","description":"Nome de exibição"},"photoUrl":{"type":"string","nullable":true,"description":"URL da foto"},"personType":{"type":"string","enum":["PF","PJ"],"nullable":true,"description":"PF ou PJ"},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ"},"phone":{"type":"string","nullable":true,"description":"Telefone"},"email":{"type":"string","nullable":true,"description":"E-mail"},"oabNumber":{"type":"string","nullable":true,"description":"Número da OAB"},"oabState":{"type":"string","nullable":true,"description":"UF da OAB"},"oabStatus":{"type":"string","enum":["active","inactive","suspended"],"nullable":true,"description":"Situação da OAB"},"practiceType":{"type":"string","enum":["correspondent","partner","associated","expert","dispatcher","translator","other"],"nullable":true,"description":"Tipo de atuação"},"pixKeyType":{"type":"string","enum":["cpf","cnpj","email","phone","random"],"nullable":true,"description":"Tipo da chave PIX"},"pixKey":{"type":"string","nullable":true,"description":"Chave PIX"},"pixHolderName":{"type":"string","nullable":true,"description":"Titular da chave PIX"},"city":{"type":"string","nullable":true,"description":"Cidade da comarca"},"state":{"type":"string","nullable":true,"description":"UF da comarca"},"status":{"type":"string","enum":["active","under_review","blocked","inactive"],"description":"Status de gestão"},"observation":{"type":"string","nullable":true,"description":"Observação interna do escritório"},"commissionType":{"type":"string","enum":["FIXED","PERCENTAGE","FIXED_AND_PERCENTAGE"],"description":"Tipo de comissão"},"percentage":{"type":"number","nullable":true,"description":"Percentual"},"fixedValue":{"type":"number","nullable":true,"description":"Valor fixo"},"commissionPaid":{"type":"number","description":"Comissão paga"},"commissionTotal":{"type":"number","description":"Comissão total"},"lawSuitCount":{"type":"number","description":"Quantidade de processos vinculados"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","photoUrl","personType","document","phone","email","oabNumber","oabState","oabStatus","practiceType","pixKeyType","pixKey","pixHolderName","city","state","status","observation","commissionType","percentage","fixedValue","commissionPaid","commissionTotal","lawSuitCount","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/financial/partners/{id}":{"get":{"summary":"Obter parceiro financeiro","tags":["Financial"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do parceiro"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do parceiro"},"name":{"type":"string","description":"Nome de exibição"},"photoUrl":{"type":"string","nullable":true,"description":"URL da foto"},"personType":{"type":"string","enum":["PF","PJ"],"nullable":true,"description":"PF ou PJ"},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ"},"phone":{"type":"string","nullable":true,"description":"Telefone"},"email":{"type":"string","nullable":true,"description":"E-mail"},"oabNumber":{"type":"string","nullable":true,"description":"Número da OAB"},"oabState":{"type":"string","nullable":true,"description":"UF da OAB"},"oabStatus":{"type":"string","enum":["active","inactive","suspended"],"nullable":true,"description":"Situação da OAB"},"practiceType":{"type":"string","enum":["correspondent","partner","associated","expert","dispatcher","translator","other"],"nullable":true,"description":"Tipo de atuação"},"pixKeyType":{"type":"string","enum":["cpf","cnpj","email","phone","random"],"nullable":true,"description":"Tipo da chave PIX"},"pixKey":{"type":"string","nullable":true,"description":"Chave PIX"},"pixHolderName":{"type":"string","nullable":true,"description":"Titular da chave PIX"},"city":{"type":"string","nullable":true,"description":"Cidade da comarca"},"state":{"type":"string","nullable":true,"description":"UF da comarca"},"status":{"type":"string","enum":["active","under_review","blocked","inactive"],"description":"Status de gestão"},"observation":{"type":"string","nullable":true,"description":"Observação interna do escritório"},"commissionType":{"type":"string","enum":["FIXED","PERCENTAGE","FIXED_AND_PERCENTAGE"],"description":"Tipo de comissão"},"percentage":{"type":"number","nullable":true,"description":"Percentual"},"fixedValue":{"type":"number","nullable":true,"description":"Valor fixo"},"commissionPaid":{"type":"number","description":"Comissão paga"},"commissionTotal":{"type":"number","description":"Comissão total"},"lawSuitCount":{"type":"number","description":"Quantidade de processos vinculados"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","photoUrl","personType","document","phone","email","oabNumber","oabState","oabStatus","practiceType","pixKeyType","pixKey","pixHolderName","city","state","status","observation","commissionType","percentage","fixedValue","commissionPaid","commissionTotal","lawSuitCount","createdAt","updatedAt"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar parceiro financeiro","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Nome de exibição"},"photoUrl":{"anyOf":[{"type":"string","maxLength":2048},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"URL da foto"},"personType":{"anyOf":[{"type":"string","enum":["PF","PJ"]},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"PF ou PJ"},"document":{"anyOf":[{"type":"string","maxLength":32},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"CPF ou CNPJ"},"phone":{"anyOf":[{"type":"string","maxLength":32},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Telefone"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":255},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"E-mail"},"oabNumber":{"anyOf":[{"type":"string","maxLength":32},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Número da OAB"},"oabState":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"UF da OAB"},"oabStatus":{"anyOf":[{"type":"string","enum":["active","inactive","suspended"]},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Situação da OAB"},"practiceType":{"anyOf":[{"type":"string","enum":["correspondent","partner","associated","expert","dispatcher","translator","other"]},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Tipo de atuação"},"pixKeyType":{"anyOf":[{"type":"string","enum":["cpf","cnpj","email","phone","random"]},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Tipo da chave PIX"},"pixKey":{"anyOf":[{"type":"string","maxLength":255},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Chave PIX"},"city":{"anyOf":[{"type":"string","maxLength":255},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Cidade da comarca"},"state":{"anyOf":[{"type":"string","minLength":2,"maxLength":2},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"UF da comarca"},"observation":{"anyOf":[{"type":"string","maxLength":5000},{"type":"string","enum":[""]},{"enum":["null"],"nullable":true}],"description":"Observação interna do escritório"},"commissionType":{"type":"string","enum":["FIXED","PERCENTAGE","FIXED_AND_PERCENTAGE"],"description":"Tipo de comissão"},"percentage":{"type":"number","nullable":true,"description":"Percentual"},"fixedValue":{"type":"number","nullable":true,"description":"Valor fixo"},"status":{"type":"string","enum":["active","under_review","blocked","inactive"],"description":"Status de gestão (reativar soft-delete: active)"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do parceiro"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do parceiro"},"name":{"type":"string","description":"Nome de exibição"},"photoUrl":{"type":"string","nullable":true,"description":"URL da foto"},"personType":{"type":"string","enum":["PF","PJ"],"nullable":true,"description":"PF ou PJ"},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ"},"phone":{"type":"string","nullable":true,"description":"Telefone"},"email":{"type":"string","nullable":true,"description":"E-mail"},"oabNumber":{"type":"string","nullable":true,"description":"Número da OAB"},"oabState":{"type":"string","nullable":true,"description":"UF da OAB"},"oabStatus":{"type":"string","enum":["active","inactive","suspended"],"nullable":true,"description":"Situação da OAB"},"practiceType":{"type":"string","enum":["correspondent","partner","associated","expert","dispatcher","translator","other"],"nullable":true,"description":"Tipo de atuação"},"pixKeyType":{"type":"string","enum":["cpf","cnpj","email","phone","random"],"nullable":true,"description":"Tipo da chave PIX"},"pixKey":{"type":"string","nullable":true,"description":"Chave PIX"},"pixHolderName":{"type":"string","nullable":true,"description":"Titular da chave PIX"},"city":{"type":"string","nullable":true,"description":"Cidade da comarca"},"state":{"type":"string","nullable":true,"description":"UF da comarca"},"status":{"type":"string","enum":["active","under_review","blocked","inactive"],"description":"Status de gestão"},"observation":{"type":"string","nullable":true,"description":"Observação interna do escritório"},"commissionType":{"type":"string","enum":["FIXED","PERCENTAGE","FIXED_AND_PERCENTAGE"],"description":"Tipo de comissão"},"percentage":{"type":"number","nullable":true,"description":"Percentual"},"fixedValue":{"type":"number","nullable":true,"description":"Valor fixo"},"commissionPaid":{"type":"number","description":"Comissão paga"},"commissionTotal":{"type":"number","description":"Comissão total"},"lawSuitCount":{"type":"number","description":"Quantidade de processos vinculados"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","name","photoUrl","personType","document","phone","email","oabNumber","oabState","oabStatus","practiceType","pixKeyType","pixKey","pixHolderName","city","state","status","observation","commissionType","percentage","fixedValue","commissionPaid","commissionTotal","lawSuitCount","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir parceiro financeiro","tags":["Financial"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do parceiro"}],"security":[{"apiKeyAuth":[]}],"responses":{"204":{"description":"Sem conteúdo","content":{"application/json":{"schema":{"enum":["null"],"nullable":true,"description":"Sem conteúdo"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/partners/{id}/people":{"get":{"summary":"Listar pessoas vinculadas ao parceiro financeiro","tags":["Financial"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página (default 1)"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página (default 30)"},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"Busca por nome, documento, e-mail ou telefone"},{"schema":{"type":"string","enum":["cliente","parte adversa"]},"in":"query","name":"personOrigin","required":false,"description":"Filtro por origem da pessoa"},{"schema":{"type":"string","enum":["partnerLinkedAt","name"]},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação (default partnerLinkedAt)"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"Direção (default desc)"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do parceiro"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"},"document":{"type":"string","nullable":true,"description":"Documento"},"personType":{"type":"string","nullable":true,"description":"PF ou PJ"},"personOrigin":{"type":"string","nullable":true,"description":"Nome do tipo de pessoa no catálogo (Cliente, Requerida…)"},"email":{"type":"string","nullable":true,"description":"E-mail"},"phone":{"type":"string","nullable":true,"description":"Telefone"},"partnerLinkedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data do vínculo com o parceiro"},"linkedLawsuitCount":{"type":"number","description":"Processos em que a pessoa e o parceiro coexistem"}},"required":["id","name","document","personType","personOrigin","email","phone","partnerLinkedAt","linkedLawsuitCount"],"additionalProperties":false},"description":"Pessoas vinculadas ao parceiro"},"totalItems":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"},"page":{"type":"number","description":"Página atual"},"limit":{"type":"number","description":"Itens por página"}},"required":["data","totalItems","totalPages","page","limit"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions":{"get":{"summary":"Listar transações","tags":["Financial"],"description":"Lista os lançamentos do escritório com paginação, totais e dados do gráfico. O período (`month`/`year`, `periodType` ou `start`/`end`) vale para a data de `periodByDate`: `date` = vencimento, `paymentDate` = data de pagamento. Sem `periodByDate` nem `dateFilterType`, lançamento pago entra pela data de pagamento (sem data registrada, pelo vencimento) e pendente pelo vencimento; o `paymentDate` de lançamento pago sem data registrada vem com o vencimento. Fora de `periodByDate=date`, a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado: o lançamento aparece no período do pagamento e os totais somam só os pagamentos com data no período (com `status=pending`, `isPaid=false` ou `isDefaulters`, tudo pelo vencimento); o `partialValue` de cada lançamento é o total já pago. Contas privadas só aparecem para Suporte ou responsáveis da conta; perfil sem permissão de ver o saldo recebe todos os lançamentos, mas só os que criou (e as demais parcelas deles) trazem valor; os outros vêm com `valueHidden: true` e `value`, `partialValue`, `interestValue` e o valor das comissões zerados, e os totais e o gráfico vêm zerados. Perfil sem o Financeiro (`financial.view`) só lista com as permissões `lawsuits.view` e `lawsuits.view_financial` e um `lawSuitId` (uuid) de processo do escritório que ele consegue abrir (processo privado: Suporte ou responsável); aí recebe só os lançamentos daquele processo, com valores e totais, sem as comissões aninhadas. Sem permissão, sem `lawSuitId` válido ou com processo inacessível, responde 403. Com chave, \"Financeiro › Visualizar\". Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403. Com chave, contas privadas e a permissão de ver o saldo são as de quem criou a chave.","parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"query","required":false,"description":"Busca geral"},{"schema":{"type":"string"},"in":"query","name":"descriptionSearch","required":false,"description":"Busca por descrição"},{"schema":{"type":"string"},"in":"query","name":"clientSearch","required":false,"description":"Busca por cliente"},{"schema":{"type":"string"},"in":"query","name":"categoryId","required":false,"description":"ID da categoria, ou none para receitas e despesas sem categoria (as que ficam fora do DRE)"},{"schema":{"type":"string"},"in":"query","name":"type","required":false,"description":"incoming ou outcoming"},{"schema":{"type":"string"},"in":"query","name":"billId","required":false,"description":"ID da conta"},{"schema":{"type":"string"},"in":"query","name":"status","required":false,"description":"paid ou pending"},{"schema":{"type":"string"},"in":"query","name":"periodType","required":false,"description":"monthly, annual ou custom"},{"schema":{"type":"string"},"in":"query","name":"startDate","required":false,"description":"Data inicial"},{"schema":{"type":"string"},"in":"query","name":"endDate","required":false,"description":"Data final"},{"schema":{"type":"string","enum":["date","paymentAt"]},"in":"query","name":"dateFilterType","required":false,"description":"Forma antiga de periodByDate: date (vencimento) ou paymentAt (pagamento); periodByDate prevalece"},{"schema":{"type":"string","enum":["date","paymentDate","competenceDate"]},"in":"query","name":"periodByDate","required":false,"description":"Campo de data do período: date (vencimento), paymentDate (pagamento) ou competenceDate (competência, a do DRE). Omitido, junto com dateFilterType: lançamento pago entra pela data de pagamento (sem data registrada, pelo vencimento) e pendente pelo vencimento. Fora de date, a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado (com status=pending, isPaid=false ou isDefaulters, pelo vencimento)"},{"schema":{"type":"string"},"in":"query","name":"orderBy","required":false,"description":"Ordenação"},{"schema":{"type":"string"},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação"},{"schema":{"type":"string"},"in":"query","name":"description","required":false,"description":"Descrição"},{"schema":{"type":"string"},"in":"query","name":"value","required":false,"description":"Valor"},{"schema":{"type":"string"},"in":"query","name":"date","required":false,"description":"Data"},{"schema":{"type":"string"},"in":"query","name":"personId","required":false,"description":"ID da pessoa"},{"schema":{"type":"string"},"in":"query","name":"accountId","required":false,"description":"ID da conta"},{"schema":{"type":"string"},"in":"query","name":"lawSuitId","required":false,"description":"ID do processo"},{"schema":{"type":"string"},"in":"query","name":"partnerId","required":false,"description":"ID do parceiro financeiro"},{"schema":{"type":"string"},"in":"query","name":"month","required":false,"description":"Mês"},{"schema":{"type":"string"},"in":"query","name":"year","required":false,"description":"Ano"},{"schema":{"type":"string"},"in":"query","name":"start","required":false,"description":"Início do período"},{"schema":{"type":"string"},"in":"query","name":"end","required":false,"description":"Fim do período"},{"schema":{"type":"string"},"in":"query","name":"isPaid","required":false,"description":"true ou false"},{"schema":{"type":"string"},"in":"query","name":"isDefaulters","required":false,"description":"true ou false"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da transação"},"transactionId":{"type":"string","format":"uuid","description":"ID da transação"},"description":{"type":"string","description":"Descrição"},"type":{"type":"string","description":"incoming, outcoming ou transfer"},"value":{"type":"number","description":"Valor"},"partialValue":{"type":"number","nullable":true,"description":"Valor parcial"},"interestValue":{"type":"number","nullable":true,"description":"Diferença paga no Asaas: juros/multa (+) ou desconto (-)"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data"},"competenceDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Competência"},"paymentDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true,"description":"Data de pagamento"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"personId":{"type":"string","format":"uuid","nullable":true,"description":"ID da pessoa"},"billId":{"type":"string","format":"uuid","nullable":true,"description":"ID da conta"},"counterBillId":{"type":"string","format":"uuid","nullable":true,"description":"Carteira de destino da transferência"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"nullable":true,"description":"Espécie do dinheiro de terceiro"},"excludeFromDre":{"type":"boolean","description":"Fora do DRE"},"splitGroupId":{"type":"string","nullable":true,"description":"Mesmo valor em todas as partes de um recebimento ou pagamento dividido por categoria"},"feeAgreementId":{"type":"string","format":"uuid","nullable":true,"description":"Contrato de honorários"},"categoryId":{"type":"string","format":"uuid","nullable":true,"description":"ID da categoria"},"lawSuitId":{"type":"string","format":"uuid","nullable":true,"description":"ID do processo"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"ID do parceiro financeiro"},"partnerName":{"type":"string","nullable":true,"description":"Nome do parceiro financeiro"},"sourceTransactionId":{"type":"string","format":"uuid","nullable":true,"description":"ID da receita origem da comissão"},"commissionTransactionId":{"type":"string","format":"uuid","nullable":true,"description":"ID do lançamento de comissão gerado"},"sourceTransaction":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"description":{"type":"string"},"value":{"type":"number"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"isPaid":{"type":"boolean"},"type":{"type":"string"}},"required":["transactionId","description"],"additionalProperties":false,"nullable":true,"description":"Resumo do lançamento de origem"},"commissionTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"description":{"type":"string"},"value":{"type":"number"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"isPaid":{"type":"boolean"},"type":{"type":"string"}},"required":["transactionId","description","value","date","isPaid","type"],"additionalProperties":false},"description":"Subpagamentos / comissões vinculadas"},"isLocked":{"type":"boolean","description":"Comissão travada: não pode editar nem remover"},"isRetroactive":{"type":"boolean","description":"Receita anterior à vinculação do parceiro; comissão automática não gerada"},"valueHidden":{"type":"boolean","description":"Valor oculto: o usuário não vê valores e não criou este lançamento"},"isPaid":{"type":"boolean","description":"Pago"},"isFixed":{"type":"boolean","description":"Fixa"},"hasScheduling":{"type":"boolean","description":"Possui parcelamento"},"installmentLabel":{"type":"string","nullable":true,"description":"Rótulo da parcela"},"annotations":{"type":"string","nullable":true,"description":"Anotações"},"billName":{"type":"string","description":"Nome da conta"},"billIcon":{"type":"string","description":"Ícone da conta"},"billIsPrivate":{"type":"boolean","description":"Conta privada"},"categoryName":{"type":"string","nullable":true,"description":"Nome da categoria"},"categoryColor":{"type":"string","nullable":true,"description":"Cor da categoria"},"categoryIcon":{"type":"string","nullable":true,"description":"Ícone da categoria"},"personName":{"type":"string","nullable":true,"description":"Nome da pessoa"},"lawSuitProcessNumber":{"type":"string","nullable":true,"description":"Número do processo"},"isExternalGateway":{"type":"boolean","description":"Gateway externo"},"gateway":{"type":"object","properties":{"kind":{"type":"string","enum":["PAYMENT","INSTALLMENT","SUBSCRIPTION"]},"value":{"type":"number"},"createdAt":{"type":"string"},"status":{"type":"string"},"dueDate":{"type":"string"},"paymentDate":{"type":"string","nullable":true},"installmentNumber":{"type":"number","nullable":true},"discount":{"type":"object","properties":{"value":{"type":"number","description":"Valor do desconto"},"dueDateLimitDays":{"type":"integer","description":"Dias antes do vencimento até os quais o desconto vale","exclusiveMinimum":0},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"fine":{"type":"object","properties":{"value":{"type":"number","description":"Valor da multa por atraso"},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"interest":{"type":"object","properties":{"value":{"type":"number","description":"Juros ao mês, em percentual"}},"additionalProperties":false},"invoiceUrl":{"type":"string"},"gatewayPaymentUrl":{"type":"string"}},"required":["kind","value","createdAt","status","dueDate","paymentDate","installmentNumber","discount","fine","interest","invoiceUrl","gatewayPaymentUrl"],"additionalProperties":false,"nullable":true,"description":"Dados do gateway"}},"required":["description","type","value","date","officeId"],"additionalProperties":true},"description":"Transações"},"totals":{"type":"object","properties":{"total":{"type":"number","description":"Total"},"incoming":{"type":"number","description":"Entradas"},"outcoming":{"type":"number","description":"Saídas"}},"required":["total","incoming","outcoming"],"additionalProperties":false,"description":"Totais"},"chartIncome":{"type":"object","properties":{"partialValue":{"type":"number","description":"Valor parcial"},"totalValue":{"type":"number","description":"Valor total"}},"required":["partialValue","totalValue"],"additionalProperties":false,"description":"Gráfico de entradas"},"chartOutcome":{"type":"object","properties":{"partialValue":{"type":"number","description":"Valor parcial"},"totalValue":{"type":"number","description":"Valor total"}},"required":["partialValue","totalValue"],"additionalProperties":false,"description":"Gráfico de saídas"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"},"currentPage":{"type":"number","description":"Página atual"}},"required":["data","totals","chartIncome","chartOutcome","totalResults","totalPages","currentPage"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Criar transação","tags":["Financial"],"description":"Cria o lançamento e, com `repetitionType`, as parcelas ou repetições. `date` é o vencimento e `paymentDate` a data do pagamento, as duas em YYYY-MM-DD (com hora, o dia e o mês contam em UTC). Lançamento criado pago (`isPaid: true`) fica com a `paymentDate` enviada ou, sem ela, a data de agora; com parcelas ou repetição, a 1ª parcela paga recebe sempre a data de agora e a `paymentDate` é ignorada. Lançamento pago conta no mês da data de pagamento. `partialValue`, só na 1ª parcela, grava uma baixa parcial sem data, que conta pelo vencimento e, com `periodByDate=paymentDate`, fica fora do período e dos totais; para registrar um pagamento com data, use `POST /financial/transactions/{id}/payments`. Com `categorySplits`, o valor é dividido entre categorias (ex.: honorários + repasse ao cliente): cria um lançamento por parte, ligados pelo mesmo `splitGroupId`, e responde com a primeira parte e o `splitGroupId` (as demais saem em `GET /financial/transactions`). `excludeFromDre: true` mantém a categoria nos relatórios, mas tira o valor do DRE. Conta, categoria, pessoa ou processo inexistente responde 404. Exige permissão de editar o financeiro. Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"Descrição"},"type":{"type":"string","enum":["incoming","outcoming","transfer"],"description":"Tipo"},"value":{"type":"number","description":"Valor"},"date":{"type":"string","description":"Data de vencimento: YYYY-MM-DD, que conta como meia-noite UTC. Com hora ISO 8601, o dia e o mês contam em UTC, e hora sem fuso segue o fuso do servidor; para o dia local, envie só a data"},"competenceDate":{"type":"string","description":"Competência"},"officeId":{"type":"string","description":"Ignorado: o escritório vem da credencial (JWT ou API key)"},"personId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID da pessoa"},"billId":{"type":"string","format":"uuid","description":"ID da conta"},"counterBillId":{"type":"string","format":"uuid","description":"Carteira de destino da transferência"},"categoryId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID da categoria"},"lawSuitId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID do processo"},"partnerId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID do parceiro financeiro"},"isPaid":{"type":"boolean","description":"Pago"},"isRetroactive":{"type":"boolean","description":"Receita anterior à vinculação do parceiro"},"installmentCount":{"type":"integer","minimum":0,"maximum":480,"description":"Quantidade de parcelas"},"repetitionTransactionType":{"type":"string","description":"Frequência da repetição: daily, weekly, biweekly, monthly, bimonthly, quarterly, semiannual ou annually. Obrigatória com repetitionType=fixed ou com mais de uma parcela; outro valor responde 400."},"repetitionType":{"type":"string","description":"fixed (lançamento recorrente) ou o modo de parcelamento; fora de fixed exige installmentCount inteiro de 1 a 480."},"annotations":{"type":"string","description":"Anotações"},"partialValue":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"Valor parcial"},"interestValue":{"type":"number","nullable":true,"description":"Juros/multa (+) ou desconto (-) já incluído no valor"},"paymentDate":{"type":"string","description":"Data do pagamento: YYYY-MM-DD, que conta como meia-noite UTC. Com hora ISO 8601, o dia e o mês contam em UTC, e hora sem fuso segue o fuso do servidor; para o dia local, envie só a data"},"partnerCommission":{"type":"object","properties":{"billId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"Conta do lançamento de comissão"},"categoryId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"Categoria do lançamento de comissão"},"isPaid":{"type":"boolean","description":"Comissão já paga (só a primeira parcela)"},"paymentDate":{"type":"string","description":"Data de pagamento da comissão"},"annotations":{"type":"string","description":"Anotações da comissão"},"commissionType":{"type":"string","enum":["percentage","fixed","fixed_percentage"],"description":"Sobrescreve a regra de comissão só neste lançamento"},"percentage":{"type":"number","minimum":0,"maximum":100,"nullable":true,"description":"Percentual da comissão (override)"},"fixedValue":{"type":"number","minimum":0,"nullable":true,"description":"Valor fixo da comissão (override)"},"baseValue":{"type":"number","description":"Valor da receita usado no cálculo, quando difere do valor deste lançamento (entrada + parcelas)","exclusiveMinimum":0},"installments":{"type":"object","properties":{"installmentCount":{"type":"integer","minimum":1,"maximum":120,"description":"Quantidade de parcelas da comissão"},"repetitionTransactionType":{"type":"string","enum":["daily","weekly","biweekly","monthly","bimonthly","quarterly","semiannual","annually"],"description":"Intervalo entre as parcelas"},"firstInstallmentDate":{"type":"string","description":"Data da primeira parcela"},"entryValue":{"type":"number","description":"Valor da entrada da comissão","exclusiveMinimum":0},"entryDate":{"type":"string","description":"Data da entrada da comissão"}},"required":["installmentCount","repetitionTransactionType"],"additionalProperties":false,"description":"Parcela a comissão por conta própria, em vez de uma por parcela da receita"}},"additionalProperties":false,"description":"Configuração do lançamento de comissão gerado para o parceiro"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"description":"Espécie do dinheiro de terceiro"},"excludeFromDre":{"type":"boolean","description":"Fora do DRE: a categoria vale nos relatórios, mas o valor não entra no resultado"},"allocations":{"type":"array","items":{"type":"object","properties":{"costCenterId":{"type":"string","format":"uuid","description":"Centro de custo"},"amount":{"type":"number","description":"Valor da fatia","exclusiveMinimum":0}},"required":["costCenterId","amount"],"additionalProperties":false},"description":"Rateio do lançamento"},"categorySplits":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","description":"Valor da parte","exclusiveMinimum":0},"categoryId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"Categoria da parte"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"description":"Espécie, quando a categoria é dinheiro de cliente"},"description":{"type":"string","description":"Sem ela, vale a do lançamento"},"excludeFromDre":{"type":"boolean","description":"Fora do DRE"}},"required":["amount"],"additionalProperties":false},"minItems":2,"maxItems":20,"description":"Divide um mesmo recebimento ou pagamento entre categorias (ex.: honorários + repasse ao cliente). Cria um lançamento por parte, ligados pelo mesmo splitGroupId; as partes somam `value`. Só em lançamento único, sem parcelas, repetição nem rateio."}},"required":["description","type","value","date"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da transação"},"transactionId":{"type":"string","format":"uuid","description":"ID da transação"},"description":{"type":"string","description":"Descrição"},"type":{"type":"string","description":"incoming, outcoming ou transfer"},"value":{"type":"number","description":"Valor"},"partialValue":{"type":"number","nullable":true,"description":"Valor parcial"},"interestValue":{"type":"number","nullable":true,"description":"Diferença paga no Asaas: juros/multa (+) ou desconto (-)"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data"},"competenceDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Competência"},"paymentDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true,"description":"Data de pagamento"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"personId":{"type":"string","format":"uuid","nullable":true,"description":"ID da pessoa"},"billId":{"type":"string","format":"uuid","nullable":true,"description":"ID da conta"},"counterBillId":{"type":"string","format":"uuid","nullable":true,"description":"Carteira de destino da transferência"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"nullable":true,"description":"Espécie do dinheiro de terceiro"},"excludeFromDre":{"type":"boolean","description":"Fora do DRE"},"splitGroupId":{"type":"string","nullable":true,"description":"Mesmo valor em todas as partes de um recebimento ou pagamento dividido por categoria"},"feeAgreementId":{"type":"string","format":"uuid","nullable":true,"description":"Contrato de honorários"},"categoryId":{"type":"string","format":"uuid","nullable":true,"description":"ID da categoria"},"lawSuitId":{"type":"string","format":"uuid","nullable":true,"description":"ID do processo"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"ID do parceiro financeiro"},"partnerName":{"type":"string","nullable":true,"description":"Nome do parceiro financeiro"},"sourceTransactionId":{"type":"string","format":"uuid","nullable":true,"description":"ID da receita origem da comissão"},"commissionTransactionId":{"type":"string","format":"uuid","nullable":true,"description":"ID do lançamento de comissão gerado"},"sourceTransaction":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"description":{"type":"string"},"value":{"type":"number"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"isPaid":{"type":"boolean"},"type":{"type":"string"}},"required":["transactionId","description"],"additionalProperties":false,"nullable":true,"description":"Resumo do lançamento de origem"},"commissionTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"description":{"type":"string"},"value":{"type":"number"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"isPaid":{"type":"boolean"},"type":{"type":"string"}},"required":["transactionId","description","value","date","isPaid","type"],"additionalProperties":false},"description":"Subpagamentos / comissões vinculadas"},"isLocked":{"type":"boolean","description":"Comissão travada: não pode editar nem remover"},"isRetroactive":{"type":"boolean","description":"Receita anterior à vinculação do parceiro; comissão automática não gerada"},"valueHidden":{"type":"boolean","description":"Valor oculto: o usuário não vê valores e não criou este lançamento"},"isPaid":{"type":"boolean","description":"Pago"},"isFixed":{"type":"boolean","description":"Fixa"},"hasScheduling":{"type":"boolean","description":"Possui parcelamento"},"installmentLabel":{"type":"string","nullable":true,"description":"Rótulo da parcela"},"annotations":{"type":"string","nullable":true,"description":"Anotações"},"billName":{"type":"string","description":"Nome da conta"},"billIcon":{"type":"string","description":"Ícone da conta"},"billIsPrivate":{"type":"boolean","description":"Conta privada"},"categoryName":{"type":"string","nullable":true,"description":"Nome da categoria"},"categoryColor":{"type":"string","nullable":true,"description":"Cor da categoria"},"categoryIcon":{"type":"string","nullable":true,"description":"Ícone da categoria"},"personName":{"type":"string","nullable":true,"description":"Nome da pessoa"},"lawSuitProcessNumber":{"type":"string","nullable":true,"description":"Número do processo"},"isExternalGateway":{"type":"boolean","description":"Gateway externo"},"gateway":{"type":"object","properties":{"kind":{"type":"string","enum":["PAYMENT","INSTALLMENT","SUBSCRIPTION"]},"value":{"type":"number"},"createdAt":{"type":"string"},"status":{"type":"string"},"dueDate":{"type":"string"},"paymentDate":{"type":"string","nullable":true},"installmentNumber":{"type":"number","nullable":true},"discount":{"type":"object","properties":{"value":{"type":"number","description":"Valor do desconto"},"dueDateLimitDays":{"type":"integer","description":"Dias antes do vencimento até os quais o desconto vale","exclusiveMinimum":0},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"fine":{"type":"object","properties":{"value":{"type":"number","description":"Valor da multa por atraso"},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"interest":{"type":"object","properties":{"value":{"type":"number","description":"Juros ao mês, em percentual"}},"additionalProperties":false},"invoiceUrl":{"type":"string"},"gatewayPaymentUrl":{"type":"string"}},"required":["kind","value","createdAt","status","dueDate","paymentDate","installmentNumber","discount","fine","interest","invoiceUrl","gatewayPaymentUrl"],"additionalProperties":false,"nullable":true,"description":"Dados do gateway"}},"required":["description","type","value","date","officeId"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir transações","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"minItems":1},"deleteAll":{"type":"boolean","default":false}},"required":["ids"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/by-tags":{"get":{"summary":"Listar transações agrupadas por categoria","tags":["Financial"],"description":"Agrupa por categoria os lançamentos do escritório, com os filtros e a regra de período de `GET /financial/transactions`: sem `periodByDate` nem `dateFilterType`, lançamento pago entra pela data de pagamento (sem data registrada, pelo vencimento) e pendente pelo vencimento; fora de `periodByDate=date`, a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado (com `status=pending`, `isPaid=false` ou `isDefaulters`, pelo vencimento). Contas privadas só aparecem para Suporte ou responsáveis da conta; perfil sem permissão de ver o saldo recebe só os lançamentos que criou e as demais parcelas deles, com valores zerados. Com JWT, qualquer usuário do escritório; com chave, \"Financeiro › Visualizar\". Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403. Com chave, contas privadas e a permissão de ver o saldo são as de quem criou a chave.","parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"query","required":false,"description":"Busca geral"},{"schema":{"type":"string"},"in":"query","name":"descriptionSearch","required":false,"description":"Busca por descrição"},{"schema":{"type":"string"},"in":"query","name":"clientSearch","required":false,"description":"Busca por cliente"},{"schema":{"type":"string"},"in":"query","name":"categoryId","required":false,"description":"ID da categoria, ou none para receitas e despesas sem categoria (as que ficam fora do DRE)"},{"schema":{"type":"string"},"in":"query","name":"type","required":false,"description":"incoming ou outcoming"},{"schema":{"type":"string"},"in":"query","name":"billId","required":false,"description":"ID da conta"},{"schema":{"type":"string"},"in":"query","name":"status","required":false,"description":"paid ou pending"},{"schema":{"type":"string"},"in":"query","name":"periodType","required":false,"description":"monthly, annual ou custom"},{"schema":{"type":"string"},"in":"query","name":"startDate","required":false,"description":"Data inicial"},{"schema":{"type":"string"},"in":"query","name":"endDate","required":false,"description":"Data final"},{"schema":{"type":"string","enum":["date","paymentAt"]},"in":"query","name":"dateFilterType","required":false,"description":"Forma antiga de periodByDate: date (vencimento) ou paymentAt (pagamento); periodByDate prevalece"},{"schema":{"type":"string","enum":["date","paymentDate","competenceDate"]},"in":"query","name":"periodByDate","required":false,"description":"Campo de data do período: date (vencimento), paymentDate (pagamento) ou competenceDate (competência, a do DRE). Omitido, junto com dateFilterType: lançamento pago entra pela data de pagamento (sem data registrada, pelo vencimento) e pendente pelo vencimento. Fora de date, a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado (com status=pending, isPaid=false ou isDefaulters, pelo vencimento)"},{"schema":{"type":"string"},"in":"query","name":"orderBy","required":false,"description":"Ordenação"},{"schema":{"type":"string"},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação"},{"schema":{"type":"string"},"in":"query","name":"description","required":false,"description":"Descrição"},{"schema":{"type":"string"},"in":"query","name":"value","required":false,"description":"Valor"},{"schema":{"type":"string"},"in":"query","name":"date","required":false,"description":"Data"},{"schema":{"type":"string"},"in":"query","name":"personId","required":false,"description":"ID da pessoa"},{"schema":{"type":"string"},"in":"query","name":"lawSuitId","required":false,"description":"ID do processo"},{"schema":{"type":"string"},"in":"query","name":"partnerId","required":false,"description":"ID do parceiro financeiro"},{"schema":{"type":"string"},"in":"query","name":"month","required":false,"description":"Mês"},{"schema":{"type":"string"},"in":"query","name":"year","required":false,"description":"Ano"},{"schema":{"type":"string"},"in":"query","name":"start","required":false,"description":"Início do período"},{"schema":{"type":"string"},"in":"query","name":"end","required":false,"description":"Fim do período"},{"schema":{"type":"string"},"in":"query","name":"isPaid","required":false,"description":"true ou false"},{"schema":{"type":"string"},"in":"query","name":"isDefaulters","required":false,"description":"true ou false"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"categoryId":{"type":"string","format":"uuid","nullable":true,"description":"ID da categoria"},"categoryName":{"type":"string","nullable":true,"description":"Nome da categoria"},"transactionCount":{"type":"number","description":"Quantidade de transações"},"paidCount":{"type":"number","description":"Quantidade pagas"},"totalAmount":{"type":"number","description":"Valor total"},"paidAmount":{"type":"number","description":"Valor pago"},"pendingAmount":{"type":"number","description":"Valor pendente"},"incomingPaidAmount":{"type":"number","description":"Entradas pagas"},"outcomingPaidAmount":{"type":"number","description":"Saídas pagas"}},"required":["categoryId","categoryName","transactionCount","paidCount","totalAmount","paidAmount","pendingAmount"],"additionalProperties":false},"description":"Categorias"},"totals":{"type":"object","properties":{"total":{"type":"number","description":"Total"},"incoming":{"type":"number","description":"Entradas"},"outcoming":{"type":"number","description":"Saídas"}},"required":["total","incoming","outcoming"],"additionalProperties":false,"description":"Totais"},"chartIncome":{"type":"object","properties":{"partialValue":{"type":"number","description":"Valor parcial"},"totalValue":{"type":"number","description":"Valor total"}},"required":["partialValue","totalValue"],"additionalProperties":false,"description":"Gráfico de entradas"},"chartOutcome":{"type":"object","properties":{"partialValue":{"type":"number","description":"Valor parcial"},"totalValue":{"type":"number","description":"Valor total"}},"required":["partialValue","totalValue"],"additionalProperties":false,"description":"Gráfico de saídas"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"},"currentPage":{"type":"number","description":"Página atual"}},"required":["data","totals","chartIncome","chartOutcome","totalResults","totalPages","currentPage"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/by-tags/monthly-report":{"get":{"summary":"Relatório mensal de transações por conta","tags":["Financial"],"description":"Receitas, despesas e saldo por mês, de `start` a `end` (`YYYY-MM` ou data, até 24 meses), agrupados por conta. Cada lançamento entra no mês da data de `periodByDate`; sem `periodByDate` nem `dateFilterType`, lançamento pago entra no mês da data de pagamento (sem data registrada, no do vencimento) e pendente no do vencimento; pendente soma só a baixa parcial. Fora de `periodByDate=date`, a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado (com `status=pending`, `isPaid=false` ou `isDefaulters`, pelo vencimento). Contas privadas só aparecem para Suporte ou responsáveis da conta. Exige permissão de ver o saldo financeiro (403); com chave, também \"Financeiro › Visualizar\". Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403. Com chave, contas privadas e a permissão de ver o saldo são as de quem criou a chave.","parameters":[{"schema":{"type":"string"},"in":"query","name":"start","required":false,"description":"Data inicial"},{"schema":{"type":"string"},"in":"query","name":"end","required":false,"description":"Data final"},{"schema":{"type":"string"},"in":"query","name":"startPeriod","required":false,"description":"Período inicial (alternativo)"},{"schema":{"type":"string"},"in":"query","name":"endPeriod","required":false,"description":"Período final (alternativo)"},{"schema":{"type":"string"},"in":"query","name":"query","required":false,"description":"Busca geral"},{"schema":{"type":"string"},"in":"query","name":"descriptionSearch","required":false,"description":"Busca por descrição"},{"schema":{"type":"string"},"in":"query","name":"clientSearch","required":false,"description":"Busca por cliente"},{"schema":{"type":"string"},"in":"query","name":"categoryId","required":false,"description":"ID da categoria"},{"schema":{"type":"string"},"in":"query","name":"type","required":false,"description":"incoming ou outcoming"},{"schema":{"type":"string"},"in":"query","name":"billId","required":false,"description":"ID da conta"},{"schema":{"type":"string"},"in":"query","name":"status","required":false,"description":"paid ou pending"},{"schema":{"type":"string","enum":["date","paymentAt"]},"in":"query","name":"dateFilterType","required":false,"description":"Forma antiga de periodByDate: date (vencimento) ou paymentAt (pagamento); periodByDate prevalece"},{"schema":{"type":"string","enum":["date","paymentDate","competenceDate"]},"in":"query","name":"periodByDate","required":false,"description":"Campo de data do período: date (vencimento), paymentDate (pagamento) ou competenceDate (competência, a do DRE). Omitido, junto com dateFilterType: lançamento pago entra pela data de pagamento (sem data registrada, pelo vencimento) e pendente pelo vencimento. Fora de date, a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado (com status=pending, isPaid=false ou isDefaulters, pelo vencimento)"},{"schema":{"type":"string"},"in":"query","name":"description","required":false,"description":"Descrição"},{"schema":{"type":"string"},"in":"query","name":"value","required":false,"description":"Valor"},{"schema":{"type":"string"},"in":"query","name":"personId","required":false,"description":"ID da pessoa"},{"schema":{"type":"string"},"in":"query","name":"lawSuitId","required":false,"description":"ID do processo"},{"schema":{"type":"string"},"in":"query","name":"partnerId","required":false,"description":"ID do parceiro financeiro"},{"schema":{"type":"string"},"in":"query","name":"isPaid","required":false,"description":"true ou false"},{"schema":{"type":"string"},"in":"query","name":"isDefaulters","required":false,"description":"true ou false"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"periods":{"type":"array","items":{"type":"string"},"description":"Períodos"},"totalsByPeriod":{"type":"object","additionalProperties":{"type":"object","properties":{"income":{"type":"number","description":"Entradas"},"expense":{"type":"number","description":"Saídas"},"balance":{"type":"number","description":"Saldo"}},"required":["income","expense","balance"],"additionalProperties":false},"description":"Totais por período"},"grandTotals":{"type":"object","properties":{"income":{"type":"number","description":"Entradas"},"expense":{"type":"number","description":"Saídas"},"balance":{"type":"number","description":"Saldo"}},"required":["income","expense","balance"],"additionalProperties":false,"description":"Totais gerais"},"rows":{"type":"array","items":{"type":"object","properties":{"categoryId":{"type":"string","description":"ID da categoria"},"categoryName":{"type":"string","description":"Nome da categoria"},"billId":{"type":"string","format":"uuid","description":"ID da conta"},"billName":{"type":"string","description":"Nome da conta"},"totals":{"type":"object","properties":{"income":{"type":"number","description":"Entradas"},"expense":{"type":"number","description":"Saídas"},"balance":{"type":"number","description":"Saldo"}},"required":["income","expense","balance"],"additionalProperties":false,"description":"Totais da linha"},"months":{"type":"object","additionalProperties":{"type":"object","properties":{"income":{"type":"number","description":"Entradas"},"expense":{"type":"number","description":"Saídas"},"balance":{"type":"number","description":"Saldo"}},"required":["income","expense","balance"],"additionalProperties":false},"description":"Totais por mês"}},"required":["categoryId","categoryName","totals","months"],"additionalProperties":false},"description":"Linhas do relatório"}},"required":["periods","totalsByPeriod","grandTotals","rows"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/balance":{"get":{"summary":"Obter saldo mensal","tags":["Financial"],"description":"Totais de receitas e despesas do escritório e do mês corrente (fuso America/Sao_Paulo). No mês, lançamento pago conta pela data de pagamento (sem data registrada, pelo vencimento) e pendente pelo vencimento, somando só a baixa parcial; a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado. Contas privadas só aparecem para Suporte ou responsáveis da conta; perfil sem permissão de ver o saldo recebe zeros. Com JWT, qualquer usuário do escritório; com chave, \"Financeiro › Visualizar\". Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403. Com chave, contas privadas e a permissão de ver o saldo são as de quem criou a chave.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"totalIncome":{"type":"number","description":"Total de entradas"},"totalExpense":{"type":"number","description":"Total de saídas"},"monthlyExpense":{"type":"number","description":"Saída do mês"},"monthlyIncome":{"type":"number","description":"Entrada do mês"},"overallBalance":{"type":"number","description":"Saldo geral"}},"required":["totalIncome","totalExpense","monthlyExpense","monthlyIncome","overallBalance"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/future":{"get":{"summary":"Listar transações futuras","tags":["Financial"],"description":"Lista os lançamentos não pagos com vencimento de amanhã até 30 dias depois (fuso America/Sao_Paulo), do vencimento mais distante ao mais próximo, sem paginação. Contas privadas só aparecem para Gestor, Suporte ou responsáveis da conta; perfil sem permissão de ver o saldo recebe só os lançamentos que criou e as demais parcelas deles. `externalId` é o ID da cobrança no Asaas (null em lançamento manual) e `gateway` traz os dados dela. Com JWT, qualquer usuário do escritório; com chave, \"Financeiro › Visualizar\". Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403. Com chave, contas privadas e a permissão de ver o saldo são as de quem criou a chave.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Descrição"},"type":{"type":"string","enum":["incoming","outcoming"],"description":"Tipo"},"value":{"type":"number","description":"Valor"},"partialValue":{"type":"number","description":"Valor parcial"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data"},"categoryName":{"type":"string","description":"Nome da categoria"},"categoryIcon":{"type":"string","description":"Ícone da categoria"},"categoryColor":{"type":"string","description":"Cor da categoria"},"transactionId":{"type":"string","format":"uuid","description":"ID da transação"},"billId":{"type":"string","description":"ID da conta"},"billName":{"type":"string","description":"Nome da conta"},"billIcon":{"type":"string","description":"Ícone da conta"},"personId":{"type":"string","description":"ID da pessoa"},"personName":{"type":"string","description":"Nome da pessoa"},"lawSuitId":{"type":"string","description":"ID do processo"},"lawSuitProcessNumber":{"type":"string","description":"Número do processo"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"ID do parceiro financeiro"},"partnerName":{"type":"string","nullable":true,"description":"Nome do parceiro financeiro"},"isPaid":{"type":"boolean","description":"Pago"},"isRetroactive":{"type":"boolean","description":"Receita anterior à vinculação do parceiro"},"schedulingIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs de agendamento"},"installmentLabel":{"type":"string","description":"Rótulo da parcela"},"isFixed":{"type":"boolean","description":"Fixa"},"hasScheduling":{"type":"boolean","description":"Possui parcelamento"},"annotations":{"type":"string","nullable":true,"description":"Anotações"},"billIsPrivate":{"type":"boolean","description":"Conta privada"},"gateway":{"type":"object","properties":{"kind":{"type":"string","enum":["PAYMENT","INSTALLMENT","SUBSCRIPTION"]},"value":{"type":"number"},"createdAt":{"type":"string"},"status":{"type":"string"},"dueDate":{"type":"string"},"paymentDate":{"type":"string","nullable":true},"installmentNumber":{"type":"number","nullable":true},"discount":{"type":"object","properties":{"value":{"type":"number","description":"Valor do desconto"},"dueDateLimitDays":{"type":"integer","description":"Dias antes do vencimento até os quais o desconto vale","exclusiveMinimum":0},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"fine":{"type":"object","properties":{"value":{"type":"number","description":"Valor da multa por atraso"},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"interest":{"type":"object","properties":{"value":{"type":"number","description":"Juros ao mês, em percentual"}},"additionalProperties":false},"invoiceUrl":{"type":"string"},"gatewayPaymentUrl":{"type":"string"}},"required":["kind","value","createdAt","status","dueDate","paymentDate","installmentNumber","discount","fine","interest","invoiceUrl","gatewayPaymentUrl"],"additionalProperties":false,"nullable":true,"description":"Dados do gateway"},"externalId":{"type":"string","nullable":true,"description":"ID da cobrança no Asaas; null em lançamento manual"}},"required":["description","type","value","partialValue","date","categoryName","categoryIcon","categoryColor","transactionId","billId","billName","billIcon","personId","personName","lawSuitId","isPaid","isFixed"],"additionalProperties":true},"description":"Transações futuras"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/{id}/installments":{"get":{"summary":"Listar parcelas de transação","tags":["Financial"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da transação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"schedulingId":{"type":"string","format":"uuid","nullable":true,"description":"ID do agendamento"},"totalValue":{"type":"number","description":"Valor total"},"installmentCount":{"type":"number","description":"Quantidade de parcelas"},"individualValue":{"type":"number","description":"Valor individual"},"paidCount":{"type":"number","description":"Parcelas pagas"},"paidSum":{"type":"number","description":"Soma paga"},"installments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da parcela"},"installmentNumber":{"type":"number","nullable":true,"description":"Número da parcela"},"totalInstallments":{"type":"number","nullable":true,"description":"Total de parcelas"},"value":{"type":"number","description":"Valor"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data"},"isPaid":{"type":"boolean","description":"Pago"},"paymentDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true,"description":"Data de pagamento"}},"required":["id","installmentNumber","totalInstallments","value","date","isPaid"],"additionalProperties":false},"description":"Parcelas"}},"required":["schedulingId","totalValue","installmentCount","individualValue","paidCount","paidSum","installments"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/{id}/payments":{"get":{"summary":"Listar pagamentos parciais de uma transação","tags":["Financial"],"description":"Lista os pagamentos registrados do lançamento, do mais recente ao mais antigo, com o total pago e o restante. Lançamento com baixa parcial antiga, sem pagamentos registrados: `paidValue` e `remainingValue` contam a baixa parcial antiga, que só aparece em `data` depois do primeiro pagamento registrado. Com JWT, qualquer usuário do escritório; com chave, \"Financeiro › Visualizar\". Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403.","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da transação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do pagamento"},"transactionId":{"type":"string","format":"uuid","description":"ID da transação"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"value":{"type":"number","description":"Valor pago"},"paymentDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data do pagamento"},"paymentMethod":{"type":"string","description":"Forma de pagamento"},"observation":{"type":"string","nullable":true,"description":"Observação"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","transactionId","officeId","value","paymentDate","paymentMethod","createdAt","updatedAt"],"additionalProperties":false},"description":"Pagamentos parciais"},"paidValue":{"type":"number","description":"Valor total recebido"},"remainingValue":{"type":"number","description":"Valor faltante"},"transactionValue":{"type":"number","description":"Valor total do lançamento"}},"required":["data","paidValue","remainingValue","transactionValue"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Registrar pagamento parcial de uma transação","tags":["Financial"],"description":"Registra um pagamento (valor, data e forma) do lançamento. A soma dos pagamentos não pode passar do valor do lançamento (400). Se o lançamento tem baixa parcial antiga, sem pagamentos registrados, ela vira antes um pagamento com forma `OTHER`, na data de vencimento ou na do novo pagamento, a que for anterior. Quando a soma alcança o valor, o lançamento fica pago na data do pagamento mais recente. Nos períodos por data efetiva e por data de pagamento, cada pagamento de lançamento pendente conta no mês da própria data. Exige permissão de editar o financeiro. Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"number","description":"Valor pago","exclusiveMinimum":0},"paymentDate":{"type":"string","description":"Data do pagamento: YYYY-MM-DD, que conta como meia-noite UTC. Com hora ISO 8601, o dia e o mês contam em UTC, e hora sem fuso segue o fuso do servidor; para o dia local, envie só a data"},"paymentMethod":{"type":"string","enum":["CASH","PIX","BOLETO","CREDIT_CARD","DEBIT_CARD","BANK_TRANSFER","CHECK","OTHER"],"description":"Forma de pagamento"},"observation":{"type":"string","description":"Observação"}},"required":["value","paymentDate","paymentMethod"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da transação"}],"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do pagamento"},"transactionId":{"type":"string","format":"uuid","description":"ID da transação"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"value":{"type":"number","description":"Valor pago"},"paymentDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data do pagamento"},"paymentMethod":{"type":"string","description":"Forma de pagamento"},"observation":{"type":"string","nullable":true,"description":"Observação"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","transactionId","officeId","value","paymentDate","paymentMethod","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/{id}/payments/{paymentId}":{"patch":{"summary":"Atualizar pagamento parcial de uma transação","tags":["Financial"],"description":"Altera valor, data, forma ou observação de um pagamento do lançamento. A soma dos pagamentos não pode passar do valor do lançamento (400); o lançamento volta a pago ou pendente pela nova soma. Exige permissão de editar o financeiro. Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"number","description":"Valor pago","exclusiveMinimum":0},"paymentDate":{"type":"string","description":"Data do pagamento: YYYY-MM-DD, que conta como meia-noite UTC. Com hora ISO 8601, o dia e o mês contam em UTC, e hora sem fuso segue o fuso do servidor; para o dia local, envie só a data"},"paymentMethod":{"type":"string","enum":["CASH","PIX","BOLETO","CREDIT_CARD","DEBIT_CARD","BANK_TRANSFER","CHECK","OTHER"],"description":"Forma de pagamento"},"observation":{"type":"string","description":"Observação"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da transação"},{"schema":{"type":"string"},"in":"path","name":"paymentId","required":true,"description":"ID do pagamento parcial"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do pagamento"},"transactionId":{"type":"string","format":"uuid","description":"ID da transação"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"value":{"type":"number","description":"Valor pago"},"paymentDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data do pagamento"},"paymentMethod":{"type":"string","description":"Forma de pagamento"},"observation":{"type":"string","nullable":true,"description":"Observação"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","transactionId","officeId","value","paymentDate","paymentMethod","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir pagamento parcial de uma transação","tags":["Financial"],"description":"Exclui um pagamento do lançamento; o lançamento volta a pago ou pendente pela soma que resta. Exige permissão de excluir do financeiro. Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403.","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da transação"},{"schema":{"type":"string"},"in":"path","name":"paymentId","required":true,"description":"ID do pagamento parcial"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/{id}":{"get":{"summary":"Obter transação","tags":["Financial"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da transação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da transação"},"transactionId":{"type":"string","format":"uuid","description":"ID da transação"},"description":{"type":"string","description":"Descrição"},"type":{"type":"string","description":"incoming, outcoming ou transfer"},"value":{"type":"number","description":"Valor"},"partialValue":{"type":"number","nullable":true,"description":"Valor parcial"},"interestValue":{"type":"number","nullable":true,"description":"Diferença paga no Asaas: juros/multa (+) ou desconto (-)"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data"},"competenceDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Competência"},"paymentDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true,"description":"Data de pagamento"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"personId":{"type":"string","format":"uuid","nullable":true,"description":"ID da pessoa"},"billId":{"type":"string","format":"uuid","nullable":true,"description":"ID da conta"},"counterBillId":{"type":"string","format":"uuid","nullable":true,"description":"Carteira de destino da transferência"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"nullable":true,"description":"Espécie do dinheiro de terceiro"},"excludeFromDre":{"type":"boolean","description":"Fora do DRE"},"splitGroupId":{"type":"string","nullable":true,"description":"Mesmo valor em todas as partes de um recebimento ou pagamento dividido por categoria"},"feeAgreementId":{"type":"string","format":"uuid","nullable":true,"description":"Contrato de honorários"},"categoryId":{"type":"string","format":"uuid","nullable":true,"description":"ID da categoria"},"lawSuitId":{"type":"string","format":"uuid","nullable":true,"description":"ID do processo"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"ID do parceiro financeiro"},"partnerName":{"type":"string","nullable":true,"description":"Nome do parceiro financeiro"},"sourceTransactionId":{"type":"string","format":"uuid","nullable":true,"description":"ID da receita origem da comissão"},"commissionTransactionId":{"type":"string","format":"uuid","nullable":true,"description":"ID do lançamento de comissão gerado"},"sourceTransaction":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"description":{"type":"string"},"value":{"type":"number"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"isPaid":{"type":"boolean"},"type":{"type":"string"}},"required":["transactionId","description"],"additionalProperties":false,"nullable":true,"description":"Resumo do lançamento de origem"},"commissionTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"description":{"type":"string"},"value":{"type":"number"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"isPaid":{"type":"boolean"},"type":{"type":"string"}},"required":["transactionId","description","value","date","isPaid","type"],"additionalProperties":false},"description":"Subpagamentos / comissões vinculadas"},"isLocked":{"type":"boolean","description":"Comissão travada: não pode editar nem remover"},"isRetroactive":{"type":"boolean","description":"Receita anterior à vinculação do parceiro; comissão automática não gerada"},"valueHidden":{"type":"boolean","description":"Valor oculto: o usuário não vê valores e não criou este lançamento"},"isPaid":{"type":"boolean","description":"Pago"},"isFixed":{"type":"boolean","description":"Fixa"},"hasScheduling":{"type":"boolean","description":"Possui parcelamento"},"installmentLabel":{"type":"string","nullable":true,"description":"Rótulo da parcela"},"annotations":{"type":"string","nullable":true,"description":"Anotações"},"billName":{"type":"string","description":"Nome da conta"},"billIcon":{"type":"string","description":"Ícone da conta"},"billIsPrivate":{"type":"boolean","description":"Conta privada"},"categoryName":{"type":"string","nullable":true,"description":"Nome da categoria"},"categoryColor":{"type":"string","nullable":true,"description":"Cor da categoria"},"categoryIcon":{"type":"string","nullable":true,"description":"Ícone da categoria"},"personName":{"type":"string","nullable":true,"description":"Nome da pessoa"},"lawSuitProcessNumber":{"type":"string","nullable":true,"description":"Número do processo"},"isExternalGateway":{"type":"boolean","description":"Gateway externo"},"gateway":{"type":"object","properties":{"kind":{"type":"string","enum":["PAYMENT","INSTALLMENT","SUBSCRIPTION"]},"value":{"type":"number"},"createdAt":{"type":"string"},"status":{"type":"string"},"dueDate":{"type":"string"},"paymentDate":{"type":"string","nullable":true},"installmentNumber":{"type":"number","nullable":true},"discount":{"type":"object","properties":{"value":{"type":"number","description":"Valor do desconto"},"dueDateLimitDays":{"type":"integer","description":"Dias antes do vencimento até os quais o desconto vale","exclusiveMinimum":0},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"fine":{"type":"object","properties":{"value":{"type":"number","description":"Valor da multa por atraso"},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"interest":{"type":"object","properties":{"value":{"type":"number","description":"Juros ao mês, em percentual"}},"additionalProperties":false},"invoiceUrl":{"type":"string"},"gatewayPaymentUrl":{"type":"string"}},"required":["kind","value","createdAt","status","dueDate","paymentDate","installmentNumber","discount","fine","interest","invoiceUrl","gatewayPaymentUrl"],"additionalProperties":false,"nullable":true,"description":"Dados do gateway"}},"required":["description","type","value","date","officeId"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar transação","tags":["Financial"],"description":"Altera o lançamento e, com `updateType` `future` ou `all`, as demais parcelas de um lançamento recorrente; `date` e `interestValue` mudam só na parcela do `id`. Num lançamento recorrente com `future` ou `all`, enviar qualquer campo além da baixa (`isPaid`, `paymentDate`, `partialValue`), do rateio (`allocations`, que não vale para série), de `isRetroactive` e dos que valem só para a parcela do `id` (`date`, `interestValue`) exige abertos os meses de competência de todas as parcelas do escopo; senão, 409. `date` (vencimento) e `paymentDate` em YYYY-MM-DD (com hora, o dia e o mês contam em UTC); vazias contam como não enviadas. Marcar como pago (`isPaid: true`) usa a `paymentDate` enviada ou, sem ela, a data de agora. `partialValue` grava uma baixa parcial sem data, que conta pelo vencimento e, com `periodByDate=paymentDate`, fica fora do período e dos totais, e é ignorado quando o lançamento já tem pagamentos registrados; num lançamento sem pagamentos registrados, omitir `partialValue` zera a baixa parcial. Para registrar um pagamento com data, use `POST /financial/transactions/{id}/payments`. Num lançamento recorrente, `updateType` `future` ou `all` ignora `partialValue` e grava a `paymentDate` enviada só nas parcelas já pagas do escopo; com `isPaid: true` grava em todas, e com `isPaid: false` apaga a data de todas. Quando o pedido marca como paga a parcela do `id` que estava pendente, grava a data de agora. Fora disso, a data de pagamento de cada parcela não muda. Parcela paga sem data conta pelo vencimento e, com `periodByDate=paymentDate`, fica fora do período e dos totais. Exige permissão de editar o financeiro. Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"Descrição"},"billId":{"type":"string","description":"ID da conta"},"categoryId":{"type":"string","nullable":true,"description":"ID da categoria"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"partnerId":{"type":"string","nullable":true,"description":"ID do parceiro financeiro"},"isRetroactive":{"type":"boolean","description":"Receita anterior à vinculação do parceiro"},"value":{"type":"number","description":"Valor"},"date":{"type":"string","description":"Data de vencimento: YYYY-MM-DD, que conta como meia-noite UTC. Com hora ISO 8601, o dia e o mês contam em UTC, e hora sem fuso segue o fuso do servidor; para o dia local, envie só a data"},"competenceDate":{"type":"string","description":"Competência"},"isPaid":{"type":"boolean","description":"Pago"},"updateType":{"type":"string","enum":["only","future","all"],"description":"Escopo da atualização"},"annotations":{"description":"Anotações"},"partialValue":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"Valor parcial"},"interestValue":{"type":"number","nullable":true,"description":"Juros/multa (+) ou desconto (-) já incluído no valor"},"paymentDate":{"type":"string","description":"Data do pagamento: YYYY-MM-DD, que conta como meia-noite UTC. Com hora ISO 8601, o dia e o mês contam em UTC, e hora sem fuso segue o fuso do servidor; para o dia local, envie só a data"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"nullable":true,"description":"Espécie do dinheiro de terceiro"},"excludeFromDre":{"type":"boolean","description":"Fora do DRE: a categoria vale nos relatórios, mas o valor não entra no resultado"},"allocations":{"type":"array","items":{"type":"object","properties":{"costCenterId":{"type":"string","format":"uuid","description":"Centro de custo"},"amount":{"type":"number","description":"Valor da fatia","exclusiveMinimum":0}},"required":["costCenterId","amount"],"additionalProperties":false},"description":"Rateio do lançamento. Lista vazia tira o rateio."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da transação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da transação"},"transactionId":{"type":"string","format":"uuid","description":"ID da transação"},"description":{"type":"string","description":"Descrição"},"type":{"type":"string","description":"incoming, outcoming ou transfer"},"value":{"type":"number","description":"Valor"},"partialValue":{"type":"number","nullable":true,"description":"Valor parcial"},"interestValue":{"type":"number","nullable":true,"description":"Diferença paga no Asaas: juros/multa (+) ou desconto (-)"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data"},"competenceDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Competência"},"paymentDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true,"description":"Data de pagamento"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"personId":{"type":"string","format":"uuid","nullable":true,"description":"ID da pessoa"},"billId":{"type":"string","format":"uuid","nullable":true,"description":"ID da conta"},"counterBillId":{"type":"string","format":"uuid","nullable":true,"description":"Carteira de destino da transferência"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"nullable":true,"description":"Espécie do dinheiro de terceiro"},"excludeFromDre":{"type":"boolean","description":"Fora do DRE"},"splitGroupId":{"type":"string","nullable":true,"description":"Mesmo valor em todas as partes de um recebimento ou pagamento dividido por categoria"},"feeAgreementId":{"type":"string","format":"uuid","nullable":true,"description":"Contrato de honorários"},"categoryId":{"type":"string","format":"uuid","nullable":true,"description":"ID da categoria"},"lawSuitId":{"type":"string","format":"uuid","nullable":true,"description":"ID do processo"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"ID do parceiro financeiro"},"partnerName":{"type":"string","nullable":true,"description":"Nome do parceiro financeiro"},"sourceTransactionId":{"type":"string","format":"uuid","nullable":true,"description":"ID da receita origem da comissão"},"commissionTransactionId":{"type":"string","format":"uuid","nullable":true,"description":"ID do lançamento de comissão gerado"},"sourceTransaction":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"description":{"type":"string"},"value":{"type":"number"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"isPaid":{"type":"boolean"},"type":{"type":"string"}},"required":["transactionId","description"],"additionalProperties":false,"nullable":true,"description":"Resumo do lançamento de origem"},"commissionTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"description":{"type":"string"},"value":{"type":"number"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"isPaid":{"type":"boolean"},"type":{"type":"string"}},"required":["transactionId","description","value","date","isPaid","type"],"additionalProperties":false},"description":"Subpagamentos / comissões vinculadas"},"isLocked":{"type":"boolean","description":"Comissão travada: não pode editar nem remover"},"isRetroactive":{"type":"boolean","description":"Receita anterior à vinculação do parceiro; comissão automática não gerada"},"valueHidden":{"type":"boolean","description":"Valor oculto: o usuário não vê valores e não criou este lançamento"},"isPaid":{"type":"boolean","description":"Pago"},"isFixed":{"type":"boolean","description":"Fixa"},"hasScheduling":{"type":"boolean","description":"Possui parcelamento"},"installmentLabel":{"type":"string","nullable":true,"description":"Rótulo da parcela"},"annotations":{"type":"string","nullable":true,"description":"Anotações"},"billName":{"type":"string","description":"Nome da conta"},"billIcon":{"type":"string","description":"Ícone da conta"},"billIsPrivate":{"type":"boolean","description":"Conta privada"},"categoryName":{"type":"string","nullable":true,"description":"Nome da categoria"},"categoryColor":{"type":"string","nullable":true,"description":"Cor da categoria"},"categoryIcon":{"type":"string","nullable":true,"description":"Ícone da categoria"},"personName":{"type":"string","nullable":true,"description":"Nome da pessoa"},"lawSuitProcessNumber":{"type":"string","nullable":true,"description":"Número do processo"},"isExternalGateway":{"type":"boolean","description":"Gateway externo"},"gateway":{"type":"object","properties":{"kind":{"type":"string","enum":["PAYMENT","INSTALLMENT","SUBSCRIPTION"]},"value":{"type":"number"},"createdAt":{"type":"string"},"status":{"type":"string"},"dueDate":{"type":"string"},"paymentDate":{"type":"string","nullable":true},"installmentNumber":{"type":"number","nullable":true},"discount":{"type":"object","properties":{"value":{"type":"number","description":"Valor do desconto"},"dueDateLimitDays":{"type":"integer","description":"Dias antes do vencimento até os quais o desconto vale","exclusiveMinimum":0},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"fine":{"type":"object","properties":{"value":{"type":"number","description":"Valor da multa por atraso"},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"interest":{"type":"object","properties":{"value":{"type":"number","description":"Juros ao mês, em percentual"}},"additionalProperties":false},"invoiceUrl":{"type":"string"},"gatewayPaymentUrl":{"type":"string"}},"required":["kind","value","createdAt","status","dueDate","paymentDate","installmentNumber","discount","fine","interest","invoiceUrl","gatewayPaymentUrl"],"additionalProperties":false,"nullable":true,"description":"Dados do gateway"}},"required":["description","type","value","date","officeId"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/{id}/redistribute":{"patch":{"summary":"Redistribuir parcelas de transação","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"totalValue":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"Valor total redistribuído"}},"required":["totalValue"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da transação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"schedulingId":{"type":"string","format":"uuid","nullable":true,"description":"ID do agendamento"},"totalValue":{"type":"number","description":"Valor total"},"installmentCount":{"type":"number","description":"Quantidade de parcelas"},"individualValue":{"type":"number","description":"Valor individual"},"paidCount":{"type":"number","description":"Parcelas pagas"},"paidSum":{"type":"number","description":"Soma paga"},"installments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da parcela"},"installmentNumber":{"type":"number","nullable":true,"description":"Número da parcela"},"totalInstallments":{"type":"number","nullable":true,"description":"Total de parcelas"},"value":{"type":"number","description":"Valor"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data"},"isPaid":{"type":"boolean","description":"Pago"},"paymentDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true,"description":"Data de pagamento"}},"required":["id","installmentNumber","totalInstallments","value","date","isPaid"],"additionalProperties":false},"description":"Parcelas"}},"required":["schedulingId","totalValue","installmentCount","individualValue","paidCount","paidSum","installments"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/{id}/split":{"post":{"summary":"Dividir lançamento existente por categoria","tags":["Financial"],"description":"Divide entre categorias um lançamento que já existe (ex.: alvará lançado inteiro como honorários vira honorários + repasse ao cliente). O lançamento original vira a primeira parte e mantém conciliação com o extrato, anexos e nota fiscal; as demais partes são criadas com a mesma data, competência, conta, pessoa, processo e situação de pagamento, todas com o mesmo `splitGroupId`. As partes precisam somar o valor do lançamento. Só vale em lançamento único (sem parcelas nem repetição), sem pagamento parcial, rateio, comissão de parceiro ou contrato de honorários, e que ainda não esteja dividido; fora disso responde 422. Exige permissão de editar o financeiro com JWT; aceita o header `x-juridiq-api-key`.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parts":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","description":"Valor da parte","exclusiveMinimum":0},"categoryId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"Categoria da parte"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"description":"Espécie, quando a categoria é dinheiro de cliente"},"description":{"type":"string","description":"Sem ela, vale a do lançamento"},"excludeFromDre":{"type":"boolean","description":"Fora do DRE"}},"required":["amount"],"additionalProperties":false},"minItems":2,"maxItems":20,"description":"Partes da divisão; precisam somar o valor do lançamento. A primeira fica no lançamento original."}},"required":["parts"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da transação"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Lançamento dividido","content":{"application/json":{"schema":{"type":"object","properties":{"splitGroupId":{"type":"string","format":"uuid","description":"Grupo que liga as partes"},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"value":{"type":"number"},"categoryId":{"type":"string","nullable":true},"thirdPartyKind":{"type":"string","nullable":true},"excludeFromDre":{"type":"boolean"},"description":{"type":"string"}},"required":["id","value","categoryId","thirdPartyKind","excludeFromDre","description"],"additionalProperties":false},"description":"As partes, a original primeiro"}},"required":["splitGroupId","transactions"],"additionalProperties":false,"description":"Lançamento dividido"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/launchs/{id}":{"patch":{"summary":"Atualizar status de pagamento do lançamento","tags":["Financial"],"description":"Marca o lançamento como pago (`isPaid: true`, na `paymentDate` enviada ou, sem ela, agora) ou como pendente. `partialValue` grava uma baixa parcial sem data, que conta pelo vencimento e, com `periodByDate=paymentDate`, fica fora do período e dos totais, e é ignorado quando o lançamento já tem pagamentos registrados; num lançamento sem pagamentos registrados, omitir `partialValue` zera a baixa parcial. Para registrar um pagamento com data, use `POST /financial/transactions/{id}/payments`. Num lançamento recorrente, `updateType` `future` ou `all` ignora `partialValue` e grava a `paymentDate` enviada só nas parcelas já pagas do escopo; com `isPaid: true` grava em todas, e com `isPaid: false` apaga a data de todas. Quando o pedido marca como paga a parcela do `id` que estava pendente, grava a data de agora. Fora disso, a data de pagamento de cada parcela não muda. Parcela paga sem data conta pelo vencimento e, com `periodByDate=paymentDate`, fica fora do período e dos totais. Exige permissão de editar o financeiro. Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"isPaid":{"type":"boolean","description":"Pago"},"partialValue":{"type":"number","description":"Valor parcial"},"paymentDate":{"type":"string","description":"Data do pagamento: YYYY-MM-DD, que conta como meia-noite UTC. Com hora ISO 8601, o dia e o mês contam em UTC, e hora sem fuso segue o fuso do servidor; para o dia local, envie só a data"},"updateType":{"type":"string","enum":["only","future","all"],"description":"Escopo da atualização"}},"required":["isPaid"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID do lançamento"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da transação"},"transactionId":{"type":"string","format":"uuid","description":"ID da transação"},"description":{"type":"string","description":"Descrição"},"type":{"type":"string","description":"incoming, outcoming ou transfer"},"value":{"type":"number","description":"Valor"},"partialValue":{"type":"number","nullable":true,"description":"Valor parcial"},"interestValue":{"type":"number","nullable":true,"description":"Diferença paga no Asaas: juros/multa (+) ou desconto (-)"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Data"},"competenceDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Competência"},"paymentDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true,"description":"Data de pagamento"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"personId":{"type":"string","format":"uuid","nullable":true,"description":"ID da pessoa"},"billId":{"type":"string","format":"uuid","nullable":true,"description":"ID da conta"},"counterBillId":{"type":"string","format":"uuid","nullable":true,"description":"Carteira de destino da transferência"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"nullable":true,"description":"Espécie do dinheiro de terceiro"},"excludeFromDre":{"type":"boolean","description":"Fora do DRE"},"splitGroupId":{"type":"string","nullable":true,"description":"Mesmo valor em todas as partes de um recebimento ou pagamento dividido por categoria"},"feeAgreementId":{"type":"string","format":"uuid","nullable":true,"description":"Contrato de honorários"},"categoryId":{"type":"string","format":"uuid","nullable":true,"description":"ID da categoria"},"lawSuitId":{"type":"string","format":"uuid","nullable":true,"description":"ID do processo"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"ID do parceiro financeiro"},"partnerName":{"type":"string","nullable":true,"description":"Nome do parceiro financeiro"},"sourceTransactionId":{"type":"string","format":"uuid","nullable":true,"description":"ID da receita origem da comissão"},"commissionTransactionId":{"type":"string","format":"uuid","nullable":true,"description":"ID do lançamento de comissão gerado"},"sourceTransaction":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"description":{"type":"string"},"value":{"type":"number"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"isPaid":{"type":"boolean"},"type":{"type":"string"}},"required":["transactionId","description"],"additionalProperties":false,"nullable":true,"description":"Resumo do lançamento de origem"},"commissionTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"description":{"type":"string"},"value":{"type":"number"},"date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"isPaid":{"type":"boolean"},"type":{"type":"string"}},"required":["transactionId","description","value","date","isPaid","type"],"additionalProperties":false},"description":"Subpagamentos / comissões vinculadas"},"isLocked":{"type":"boolean","description":"Comissão travada: não pode editar nem remover"},"isRetroactive":{"type":"boolean","description":"Receita anterior à vinculação do parceiro; comissão automática não gerada"},"valueHidden":{"type":"boolean","description":"Valor oculto: o usuário não vê valores e não criou este lançamento"},"isPaid":{"type":"boolean","description":"Pago"},"isFixed":{"type":"boolean","description":"Fixa"},"hasScheduling":{"type":"boolean","description":"Possui parcelamento"},"installmentLabel":{"type":"string","nullable":true,"description":"Rótulo da parcela"},"annotations":{"type":"string","nullable":true,"description":"Anotações"},"billName":{"type":"string","description":"Nome da conta"},"billIcon":{"type":"string","description":"Ícone da conta"},"billIsPrivate":{"type":"boolean","description":"Conta privada"},"categoryName":{"type":"string","nullable":true,"description":"Nome da categoria"},"categoryColor":{"type":"string","nullable":true,"description":"Cor da categoria"},"categoryIcon":{"type":"string","nullable":true,"description":"Ícone da categoria"},"personName":{"type":"string","nullable":true,"description":"Nome da pessoa"},"lawSuitProcessNumber":{"type":"string","nullable":true,"description":"Número do processo"},"isExternalGateway":{"type":"boolean","description":"Gateway externo"},"gateway":{"type":"object","properties":{"kind":{"type":"string","enum":["PAYMENT","INSTALLMENT","SUBSCRIPTION"]},"value":{"type":"number"},"createdAt":{"type":"string"},"status":{"type":"string"},"dueDate":{"type":"string"},"paymentDate":{"type":"string","nullable":true},"installmentNumber":{"type":"number","nullable":true},"discount":{"type":"object","properties":{"value":{"type":"number","description":"Valor do desconto"},"dueDateLimitDays":{"type":"integer","description":"Dias antes do vencimento até os quais o desconto vale","exclusiveMinimum":0},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"fine":{"type":"object","properties":{"value":{"type":"number","description":"Valor da multa por atraso"},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"interest":{"type":"object","properties":{"value":{"type":"number","description":"Juros ao mês, em percentual"}},"additionalProperties":false},"invoiceUrl":{"type":"string"},"gatewayPaymentUrl":{"type":"string"}},"required":["kind","value","createdAt","status","dueDate","paymentDate","installmentNumber","discount","fine","interest","invoiceUrl","gatewayPaymentUrl"],"additionalProperties":false,"nullable":true,"description":"Dados do gateway"}},"required":["description","type","value","date","officeId"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/external/{externalId}":{"get":{"summary":"Obter transação externa","tags":["Financial"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"externalId","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["PAYMENT","INSTALLMENT","SUBSCRIPTION"]},"value":{"type":"number"},"createdAt":{"type":"string"},"status":{"type":"string"},"dueDate":{"type":"string"},"paymentDate":{"type":"string","nullable":true},"installmentNumber":{"type":"number","nullable":true},"discount":{"type":"object","properties":{"value":{"type":"number","description":"Valor do desconto"},"dueDateLimitDays":{"type":"integer","description":"Dias antes do vencimento até os quais o desconto vale","exclusiveMinimum":0},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"fine":{"type":"object","properties":{"value":{"type":"number","description":"Valor da multa por atraso"},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false},"interest":{"type":"object","properties":{"value":{"type":"number","description":"Juros ao mês, em percentual"}},"additionalProperties":false},"invoiceUrl":{"type":"string"},"gatewayPaymentUrl":{"type":"string"}},"required":["kind","value","createdAt","status","dueDate","paymentDate","installmentNumber","discount","fine","interest","invoiceUrl","gatewayPaymentUrl"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/periods":{"get":{"summary":"Listar fechamentos de competência","tags":["Financial"],"parameters":[{"schema":{"type":"integer","minimum":2000,"maximum":2100},"in":"query","name":"year","required":false,"description":"Ano"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Fechamentos","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do fechamento"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"year":{"type":"integer","description":"Ano"},"month":{"type":"integer","description":"Mês"},"status":{"type":"string","enum":["closed","reopened"],"description":"Status"},"closedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Fechado em"},"closedByUserId":{"type":"string","format":"uuid","description":"Quem fechou"},"reopenedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true,"description":"Reaberto em"},"reopenedByUserId":{"type":"string","format":"uuid","nullable":true,"description":"Quem reabriu"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","officeId","year","month","status","closedAt","closedByUserId"],"additionalProperties":true},"description":"Fechamentos"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/financial/periods/{year}/{month}/close":{"post":{"summary":"Fechar mês de competência","tags":["Financial"],"parameters":[{"schema":{"type":"integer","minimum":2000,"maximum":2100},"in":"path","name":"year","required":true,"description":"Ano"},{"schema":{"type":"integer","minimum":1,"maximum":12},"in":"path","name":"month","required":true,"description":"Mês"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do fechamento"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"year":{"type":"integer","description":"Ano"},"month":{"type":"integer","description":"Mês"},"status":{"type":"string","enum":["closed","reopened"],"description":"Status"},"closedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Fechado em"},"closedByUserId":{"type":"string","format":"uuid","description":"Quem fechou"},"reopenedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true,"description":"Reaberto em"},"reopenedByUserId":{"type":"string","format":"uuid","nullable":true,"description":"Quem reabriu"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","officeId","year","month","status","closedAt","closedByUserId"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/periods/{year}/{month}/reopen":{"post":{"summary":"Reabrir mês de competência","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{"reason":{"type":"string","maxLength":500,"description":"Motivo da reabertura, gravado na auditoria"}},"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"integer","minimum":2000,"maximum":2100},"in":"path","name":"year","required":true,"description":"Ano"},{"schema":{"type":"integer","minimum":1,"maximum":12},"in":"path","name":"month","required":true,"description":"Mês"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do fechamento"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"year":{"type":"integer","description":"Ano"},"month":{"type":"integer","description":"Mês"},"status":{"type":"string","enum":["closed","reopened"],"description":"Status"},"closedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Fechado em"},"closedByUserId":{"type":"string","format":"uuid","description":"Quem fechou"},"reopenedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true,"description":"Reaberto em"},"reopenedByUserId":{"type":"string","format":"uuid","nullable":true,"description":"Quem reabriu"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"description":"Atualizado em"}},"required":["id","officeId","year","month","status","closedAt","closedByUserId"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bank-accounts":{"get":{"summary":"Listar contas bancárias","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Criar conta bancária","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"billId":{"type":"string","format":"uuid","description":"Carteira da conta"},"bankName":{"type":"string","minLength":1,"description":"Banco"},"accountNumber":{"type":"string","minLength":1,"description":"Número da conta"},"branch":{"type":"string","nullable":true,"description":"Agência"}},"required":["billId","bankName","accountNumber"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bank-connections/connect-token":{"post":{"summary":"Gerar token do widget de conexão bancária","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bank-connections":{"get":{"summary":"Listar as conexões bancárias do escritório","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Registrar a conexão bancária devolvida pelo widget","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bank-connections/{id}/accounts":{"get":{"summary":"Listar as contas do banco de uma conexão","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"put":{"summary":"Ligar contas do banco a carteiras","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bank-connections/{id}":{"delete":{"summary":"Desconectar banco","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bank-connections/{id}/sync":{"post":{"summary":"Atualizar agora a conexão bancária","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bank-connections/{id}/connect-token":{"post":{"summary":"Token do widget para reconectar o banco","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bank-accounts/{id}":{"patch":{"summary":"Atualizar conta bancária","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"bankName":{"type":"string","minLength":1},"accountNumber":{"type":"string","minLength":1},"branch":{"type":"string","nullable":true},"active":{"type":"boolean","description":"false desativa a conta"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Apagar conta bancária vazia","tags":["Financial"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bank-accounts/{id}/statements":{"get":{"summary":"Listar extrato da conta","tags":["Financial"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"cursor","required":false,"description":"nextCursor da página anterior"},{"schema":{"type":"integer","minimum":1,"maximum":200,"default":200},"in":"query","name":"limit","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Importar OFX","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ofx":{"type":"string","minLength":1,"description":"Conteúdo OFX"},"fileName":{"type":"string"}},"required":["ofx"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bank-accounts/{id}/statements/{lineId}/confirm":{"post":{"summary":"Confirmar conciliação","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid"},"transactionId":{"type":"string","format":"uuid"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"lineId","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bank-accounts/{id}/statements/{lineId}/unreconcile":{"post":{"summary":"Desfazer conciliação","tags":["Financial"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"lineId","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/reports/dre":{"get":{"summary":"DRE do mês","tags":["Financial"],"description":"Resultado do mês pela competência, nas linhas do DRE do escritório. Exige year e month. Dinheiro de cliente (repasses, custas, depósitos), movimentação patrimonial e transferências ficam fora do DRE e aparecem só no fluxo de caixa (GET /financial/reports/cash-flow).","parameters":[{"schema":{"type":"integer"},"in":"query","name":"year","required":true,"description":"Ano com 4 dígitos, ex.: 2026"},{"schema":{"type":"integer","minimum":1,"maximum":12},"in":"query","name":"month","required":true,"description":"Mês de 1 a 12"},{"schema":{"type":"string"},"in":"query","name":"costCenterId","required":false,"description":"Filtra por centro de custo: UUID do centro ou unclassified (sem centro). Sem ele, o escritório todo"}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/dre-layout":{"get":{"summary":"Linhas do DRE e onde cada categoria entra","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/dre-layout/lines":{"post":{"summary":"Criar linha do DRE","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"description":"Nome da linha"},"description":{"type":"string","maxLength":240,"nullable":true,"description":"Explicação da linha"},"kind":{"type":"string","enum":["group","subtotal"],"description":"group recebe categorias; subtotal soma o que está acima"},"afterId":{"type":"string","format":"uuid","nullable":true,"description":"Linha depois da qual a nova entra; sem ela, vai para o fim"}},"required":["name","kind"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/dre-layout/lines/{id}":{"patch":{"summary":"Editar linha do DRE","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":240,"nullable":true},"isBase":{"type":"boolean","description":"Linha que vale 100% no percentual"},"defaultNature":{"type":"string","enum":["revenue","deduction","direct_cost","operating_expense"],"nullable":true,"description":"Categorias sem linha escolhida dessa natureza caem aqui"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Apagar linha do DRE","tags":["Financial"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/dre-layout/order":{"put":{"summary":"Reordenar linhas do DRE","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Todas as linhas, na nova ordem"}},"required":["ids"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/dre-layout/categories/{categoryId}":{"patch":{"summary":"Escolher a linha do DRE de uma categoria","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dreLineId":{"type":"string","format":"uuid","nullable":true,"description":"Linha de grupo. null volta para a linha padrão da natureza"}},"required":["dreLineId"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"categoryId","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/dre-layout/restore":{"post":{"summary":"Restaurar as linhas padrão do DRE","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/dre-template":{"get":{"summary":"Modelo de DRE para escritório de advocacia","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/dre-template/apply":{"post":{"summary":"Aplicar o modelo de DRE nas categorias","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/reports/cash-flow":{"get":{"summary":"Fluxo de caixa","tags":["Financial"],"description":"Caixa realizado (pela data de pagamento) e previsto (vencimentos em aberto) por carteira, no período from–to. Inclui tudo o que passa pelo banco, inclusive dinheiro de cliente e movimentação patrimonial.","parameters":[{"schema":{"type":"string"},"in":"query","name":"from","required":false,"description":"Início (AAAA-MM-DD). Envie junto com to; sem os dois, vai de hoje até 90 dias à frente"},{"schema":{"type":"string"},"in":"query","name":"to","required":false,"description":"Fim (AAAA-MM-DD), inclusive. Envie junto com from"}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/reports/cash-flow/statement":{"get":{"summary":"Demonstrativo do fluxo de caixa (DFC)","tags":["Financial"],"description":"DFC pelo método direto, mês a mês, no período from–to (até 36 meses). Regime de caixa: o pago conta na data da baixa e a baixa parcial na data de cada pagamento, a mesma regra do saldo das contas. Traz o saldo inicial, os grupos (`sections`: operacional, investimento, financiamento, ajustes e, com `billId`, transferências entre contas), cada um com entradas (`inflows`) e saídas (`outflows`, valores negativos) por categoria, a variação do caixa e o saldo final de cada mês (`periods`, `openingBalances`, `closingBalances`). Movimentação patrimonial entra pela espécie: investimento, financiamento e sócios, ajuste. Inclui repasse a terceiros e o que está fora do DRE. Com `forecast=true`, cada linha traz também o previsto (`forecast`) e o bloco `forecast` traz o saldo projetado. O previsto vai de hoje até o fim do período, pelo vencimento: lançamento em aberto já vencido não entra.","parameters":[{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"from","required":true,"description":"Início (AAAA-MM-DD). Um mês: 2026-06-01; um ano: 2026-01-01"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"to","required":true,"description":"Fim (AAAA-MM-DD), inclusive. Um mês: 2026-06-30; um ano: 2026-12-31. Até 36 meses"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"billId","required":false,"description":"Só uma conta. Sem ele, todas as contas que a pessoa pode ver e os lançamentos sem conta"},{"schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]},"in":"query","name":"forecast","required":false,"description":"true soma o previsto: o que está em aberto, pelo vencimento, de hoje até o fim do período (vencido em aberto não entra)"}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/reports/cash-flow/statement/entries":{"get":{"summary":"Lançamentos de uma linha do fluxo de caixa","tags":["Financial"],"description":"Os lançamentos que formam uma linha ou uma célula do demonstrativo do fluxo de caixa: envie o mesmo período, `section` e `lineKey` da linha. Até 500, do mais antigo ao mais recente; `total` diz quantos são e `realizedTotal`/`forecastTotal` somam todos, mesmo quando a lista vem cortada. O saldo inicial de conta aberta no período vem com `transactionId` nulo, porque não é um lançamento.","parameters":[{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"from","required":true,"description":"Início (AAAA-MM-DD). Um mês: 2026-06-01; um ano: 2026-01-01"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"to","required":true,"description":"Fim (AAAA-MM-DD), inclusive. Um mês: 2026-06-30; um ano: 2026-12-31. Até 36 meses"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"billId","required":false,"description":"Só uma conta. Sem ele, todas as contas que a pessoa pode ver e os lançamentos sem conta"},{"schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]},"in":"query","name":"forecast","required":false,"description":"true soma o previsto: o que está em aberto, pelo vencimento, de hoje até o fim do período (vencido em aberto não entra)"},{"schema":{"type":"string","enum":["operating","investing","financing","adjustments","transfers"]},"in":"query","name":"section","required":false,"description":"Grupo do demonstrativo"},{"schema":{"type":"string","maxLength":80},"in":"query","name":"lineKey","required":false,"description":"`key` da linha no demonstrativo (ex.: `<categoryId>:in`). Para uma célula, envie from e to do mês"}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/bills/{id}/statement":{"get":{"summary":"Extrato da carteira","tags":["Financial"],"parameters":[{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"from","required":false,"description":"Início (AAAA-MM-DD). Padrão: início do mês"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"to","required":false,"description":"Fim (AAAA-MM-DD). Padrão: fim do mês"},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"ID da conta"}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/import/preview":{"post":{"summary":"Prévia da importação de lançamentos (OFX, CSV ou Open Finance)","tags":["Financial"],"description":"Lê o extrato e devolve o que vai virar lançamento, sem gravar nada. No OFX, traz banco, período e saldo (`statement`) e, em cada linha, o tipo da operação, o documento e quem pagou ou recebeu. Cada linha vem com `status` (nova, já importada ou em mês fechado), `match` (lançamento já existente com o mesmo valor, que pode ser conciliado em vez de criar um novo, inclusive quando um único crédito paga mais de um lançamento) e `suggestion` (categoria e pessoa sugeridas pelo histórico do escritório e pelo nome no extrato). Perfil sem permissão de ver o saldo só recebe `match` de lançamentos que criou. CSV sem `mapping` recebe a sugestão de colunas pelo cabeçalho. Com `format: open_finance` e sem `content`, as linhas são as movimentações do Open Finance da carteira ainda não conferidas (chave `of:<id>`), com o mesmo `match` e `suggestion`. OFX ou CSV em carteira conectada ao Open Finance devolve 409. Depois, envie as linhas escolhidas para `POST /financial/transactions/import`. Exige permissão de editar o financeiro com JWT; aceita o header `x-juridiq-api-key`.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"billId":{"type":"string","format":"uuid","description":"Carteira que recebe os lançamentos"},"format":{"type":"string","enum":["ofx","csv","open_finance"],"description":"Formato do arquivo, ou `open_finance` para conferir as movimentações da conta conectada"},"content":{"type":"string","minLength":1,"maxLength":5000000,"description":"Conteúdo do arquivo em texto. Obrigatório em OFX e CSV"},"mapping":{"type":"object","properties":{"hasHeader":{"type":"boolean"},"date":{"type":"integer","minimum":0},"description":{"type":"integer","minimum":0},"dateFormat":{"type":"string","enum":["dd/mm/yyyy","yyyy-mm-dd","mm/dd/yyyy"]},"amount":{"type":"integer","minimum":0},"credit":{"type":"integer","minimum":0},"debit":{"type":"integer","minimum":0}},"required":["hasHeader","date","description"],"additionalProperties":false,"description":"Colunas do CSV. Sem ele, a API sugere pelo cabeçalho"}},"required":["billId","format"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string","enum":["ofx","csv","open_finance"]},"bill":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":true},"statement":{"type":"object","properties":{"bankName":{"type":"string","nullable":true},"startOn":{"type":"string","nullable":true,"description":"Início do período (YYYY-MM-DD)"},"endOn":{"type":"string","nullable":true,"description":"Fim do período (YYYY-MM-DD)"},"balance":{"type":"number","nullable":true,"description":"Saldo informado pelo banco"},"balanceOn":{"type":"string","nullable":true,"description":"Data do saldo (YYYY-MM-DD)"}},"required":["bankName","startOn","endOn","balance","balanceOn"],"additionalProperties":false,"nullable":true,"description":"Dados do extrato OFX: banco, período e saldo. Null no CSV"},"csv":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"string"}},"sample":{"type":"array","items":{"type":"array","items":{"type":"string"}}},"delimiter":{"type":"string"},"mapping":{"type":"object","properties":{"hasHeader":{"type":"boolean"},"date":{"type":"integer"},"description":{"type":"integer"},"dateFormat":{"type":"string","enum":["dd/mm/yyyy","yyyy-mm-dd","mm/dd/yyyy"]},"amount":{"type":"integer"},"credit":{"type":"integer"},"debit":{"type":"integer"}},"additionalProperties":false}},"required":["columns","sample","delimiter","mapping"],"additionalProperties":true,"nullable":true,"description":"Colunas e amostra do CSV, com o mapeamento usado ou sugerido. Null no OFX"},"needsMapping":{"type":"boolean","description":"CSV sem mapeamento completo: envie `mapping` e peça a prévia de novo"},"rows":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"date":{"type":"string","description":"YYYY-MM-DD"},"description":{"type":"string","description":"No OFX, o histórico do banco e o nome de quem pagou ou recebeu"},"amount":{"type":"number","description":"Positivo é entrada, negativo é saída"},"details":{"type":"string","description":"Tipo da operação e documento, quando o banco manda"},"counterpart":{"type":"string","description":"Quem pagou ou recebeu, como veio do banco"},"type":{"type":"string","enum":["incoming","outcoming"]},"status":{"type":"string","enum":["new","duplicate","closed"],"description":"new: nova; duplicate: já importada (só entra com `importAgain`); closed: mês fechado, não entra"},"match":{"type":"object","properties":{"transactionId":{"type":"string","description":"Lançamento a enviar em `reconcileWith`. Quando `count` > 1, é o conjunto: `group:<splitGroupId>` para as partes de um lançamento dividido por categoria, pendentes ou já pagas nesta conta"},"description":{"type":"string"},"date":{"type":"string","description":"Vencimento do lançamento (YYYY-MM-DD)"},"isPaid":{"type":"boolean","description":"Já está pago: conciliar só liga a linha; pendente recebe a baixa"},"personName":{"type":"string","nullable":true},"otherBillName":{"type":"string","nullable":true,"description":"Conta onde o lançamento está, quando não é a do extrato"},"reason":{"type":"string","description":"Por que a linha parece ser este lançamento"},"count":{"type":"integer","description":"Quantos lançamentos somados formam a linha (ex.: honorários + repasse)"}},"required":["transactionId","description","date","isPaid","personName","otherBillName","reason","count"],"additionalProperties":true,"nullable":true,"description":"Lançamento já existente que parece ser esta linha. Para conciliar, envie `reconcileWith`"},"suggestion":{"type":"object","properties":{"categoryId":{"type":"string","nullable":true,"description":"Categoria sugerida pelo histórico"},"personId":{"type":"string","nullable":true,"description":"Pessoa sugerida pelo histórico ou pelo nome no extrato"},"personName":{"type":"string","nullable":true},"reason":{"type":"string"}},"required":["categoryId","personId","personName","reason"],"additionalProperties":true,"nullable":true,"description":"Categoria e pessoa sugeridas"}},"required":["key","date","description","amount","type","status","match","suggestion"],"additionalProperties":true}},"errors":{"type":"array","items":{"type":"object","properties":{"line":{"type":"number"},"message":{"type":"string"}},"required":["line","message"],"additionalProperties":false},"description":"Primeiros 50 erros de leitura"},"errorCount":{"type":"integer"},"summary":{"type":"object","properties":{"total":{"type":"integer"},"new":{"type":"integer"},"duplicate":{"type":"integer"},"closed":{"type":"integer"},"matched":{"type":"integer","description":"Linhas com lançamento já existente"},"suggested":{"type":"integer","description":"Linhas com categoria ou pessoa sugerida"},"income":{"type":"number","description":"Soma das entradas novas"},"expense":{"type":"number","description":"Soma das saídas novas"}},"required":["total","new","duplicate","closed","matched","suggested","income","expense"],"additionalProperties":true}},"required":["format","bill","statement","csv","needsMapping","rows","errors","errorCount","summary"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/transactions/import":{"post":{"summary":"Importar lançamentos","tags":["Financial"],"description":"Grava as linhas escolhidas na prévia. Cada linha pode ter categoria, pessoa (`personId`), processo (`lawSuitId`), parceiro (`partnerId`, só o vínculo, sem comissão) e `excludeFromDre`. Com `parts`, a linha vira um lançamento por parte, cada uma com sua categoria e seus vínculos, ligados pelo mesmo `splitGroupId`; as partes somam o valor da linha. Com `reconcileWith` (o `match.transactionId` da prévia), a linha concilia o lançamento existente e dá baixa nele na data do extrato, em vez de criar outro. Um lançamento já dividido por categoria concilia inteiro com uma linha que tem a soma das partes, com o id do grupo ou de uma parte. Linhas já importadas são puladas, a não ser com `importAgain: true`; linhas em mês fechado são sempre puladas. Com `source: open_finance`, data e valor vêm da movimentação gravada (não do pedido) e cada linha concilia a movimentação do extrato; movimentação já conferida ou que saiu do banco devolve 409. Exige permissão de editar o financeiro com JWT; aceita o header `x-juridiq-api-key`.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"billId":{"type":"string","format":"uuid","description":"Carteira que recebe os lançamentos (a mesma da prévia)"},"source":{"type":"string","enum":["ofx","csv","open_finance"],"description":"Origem das linhas: o formato do arquivo ou `open_finance` (a mesma da prévia)"},"markAsPaid":{"type":"boolean","default":true,"description":"Cria os lançamentos já pagos, na data do extrato"},"incomeCategoryId":{"type":"string","format":"uuid","nullable":true,"description":"Categoria das entradas sem categoria própria"},"expenseCategoryId":{"type":"string","format":"uuid","nullable":true,"description":"Categoria das saídas sem categoria própria"},"rows":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":500,"description":"`key` da linha na prévia: evita importar a mesma linha duas vezes"},"date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data do extrato (YYYY-MM-DD)"},"description":{"type":"string","maxLength":500,"description":"Descrição do lançamento"},"amount":{"type":"number","description":"Valor com sinal: positivo é entrada, negativo é saída"},"categoryId":{"type":"string","format":"uuid","nullable":true,"description":"Categoria da linha"},"personId":{"type":"string","format":"uuid","nullable":true,"description":"Pessoa"},"lawSuitId":{"type":"string","format":"uuid","nullable":true,"description":"Processo"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"Parceiro, só o vínculo: não gera comissão"},"excludeFromDre":{"type":"boolean","description":"Fora do DRE"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"description":"Com categoria de dinheiro de cliente; sem ela, vale a que a categoria costuma ter"},"parts":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","description":"Valor da parte, sem sinal","exclusiveMinimum":0},"description":{"type":"string","maxLength":500,"description":"Sem ela, vale a da linha"},"categoryId":{"type":"string","format":"uuid","nullable":true},"personId":{"type":"string","format":"uuid","nullable":true,"description":"Pessoa"},"lawSuitId":{"type":"string","format":"uuid","nullable":true,"description":"Processo"},"partnerId":{"type":"string","format":"uuid","nullable":true,"description":"Parceiro, só o vínculo: não gera comissão"},"excludeFromDre":{"type":"boolean","description":"Fora do DRE"},"thirdPartyKind":{"type":"string","enum":["court_cost","judicial_deposit","client_repass"],"description":"Com categoria de dinheiro de cliente; sem ela, vale a que a categoria costuma ter"}},"required":["amount"],"additionalProperties":false},"minItems":2,"maxItems":50,"description":"Divide a linha em vários lançamentos. As partes somam o valor da linha."},"importAgain":{"type":"boolean","description":"Importa de novo uma linha que já entrou antes (sem isso, ela é pulada)"},"reconcileWith":{"type":"string","maxLength":200,"description":"Lançamento já existente que é esta linha: concilia (e dá baixa, se pendente) em vez de criar. Para um lançamento dividido por categoria, vale o `match.transactionId` da prévia (`group:<splitGroupId>`) ou o id de qualquer parte: quando a soma das partes é o valor da linha, todas são conciliadas"}},"required":["key","date","description","amount"],"additionalProperties":false},"minItems":1,"maxItems":2000,"description":"Linhas escolhidas da prévia"}},"required":["billId","source","rows"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"created":{"type":"integer","description":"Lançamentos criados (cada parte de uma linha dividida conta um)"},"reconciled":{"type":"integer","description":"Linhas conciliadas com lançamentos existentes"},"skippedDuplicates":{"type":"integer","description":"Linhas já importadas, puladas"},"skippedClosed":{"type":"integer","description":"Linhas em mês fechado, puladas"}},"required":["created","reconciled","skippedDuplicates","skippedClosed"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/reports/accountant-export":{"post":{"summary":"CSV do contador","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"year":{"type":"integer","description":"Ano com 4 dígitos, ex.: 2026"},"month":{"type":"integer","minimum":1,"maximum":12,"description":"Mês de 1 a 12"}},"required":["year","month"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/aging":{"get":{"summary":"Aging de receber e pagar","tags":["Financial"],"parameters":[{"schema":{"type":"string","enum":["receivable","payable"]},"in":"query","name":"side","required":true,"description":"receivable (a receber) ou payable (a pagar)"}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/cost-centers":{"get":{"summary":"Listar centros de custo","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Criar centro de custo","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome do centro de custo"},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Centro pai"},"active":{"type":"boolean","description":"false desativa"}},"required":["name"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/cost-centers/{id}":{"patch":{"summary":"Atualizar centro de custo","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome do centro de custo"},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Centro pai"},"active":{"type":"boolean","description":"false desativa"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Apagar centro de custo","tags":["Financial"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/fee-agreements":{"get":{"summary":"Listar contratos de honorários","tags":["Financial"],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Criar contrato de honorários","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string","format":"uuid","description":"Cliente do contrato"},"categoryId":{"type":"string","format":"uuid","description":"Categoria de receita dos lançamentos"},"lawSuitId":{"type":"string","format":"uuid","nullable":true,"description":"Processo do contrato"},"billId":{"type":"string","format":"uuid","nullable":true,"description":"Carteira onde os lançamentos entram"},"kind":{"type":"string","enum":["entry","installment","monthly","success","hourly"],"description":"entry (entrada única), installment (parcelado), monthly (mensal), success (êxito) ou hourly (por hora)"},"amount":{"type":"number","nullable":true,"description":"Valor; obrigatório em entry, installment e monthly"},"hourlyRate":{"type":"number","nullable":true,"description":"Valor da hora; obrigatório em hourly"},"installmentCount":{"type":"integer","nullable":true,"description":"Número de parcelas (2 ou mais) em installment"},"frequency":{"type":"string","nullable":true,"description":"Em installment e monthly: daily, weekly, biweekly, monthly, bimonthly, quarterly, semiannual ou annually"},"startDate":{"type":"string","nullable":true,"description":"Início (AAAA-MM-DD); obrigatório em installment e monthly"},"endDate":{"type":"string","nullable":true,"description":"Fim (AAAA-MM-DD)"},"dueDate":{"type":"string","nullable":true,"description":"Vencimento (AAAA-MM-DD)"},"competenceDate":{"type":"string","nullable":true,"description":"Mês do resultado (AAAA-MM-DD)"},"description":{"type":"string","nullable":true,"description":"Descrição"}},"required":["personId","categoryId","kind"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/fee-agreements/{id}/cancel":{"post":{"summary":"Cancelar contrato de honorários","tags":["Financial"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/fee-agreements/{id}/recognize-success":{"post":{"summary":"Reconhecer honorário de êxito","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"number","description":"Valor do honorário de êxito","exclusiveMinimum":0},"competenceDate":{"type":"string","description":"Mês do resultado (AAAA-MM-DD)"},"dueDate":{"type":"string","description":"Vencimento (AAAA-MM-DD)"}},"required":["value"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/fee-agreements/{id}/bill-timesheets":{"post":{"summary":"Faturar horas","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"timeSheetIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Apontamentos de horas a faturar"}},"required":["timeSheetIds"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/invoices/{invoiceId}/tax-suggestion":{"get":{"summary":"Sugerir impostos da nota","tags":["Financial"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"invoiceId","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/financial/invoices/{invoiceId}/tax-deduction":{"post":{"summary":"Confirmar dedução de impostos","tags":["Financial"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"categoryId":{"type":"string","format":"uuid"}},"additionalProperties":false,"default":{}}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"invoiceId","required":true}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/consulting/":{"get":{"summary":"Listar atendimentos","tags":["Consulting"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Limite por página"},{"schema":{"type":"string"},"in":"query","name":"subject","required":false,"description":"Assunto"},{"schema":{"type":"string"},"in":"query","name":"clientId","required":false,"description":"ID da pessoa"},{"schema":{"type":"boolean"},"in":"query","name":"isPrivate","required":false,"description":"Atendimento privado"},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"isArchived","required":false,"description":"Arquivado"},{"schema":{"type":"string"},"in":"query","name":"processNumber","required":false,"description":"Número do processo"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"consultingColumnId","required":false,"description":"ID da coluna"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"tagIds","required":false,"description":"IDs de etiquetas"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"responsibleIds","required":false,"description":"IDs dos responsáveis (repetido ou separado por vírgula)"}],"security":[{"apiKeyAuth":[]}],"responses":{"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar atendimento","tags":["Consulting"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"officeId":{"type":"string","description":"Ignorado: o escritório vem da credencial (JWT ou API key)"},"personId":{"type":"string","description":"ID da pessoa"},"subject":{"type":"string","description":"Assunto"},"registers":{"type":"array","items":{"type":"object","properties":{"content":{"type":"string","description":"Texto do registro"}},"required":["content"],"additionalProperties":false},"description":"Registros iniciais"},"lawSuitId":{"type":"string","description":"ID do processo"},"isPrivate":{"type":"boolean","default":false,"description":"Atendimento privado"},"consultingColumnId":{"type":"string","format":"uuid","description":"ID da coluna do funil"},"taskIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs de tarefas já existentes"},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs de etiquetas"},"responsibleIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos responsáveis"},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","description":"ID do campo personalizado"},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"array","items":{"type":"string","maxLength":100},"maxItems":500}],"nullable":true,"description":"Valor do campo — null limpa o valor gravado"}},"required":["fieldId","value"],"additionalProperties":false},"maxItems":100,"description":"Campos personalizados"}},"required":["personId","subject","registers"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do atendimento criado"}},"required":["id"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir atendimento","tags":["Consulting"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do atendimento"}},"required":["id"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/consulting/{id}":{"get":{"summary":"Buscar atendimento","tags":["Consulting"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do atendimento"}],"security":[{"apiKeyAuth":[]}],"responses":{"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"patch":{"summary":"Atualizar atendimento","tags":["Consulting"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"description":"ID da pessoa"},"subject":{"description":"Assunto"},"registers":{"description":"Registros novos [{ content }]"},"lawSuitId":{"description":"ID do processo; null desvincula"},"currentIndex":{"description":"Posição na coluna"},"isPrivate":{"description":"Atendimento privado"},"isArchived":{"description":"Arquivado"},"isSameColumnReorder":{"description":"Reordenação na mesma coluna"},"consultingColumnId":{"description":"ID da coluna de destino"},"taskIds":{"description":"IDs de tarefas (substitui o conjunto)"},"tags":{"description":"IDs de etiquetas (substitui o conjunto)"},"responsibleIds":{"description":"IDs dos responsáveis"},"customFields":{"description":"Campos personalizados"}},"additionalProperties":true}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do atendimento"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/consulting/register":{"post":{"summary":"Criar registro no histórico do atendimento","tags":["Consulting"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"consultingId":{"type":"string","description":"ID do atendimento"},"content":{"type":"string","description":"Texto do registro"}},"required":["consultingId","content"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"consultingId":{"type":"string"},"content":{"description":"Conteúdo gravado do registro"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]}},"required":["id"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir registro do atendimento","tags":["Consulting"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do registro"}},"required":["id"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluído","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluído"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/consulting/register/{id}":{"patch":{"summary":"Atualizar registro do atendimento","tags":["Consulting"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","description":"Texto do registro"}},"required":["content"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do registro"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"consultingId":{"type":"string"},"content":{"description":"Conteúdo gravado do registro"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]}},"required":["id"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/consulting-columns/":{"get":{"summary":"Listar colunas de atendimento","tags":["Consulting Columns"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Nome da coluna"},{"schema":{"type":"string"},"in":"query","name":"subject","required":false,"description":"Assunto do atendimento"},{"schema":{"type":"string"},"in":"query","name":"clientId","required":false,"description":"ID da pessoa"},{"schema":{"type":"string"},"in":"query","name":"lawSuitId","required":false,"description":"ID do processo"},{"schema":{"type":"boolean"},"in":"query","name":"isPrivate","required":false,"description":"Atendimento privado"},{"schema":{"type":"string"},"in":"query","name":"processNumber","required":false,"description":"Número do processo"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"consultingColumnId","required":false,"description":"ID da coluna"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"funnelId","required":false,"description":"ID do funil"},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"isArchived","required":false,"description":"Arquivado"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"tagIds","required":false,"description":"IDs de etiquetas"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"responsibleIds","required":false,"description":"IDs dos responsáveis (repetido ou separado por vírgula)"},{"schema":{"type":"string"},"in":"query","name":"isSettings","required":false,"description":"true para listagem de colunas sem cards"},{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"lastMovementFrom","required":false,"description":"Última movimentação a partir de (yyyy-MM-dd, horário de Brasília)"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"lastMovementTo","required":false,"description":"Última movimentação até (yyyy-MM-dd, horário de Brasília)"}],"security":[{"apiKeyAuth":[]}],"responses":{"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar coluna de atendimento","tags":["Consulting Columns"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome da coluna"},"index":{"type":"integer","minimum":0,"description":"Posição da coluna"},"funnelId":{"type":"string","format":"uuid","description":"ID do funil (usa o funil padrão do escritório se omitido)"},"color":{"type":"string","description":"Cor da coluna"},"timeLimitDays":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Prazo em dias"},"showBadgeProgress":{"type":"boolean","description":"Exibe badge de progresso"},"kind":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"],"description":"Etapa da coluna; COMPLETED conclui o atendimento que entra nela"}},"required":["name"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da coluna"},"name":{"type":"string","nullable":true,"description":"Nome da coluna"},"color":{"type":"string","nullable":true,"description":"Cor da coluna"},"index":{"type":"number","nullable":true,"description":"Posição da coluna"},"timeLimitDays":{"type":"number","description":"Prazo em dias"},"showBadgeProgress":{"type":"boolean","description":"Exibe badge de progresso"},"kind":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"],"description":"Etapa da coluna"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"funnelId":{"type":"string","format":"uuid","nullable":true,"description":"ID do funil"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"}},"required":["id","name","index","timeLimitDays","showBadgeProgress","kind","officeId","funnelId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/consulting-columns/{id}":{"get":{"summary":"Buscar coluna de atendimento","tags":["Consulting Columns"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da coluna"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"consulting":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":true}}},"required":["id"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar coluna de atendimento","tags":["Consulting Columns"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome da coluna"},"index":{"type":"integer","minimum":0,"description":"Posição da coluna"},"timeLimitDays":{"type":"integer","minimum":0,"maximum":2147483647,"description":"Prazo em dias"},"showBadgeProgress":{"type":"boolean","description":"Exibe badge de progresso"},"funnelId":{"type":"string","format":"uuid","description":"ID do funil de destino"},"color":{"type":"string","description":"Cor da coluna"},"kind":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"],"description":"Etapa da coluna; COMPLETED conclui o atendimento que entra nela"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da coluna"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da coluna"},"name":{"type":"string","nullable":true,"description":"Nome da coluna"},"color":{"type":"string","nullable":true,"description":"Cor da coluna"},"index":{"type":"number","nullable":true,"description":"Posição da coluna"},"timeLimitDays":{"type":"number","description":"Prazo em dias"},"showBadgeProgress":{"type":"boolean","description":"Exibe badge de progresso"},"kind":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"],"description":"Etapa da coluna"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"funnelId":{"type":"string","format":"uuid","nullable":true,"description":"ID do funil"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"}},"required":["id","name","index","timeLimitDays","showBadgeProgress","kind","officeId","funnelId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir coluna de atendimento","tags":["Consulting Columns"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da coluna"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"ok quando excluída","content":{"application/json":{"schema":{"type":"string","description":"ok quando excluída"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/funnels/":{"get":{"summary":"Listar funis de atendimento","tags":["Consulting Funnels"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"name","required":false,"description":"Filtra por nome"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"clientId","required":false,"description":"Filtra só funis com atendimento vinculado a esta pessoa"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"lawSuitId","required":false,"description":"Filtra só funis com atendimento vinculado a este processo"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do funil"},"name":{"type":"string","description":"Nome do funil"},"index":{"type":"number","nullable":true,"description":"Posição do funil"},"isDefault":{"type":"boolean","description":"Indica se é o funil padrão"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"columns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da coluna"},"name":{"type":"string","nullable":true,"description":"Nome da coluna"},"color":{"type":"string","nullable":true,"description":"Cor da coluna"},"index":{"type":"number","nullable":true,"description":"Posição da coluna"},"timeLimitDays":{"type":"number","description":"Prazo em dias"},"showBadgeProgress":{"type":"boolean","description":"Exibe badge de progresso"},"kind":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"],"description":"Tipo da coluna"},"totalConsultings":{"type":"number","description":"Total de atendimentos na coluna"}},"required":["id","name","index","timeLimitDays","showBadgeProgress","totalConsultings"],"additionalProperties":false},"description":"Colunas do funil"},"totalConsultings":{"type":"number","description":"Total de atendimentos no funil"}},"required":["id","name","index","isDefault","officeId","createdAt","updatedAt","columns","totalConsultings"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar funil de atendimento","tags":["Consulting Funnels"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome do funil"},"columns":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome da coluna"},"index":{"type":"number","description":"Posição da coluna"},"color":{"type":"string","description":"Cor da coluna"},"timeLimitDays":{"type":"number","description":"Prazo em dias"},"showBadgeProgress":{"type":"boolean","description":"Exibe badge de progresso"},"kind":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"],"description":"Tipo da coluna (padrão: Em progresso)"}},"required":["name"],"additionalProperties":false},"description":"Colunas iniciais. Se omitido, usa as colunas padrão"}},"required":["name"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do funil"},"name":{"type":"string","description":"Nome do funil"},"index":{"type":"number","nullable":true,"description":"Posição do funil"},"isDefault":{"type":"boolean","description":"Indica se é o funil padrão"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"consultingColumns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da coluna"},"name":{"type":"string","nullable":true,"description":"Nome da coluna"},"color":{"type":"string","nullable":true,"description":"Cor da coluna"},"index":{"type":"number","nullable":true,"description":"Posição da coluna"},"timeLimitDays":{"type":"number","description":"Prazo em dias"},"showBadgeProgress":{"type":"boolean","description":"Exibe badge de progresso"},"kind":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"],"description":"Tipo da coluna"}},"required":["id","name","index","timeLimitDays","showBadgeProgress"],"additionalProperties":false},"description":"Colunas do funil"}},"required":["id","name","index","isDefault","officeId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/funnels/{id}":{"get":{"summary":"Buscar funil de atendimento","tags":["Consulting Funnels"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do funil"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do funil"},"name":{"type":"string","description":"Nome do funil"},"index":{"type":"number","nullable":true,"description":"Posição do funil"},"isDefault":{"type":"boolean","description":"Indica se é o funil padrão"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"columns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da coluna"},"name":{"type":"string","nullable":true,"description":"Nome da coluna"},"color":{"type":"string","nullable":true,"description":"Cor da coluna"},"index":{"type":"number","nullable":true,"description":"Posição da coluna"},"timeLimitDays":{"type":"number","description":"Prazo em dias"},"showBadgeProgress":{"type":"boolean","description":"Exibe badge de progresso"},"kind":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"],"description":"Tipo da coluna"},"totalConsultings":{"type":"number","description":"Total de atendimentos na coluna"}},"required":["id","name","index","timeLimitDays","showBadgeProgress","totalConsultings"],"additionalProperties":false},"description":"Colunas do funil"}},"required":["id","name","index","isDefault","officeId","createdAt","updatedAt","columns"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar funil de atendimento","tags":["Consulting Funnels"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome do funil"},"index":{"type":"number","description":"Posição do funil"},"isDefault":{"type":"boolean","description":"Define este funil como padrão do escritório"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do funil"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do funil"},"name":{"type":"string","description":"Nome do funil"},"index":{"type":"number","nullable":true,"description":"Posição do funil"},"isDefault":{"type":"boolean","description":"Indica se é o funil padrão"},"officeId":{"type":"string","format":"uuid","description":"ID do escritório"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Criado em"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Atualizado em"},"consultingColumns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da coluna"},"name":{"type":"string","nullable":true,"description":"Nome da coluna"},"color":{"type":"string","nullable":true,"description":"Cor da coluna"},"index":{"type":"number","nullable":true,"description":"Posição da coluna"},"timeLimitDays":{"type":"number","description":"Prazo em dias"},"showBadgeProgress":{"type":"boolean","description":"Exibe badge de progresso"},"kind":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"],"description":"Tipo da coluna"}},"required":["id","name","index","timeLimitDays","showBadgeProgress"],"additionalProperties":false},"description":"Colunas do funil"}},"required":["id","name","index","isDefault","officeId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir funil de atendimento","tags":["Consulting Funnels"],"description":"Não permite excluir o funil padrão nem funis com atendimentos","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do funil"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string","enum":["ok"]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/audience/":{"get":{"summary":"Listar audiências","tags":["Audiences"],"description":"Lista as audiências do escritório autenticado. Com `page` (começa em 1) e `limit`, pagina; sem `limit`, devolve todas. Por padrão, audiência privada só vem para quem a criou ou participa dela; com `isMetrics=true`, Gestor e Suporte recebem também as dos outros. `date` (AAAA-MM-DD, ou ISO com horário: vale o dia escrito, sem converter fuso) vale como `start` e `end` quando eles não vêm; `start` e `end` são inclusivos. `type` filtra pela modalidade (online, presencial, hibrida (minúsculas, sem acento)). `lawSuit` é o ID do processo e `responsibles`, IDs de usuários separados por vírgula. Ordem padrão: `date` decrescente; `orderByField` fora de date, createdAt e updatedAt: 400. Aceita JWT ou o header `x-juridiq-api-key`. Sem filtro de processo ou pessoa, vale o compartilhamento de agenda de quem consulta (a chave de API consulta como o dono dela): audiência de colega que não compartilha não vem; a de quem compartilha só livre/ocupado vem com título \"Ocupado\" e `busy: true`, com o conteúdo vazio (sem pessoas, processo, link, descrição e modalidade) (com `title`, ela não vem: o título casado revelaria o conteúdo). Gestor e Suporte não passam pelo compartilhamento.","parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"title","required":false,"description":"Filtra por título"},{"schema":{"type":"string","enum":["online","presencial","hibrida"]},"in":"query","name":"type","required":false,"description":"Filtra por modalidade: online, presencial, hibrida (minúsculas, sem acento)"},{"schema":{"type":"string"},"in":"query","name":"responsibles","required":false,"description":"Filtra por participantes: IDs de usuários separados por vírgula"},{"schema":{"type":"string"},"in":"query","name":"isMetrics","required":false,"description":"true para métricas: Gestor e Suporte recebem também as audiências privadas de outros; os demais, só as próprias e as de que participam"},{"schema":{"type":"string"},"in":"query","name":"date","required":false,"description":"Filtra um dia (AAAA-MM-DD; com horário ISO, vale o dia escrito): vale como start e end quando eles não vêm"},{"schema":{"type":"string"},"in":"query","name":"lawSuit","required":false,"description":"Filtra pelo ID do processo"},{"schema":{"type":"string"},"in":"query","name":"personId","required":false,"description":"Filtra por pessoa"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc"},{"schema":{"type":"string"},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação. date (ocorrência), createdAt, updatedAt"},{"schema":{"type":"string"},"in":"query","name":"start","required":false,"description":"Data inicial (AAAA-MM-DD), inclusiva"},{"schema":{"type":"string"},"in":"query","name":"end","required":false,"description":"Data final (AAAA-MM-DD), inclusiva"},{"schema":{"type":"string","enum":["all","completed","pending"],"default":"all"},"in":"query","name":"statusFilter","required":false,"description":"all = todas, completed = concluídas, pending = não concluídas"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da audiência"},"title":{"type":"string","description":"Título"},"date":{"type":"string","description":"Data"},"initialHour":{"type":"string","nullable":true,"description":"Hora inicial"},"finalHour":{"type":"string","nullable":true,"description":"Hora final"},"modality":{"type":"string","nullable":true,"description":"Modalidade: online, presencial, hibrida (minúsculas, sem acento); audiência antiga pode vir null"},"type":{"type":"string","nullable":true,"description":"Modalidade: online, presencial, hibrida (minúsculas, sem acento); audiência antiga pode vir null"},"audienceLink":{"type":"string","nullable":true,"description":"Link da audiência"},"description":{"type":"string","nullable":true,"description":"Descrição"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"personIds":{"type":"array","items":{"type":"string"},"description":"IDs das pessoas"},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false},"description":"Pessoas vinculadas"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa (fallback)"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Primeira pessoa vinculada (compatibilidade com listagens)"},"completedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data de conclusão"},"points":{"type":"number","nullable":true,"description":"Pontos"},"isPrivate":{"type":"boolean","nullable":true,"description":"Audiência privada"},"hasSheet":{"type":"boolean","description":"Possui apontamento (TimeSheet)"},"location":{"type":"string","nullable":true,"description":"Local"},"participants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do participante"},"name":{"type":"string","description":"Nome"},"email":{"type":"string","nullable":true,"description":"E-mail"}},"required":["id","name"],"additionalProperties":false},"description":"Participantes"},"ownerId":{"type":"string","nullable":true,"description":"ID do responsável"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"},"busy":{"type":"boolean","description":"Audiência de colega que só compartilha livre/ocupado: título \"Ocupado\", com o conteúdo vazio (sem pessoas, processo, link, descrição e modalidade)"}},"required":["id","title","date"],"additionalProperties":true},"description":"Lista de audiências"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar audiência","tags":["Audiences"],"description":"Cria uma audiência no escritório autenticado. `date` vai em AAAA-MM-DD e `initialHour`/`finalHour` em HH:mm. `type` é a modalidade: online, presencial, hibrida (minúsculas, sem acento); `audienceLink` e `location` são gravados como vierem, em qualquer modalidade. `audienceParticipants` são IDs de usuários do escritório (outro usuário: 400) e `personIds`, de pessoas do escritório (outra pessoa: 404). `lawSuitId` e `publicationMovementId` também precisam ser do escritório (senão 404). Aceita JWT ou o header `x-juridiq-api-key`. Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os participantes compartilham \"Ver e editar\", e só entra participante que compartilha \"Ver e editar\" (403 com o nome). Com chave de API a regra não vale.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"Título"},"date":{"type":"string","description":"Data (AAAA-MM-DD)"},"initialHour":{"type":"string","description":"Hora inicial (HH:mm)"},"finalHour":{"type":"string","description":"Hora final (HH:mm)"},"type":{"type":"string","enum":["online","presencial","hibrida"],"description":"Modalidade: online, presencial, hibrida (minúsculas, sem acento)"},"audienceParticipants":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos participantes"},"description":{"type":"string","description":"Descrição"},"lawSuitId":{"type":"string","format":"uuid","description":"ID do processo. Processo de outro escritório ou inexistente: 404"},"publicationMovementId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID da movimentação de publicação (o `id` de GET /publication) que originou a audiência. Gravado como publicação de origem; movimentação de outro escritório ou inexistente: 404"},"personIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das pessoas"},"personId":{"type":"string","format":"uuid","description":"ID da pessoa (fallback de leitura/escrita)"},"audienceLink":{"type":"string","description":"Link da audiência"},"isPrivate":{"type":"boolean","description":"Audiência privada"},"remindClient":{"type":"boolean","description":"Enviar lembrete da audiência ao cliente via WhatsApp (Jurichat)"},"location":{"type":"string","description":"Local"},"createSheet":{"type":"boolean","description":"Cria o apontamento (TimeSheet) da audiência ao criá-la"},"points":{"type":"integer","minimum":0,"description":"Pontos"}},"required":["title","date","initialHour","finalHour","type","audienceParticipants"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da audiência"},"title":{"type":"string","description":"Título"},"date":{"type":"string","description":"Data"},"initialHour":{"type":"string","nullable":true,"description":"Hora inicial"},"finalHour":{"type":"string","nullable":true,"description":"Hora final"},"modality":{"type":"string","nullable":true,"description":"Modalidade: online, presencial, hibrida (minúsculas, sem acento); audiência antiga pode vir null"},"type":{"type":"string","nullable":true,"description":"Modalidade: online, presencial, hibrida (minúsculas, sem acento); audiência antiga pode vir null"},"audienceLink":{"type":"string","nullable":true,"description":"Link da audiência"},"description":{"type":"string","nullable":true,"description":"Descrição"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"personIds":{"type":"array","items":{"type":"string"},"description":"IDs das pessoas"},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false},"description":"Pessoas vinculadas"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa (fallback)"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Primeira pessoa vinculada (compatibilidade com listagens)"},"completedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data de conclusão"},"points":{"type":"number","nullable":true,"description":"Pontos"},"isPrivate":{"type":"boolean","nullable":true,"description":"Audiência privada"},"hasSheet":{"type":"boolean","description":"Possui apontamento (TimeSheet)"},"location":{"type":"string","nullable":true,"description":"Local"},"participants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do participante"},"name":{"type":"string","description":"Nome"},"email":{"type":"string","nullable":true,"description":"E-mail"}},"required":["id","name"],"additionalProperties":false},"description":"Participantes"},"ownerId":{"type":"string","nullable":true,"description":"ID do responsável"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"}},"required":["id","title","date"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir audiências em lote","tags":["Audiences"],"description":"Recusa o lote inteiro (403) se alguma audiência não puder ser apagada. Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os participantes compartilham \"Ver e editar\" (403 com o nome). Com chave de API a regra não vale.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs das audiências"}},"required":["ids"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"204":{"description":"Sem conteúdo","content":{"application/json":{"schema":{"enum":["null"],"nullable":true,"description":"Sem conteúdo"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/audience/{id}":{"get":{"summary":"Buscar audiência","tags":["Audiences"],"description":"Audiência confidencial só para dono, participantes e Gestor/Suporte (403). Audiência sem processo nem pessoa da agenda de colega que não compartilha os detalhes responde 404.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da audiência"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da audiência"},"title":{"type":"string","description":"Título"},"date":{"type":"string","description":"Data"},"initialHour":{"type":"string","nullable":true,"description":"Hora inicial"},"finalHour":{"type":"string","nullable":true,"description":"Hora final"},"modality":{"type":"string","nullable":true,"description":"Modalidade: online, presencial, hibrida (minúsculas, sem acento); audiência antiga pode vir null"},"type":{"type":"string","nullable":true,"description":"Modalidade: online, presencial, hibrida (minúsculas, sem acento); audiência antiga pode vir null"},"audienceLink":{"type":"string","nullable":true,"description":"Link da audiência"},"description":{"type":"string","nullable":true,"description":"Descrição"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"personIds":{"type":"array","items":{"type":"string"},"description":"IDs das pessoas"},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false},"description":"Pessoas vinculadas"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa (fallback)"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Primeira pessoa vinculada (compatibilidade com listagens)"},"completedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data de conclusão"},"points":{"type":"number","nullable":true,"description":"Pontos"},"isPrivate":{"type":"boolean","nullable":true,"description":"Audiência privada"},"hasSheet":{"type":"boolean","description":"Possui apontamento (TimeSheet)"},"location":{"type":"string","nullable":true,"description":"Local"},"participants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do participante"},"name":{"type":"string","description":"Nome"},"email":{"type":"string","nullable":true,"description":"E-mail"}},"required":["id","name"],"additionalProperties":false},"description":"Participantes"},"ownerId":{"type":"string","nullable":true,"description":"ID do responsável"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"}},"required":["id","title","date"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar audiência","tags":["Audiences"],"description":"Atualiza uma audiência do escritório autenticado; campo ausente no body fica como está. `date` vai em AAAA-MM-DD e `initialHour`/`finalHour` em HH:mm. `type` é a modalidade: online, presencial, hibrida (minúsculas, sem acento). `audienceParticipants` com itens substitui a lista de participantes (mande também os que ficam; outro usuário: 400); lista vazia é ignorada. `personIds` substitui a lista de pessoas; `[]` remove todas. `description` vazia é ignorada. Audiência, pessoa (`personIds`) ou processo (`lawSuitId`/`process`) de outro escritório: 404. Aceita JWT ou o header `x-juridiq-api-key`. Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os participantes compartilham \"Ver e editar\", e só entra participante que compartilha \"Ver e editar\" (403 com o nome). Com chave de API a regra não vale.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["online","presencial","hibrida"],"description":"Modalidade: online, presencial, hibrida (minúsculas, sem acento)"},"title":{"type":"string","description":"Título"},"date":{"type":"string","description":"Data (AAAA-MM-DD)"},"initialHour":{"type":"string","description":"Hora inicial (HH:mm)"},"finalHour":{"type":"string","description":"Hora final (HH:mm)"},"audienceParticipants":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos participantes"},"description":{"type":"string","description":"Descrição"},"process":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"Nome antigo de `lawSuitId`; com os dois juntos vale `lawSuitId`. `null` desvincula. Processo de outro escritório ou inexistente: 404"},"lawSuitId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID do processo; `null` desvincula e, com `process` junto, vale este. Processo de outro escritório ou inexistente: 404"},"personIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs das pessoas"},"personId":{"anyOf":[{"type":"string","format":"uuid"},{"enum":["null"],"nullable":true}],"description":"ID da pessoa (fallback de leitura/escrita)"},"audienceLink":{"type":"string","description":"Link da audiência"},"isPrivate":{"type":"boolean","description":"Audiência privada"},"remindClient":{"type":"boolean","description":"Enviar lembrete da audiência ao cliente via WhatsApp (Jurichat)"},"location":{"type":"string","description":"Local"},"completedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data de conclusão"},"points":{"type":"integer","minimum":0,"description":"Pontos"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da audiência"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da audiência"},"title":{"type":"string","description":"Título"},"date":{"type":"string","description":"Data"},"initialHour":{"type":"string","nullable":true,"description":"Hora inicial"},"finalHour":{"type":"string","nullable":true,"description":"Hora final"},"modality":{"type":"string","nullable":true,"description":"Modalidade: online, presencial, hibrida (minúsculas, sem acento); audiência antiga pode vir null"},"type":{"type":"string","nullable":true,"description":"Modalidade: online, presencial, hibrida (minúsculas, sem acento); audiência antiga pode vir null"},"audienceLink":{"type":"string","nullable":true,"description":"Link da audiência"},"description":{"type":"string","nullable":true,"description":"Descrição"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"personIds":{"type":"array","items":{"type":"string"},"description":"IDs das pessoas"},"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false},"description":"Pessoas vinculadas"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa (fallback)"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Primeira pessoa vinculada (compatibilidade com listagens)"},"completedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data de conclusão"},"points":{"type":"number","nullable":true,"description":"Pontos"},"isPrivate":{"type":"boolean","nullable":true,"description":"Audiência privada"},"hasSheet":{"type":"boolean","description":"Possui apontamento (TimeSheet)"},"location":{"type":"string","nullable":true,"description":"Local"},"participants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do participante"},"name":{"type":"string","description":"Nome"},"email":{"type":"string","nullable":true,"description":"E-mail"}},"required":["id","name"],"additionalProperties":false},"description":"Participantes"},"ownerId":{"type":"string","nullable":true,"description":"ID do responsável"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"}},"required":["id","title","date"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir audiência","tags":["Audiences"],"description":"Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os participantes compartilham \"Ver e editar\" (403 com o nome). Com chave de API a regra não vale.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da audiência"}],"security":[{"apiKeyAuth":[]}],"responses":{"204":{"description":"Sem conteúdo","content":{"application/json":{"schema":{"enum":["null"],"nullable":true,"description":"Sem conteúdo"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/docs/templates":{"get":{"summary":"Listar modelos de peça jurídica","tags":["Documents"],"description":"Lista os modelos de peça jurídica do escritório (o módulo de Peças Jurídicas), sem o conteúdo. Use o `id` em GET /docs/templates/{id} para ver os campos e em POST /docs/from-template para criar a peça.\n\n**Ordem e paginação:** por nome e, no empate, por `id`. `page` começa em 1 e `limit` vai até 100; use `totalPages` para saber quando parar.\n\n**Permissão:** com JWT, qualquer usuário do escritório; com chave, \"JuridiqDocs - Documentos com IA › Visualizar\". Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403.\n\n**Erros:** 403 quando a chave é do Claude e o plano do escritório não inclui o MCP, ou quando o acesso do escritório está bloqueado.","parameters":[{"schema":{"type":"integer","default":1,"exclusiveMinimum":0},"in":"query","name":"page","required":false,"description":"Página, começa em 1"},{"schema":{"type":"integer","maximum":100,"default":20,"exclusiveMinimum":0},"in":"query","name":"limit","required":false,"description":"Itens por página, de 1 a 100 (padrão 20)"},{"schema":{"type":"string","maxLength":255},"in":"query","name":"search","required":false,"description":"Busca no nome do modelo, sem diferenciar acento nem maiúscula; em branco lista todos"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do modelo (templateId na criação da peça)"},"name":{"type":"string","description":"Nome do modelo"},"tags":{"type":"array","items":{"type":"string"},"description":"Nomes das etiquetas do modelo"},"updatedAt":{"type":"string","format":"date-time","description":"Última alteração do modelo (UTC)"}},"required":["id","name","tags","updatedAt"],"additionalProperties":false},"description":"Modelos da página"},"totalResults":{"type":"number","description":"Total de modelos com a busca"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/docs/templates/{id}":{"get":{"summary":"Campos de um modelo de peça jurídica","tags":["Documents"],"description":"Devolve os campos `{{MÓDULO.coluna}}` do modelo, um por marcador, na ordem em que aparecem. Na criação da peça:\n- PERSON da pessoa 1 (`PERSON.name` ou `PERSON.name.1`) sai do cliente de `personId`, com os dados de GET /person/{id};\n- LAW_SUIT sai do processo de `lawSuitId`, com os dados de GET /lawSuit/{id} (ex.: valor da causa em R$);\n- GENERAL.date e GENERAL.time saem de agora, no horário de Brasília;\n- o resto (PERSONALIZED, pessoa 2 em diante, GENERAL.cityState) só por `values`.\n\nMarcador partido entre trechos de formatação diferente e campo antigo do editor não aparecem na lista; o editor os mostra como campo ao abrir a peça.\n\n**Permissão:** com JWT, qualquer usuário do escritório; com chave, \"JuridiqDocs - Documentos com IA › Visualizar\". Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403.\n\n**Erros:** 404 quando o modelo não existe neste escritório. 403 quando a chave é do Claude e o plano do escritório não inclui o MCP, ou quando o acesso do escritório está bloqueado.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do modelo (campo id de GET /docs/templates)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do modelo"},"name":{"type":"string","description":"Nome do modelo"},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Marcador como está no modelo, sem chaves (ex.: PERSON.name.2); é a chave em values"},"module":{"type":"string","enum":["LAW_SUIT","PERSON","PERSONALIZED","GENERAL"],"description":"PERSON (cadastro do cliente), LAW_SUIT (processo), GENERAL (data e hora de agora; cityState é digitado) ou PERSONALIZED (só digitado)"},"personIndex":{"type":"integer","nullable":true,"description":"Só PERSON: a pessoa do modelo (1 é o cliente de personId; 2 em diante só por values)"},"label":{"type":"string","description":"Rótulo do campo no escritório; sem rótulo cadastrado, a coluna. Pessoa 2 em diante leva \"(pessoa N)\""}},"required":["key","module","personIndex","label"],"additionalProperties":false},"description":"Campos do modelo, um por marcador, na ordem em que aparecem"}},"required":["id","name","fields"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/docs/from-template":{"post":{"summary":"Criar peça jurídica a partir de um modelo","tags":["Documents"],"description":"Cria a peça em Meus Documentos com o modelo preenchido e devolve o `id`. A peça abre no editor como as criadas pelo Juridiq: leva o papel timbrado quando o escritório o aplica automaticamente e dispara as automações de peça criada.\n\nDe onde sai cada valor (campos em GET /docs/templates/{id}):\n- `values` vence todos: a chave é o marcador sem chaves (`PERSONALIZED.valor`, `PERSON.name.2`) e `\"\"` apaga o marcador. Chave que o modelo não tem é ignorada;\n- `{{PERSON.<campo>}}` e `{{PERSON.<campo>.1}}`: o cliente de `personId`, com os dados de GET /person/{id}. Só `personId` preenche PERSON e põe a peça na pasta do cliente; `lawSuitId` sozinho não escolhe cliente;\n- `{{LAW_SUIT.<campo>}}`: o processo de `lawSuitId`, com os dados de GET /lawSuit/{id} (ex.: valor da causa em R$);\n- `{{GENERAL.date}}` e `{{GENERAL.time}}`: agora, no horário de Brasília.\n\nO que fica sem valor (inclusive campo vazio no cadastro) continua como marcador no texto e volta em `unresolved`, para completar no editor ou criar de novo com `values`. Marcador partido entre trechos de formatação diferente e campo antigo do editor não são trocados nem entram em `unresolved`.\n\nCom `personId` e `lawSuitId` juntos, o cliente tem de ser parte do processo.\n\n**Permissão:** com JWT, qualquer usuário do escritório; com chave, \"JuridiqDocs - Documentos com IA › Visualizar\". Com `x-juridiq-api-key`, a permissão precisa estar no perfil da chave e no de quem a criou; sem ela, 403. Cliente e processo privados seguem a privacidade de quem criou a chave.\n\n**Erros:** 400 com campo fora do contrato ou quando o cliente não é parte do processo. 403 quando o cliente ou o processo é privado e o dono da chave não tem acesso; também 403 quando a chave é do Claude e o plano do escritório não inclui o MCP, ou quando o acesso do escritório está bloqueado. 404 quando o modelo, o cliente ou o processo não existe neste escritório. 413 quando o corpo passa de 1 MB.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string","format":"uuid","description":"ID do modelo (campo id de GET /docs/templates)"},"name":{"type":"string","minLength":1,"maxLength":255,"description":"Nome da peça em Meus Documentos; sem ele, o nome do modelo"},"personId":{"type":"string","format":"uuid","description":"Cliente (GET /person): preenche {{PERSON.<campo>}} e {{PERSON.<campo>.1}} e põe a peça na pasta dele"},"lawSuitId":{"type":"string","format":"uuid","description":"Processo (GET /lawSuit): preenche {{LAW_SUIT.<campo>}}"},"values":{"type":"object","additionalProperties":{"type":"string","maxLength":10000},"description":"Valor por marcador, com a chave igual ao key de GET /docs/templates/{id} (ex.: { \"PERSONALIZED.valor\": \"R$ 1.000,00\", \"PERSON.name.2\": \"Banco X\" }). Vence o cliente, o processo e a data; \"\" apaga o marcador. Até 100 valores de até 10.000 caracteres"}},"required":["templateId"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da peça criada"},"name":{"type":"string","description":"Nome da peça"},"personId":{"type":"string","format":"uuid","nullable":true,"description":"Cliente em cuja pasta a peça está"},"createdAt":{"type":"string","format":"date-time","description":"Criação da peça (UTC)"},"unresolved":{"type":"array","items":{"type":"string"},"description":"Marcadores que ficaram sem valor, no formato de key, sem repetição e na ordem do modelo"}},"required":["id","name","personId","createdAt","unresolved"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"413":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/wiki/notes/":{"get":{"summary":"Listar notas da Wiki","tags":["Wiki"],"description":"Lista as notas da Wiki do escritório (sem o conteúdo), em ordem da árvore, com o caminho de cada uma. Filtre por `parentId` para descer na árvore ou por `section`. Para ler o conteúdo, use GET /wiki/notes/{id}.\n\n**Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor.\n\n**Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404.\n\n**Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"parentId","required":false,"description":"Só as subnotas diretas desta nota"},{"schema":{"type":"string","enum":["office","private"]},"in":"query","name":"section","required":false,"description":"Só uma seção: office ou private"},{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"in":"query","name":"limit","required":false,"description":"Itens por página, até 200"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da nota (página da Wiki)"},"title":{"type":"string","description":"Título; vazio quando a nota não tem título"},"icon":{"type":"string","nullable":true,"description":"Emoji do ícone"},"section":{"type":"string","enum":["office","private"],"description":"office: Escritório, visível para todo o escritório; private: Privadas, só de quem criou"},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Nota pai; null na raiz da seção"},"path":{"type":"string","description":"Caminho até a nota, como \"Manual do Escritório / Prazos\""}},"required":["id","title","icon","section","parentId","path"],"additionalProperties":false},"description":"Notas da página"},"totalResults":{"type":"number","description":"Total de notas com os filtros"},"totalPages":{"type":"number","description":"Total de páginas"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Criar nota na Wiki","tags":["Wiki"],"description":"Cria uma nota no fim da seção (ou da nota pai) com título e conteúdo em Markdown. Subnota herda a seção da nota pai.\n\n**Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor.\n\n**Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404.\n\n**Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":500,"description":"Título da nota"},"icon":{"type":"string","maxLength":16,"nullable":true,"description":"Emoji usado como ícone da nota; null tira o ícone"},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Cria como subnota desta nota; a seção vem da nota pai"},"section":{"type":"string","enum":["office","private"],"description":"Seção quando não há parentId. Padrão: office"},"markdown":{"type":"string","maxLength":500000,"description":"Conteúdo em Markdown: títulos (#, ##, ###), parágrafos, **negrito**, *itálico*, ~~riscado~~, `código`, links https, listas (-, 1., - [ ] / - [x]), citação (>), bloco de código (```), tabela (| a | b |), imagem https. Linha só com [Título](wiki://pagina/<id>) vira link para outra nota; [Item do Juridiq: Processo](juridiq://lawsuit/<id>) vira cartão do Juridiq (tipos: task, recurring, event, audience, consulting, lawsuit, person)"}},"required":["title"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da nota (página da Wiki)"},"title":{"type":"string","description":"Título; vazio quando a nota não tem título"},"icon":{"type":"string","nullable":true,"description":"Emoji do ícone"},"section":{"type":"string","enum":["office","private"],"description":"office: Escritório, visível para todo o escritório; private: Privadas, só de quem criou"},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Nota pai; null na raiz da seção"},"path":{"type":"string","description":"Caminho até a nota, como \"Manual do Escritório / Prazos\""},"version":{"type":"integer","description":"Versão inicial"}},"required":["id","title","icon","section","parentId","path","version"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/wiki/notes/search":{"get":{"summary":"Buscar notas da Wiki","tags":["Wiki"],"description":"Busca no título e no texto das notas, sem diferenciar acento, e devolve até 20 resultados com o trecho encontrado (termos entre **). Para ler a nota inteira, use GET /wiki/notes/{id}.\n\n**Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor.\n\n**Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404.\n\n**Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":200},"in":"query","name":"q","required":true,"description":"Termos da busca, no título e no texto"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da nota (página da Wiki)"},"title":{"type":"string","description":"Título"},"icon":{"type":"string","nullable":true,"description":"Emoji do ícone"},"snippet":{"type":"string","description":"Trecho com os termos encontrados entre **"}},"required":["id","title","icon","snippet"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/wiki/notes/{id}":{"get":{"summary":"Ler nota da Wiki","tags":["Wiki"],"description":"Devolve a nota com o conteúdo em Markdown e a `version`, que o PATCH exige. Cores, sublinhado e alinhamento do editor não existem no Markdown e não aparecem aqui.\n\n**Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor.\n\n**Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404.\n\n**Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da nota (página da Wiki)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da nota (página da Wiki)"},"title":{"type":"string","description":"Título; vazio quando a nota não tem título"},"icon":{"type":"string","nullable":true,"description":"Emoji do ícone"},"section":{"type":"string","enum":["office","private"],"description":"office: Escritório, visível para todo o escritório; private: Privadas, só de quem criou"},"parentId":{"type":"string","format":"uuid","nullable":true,"description":"Nota pai; null na raiz da seção"},"path":{"type":"string","description":"Caminho até a nota, como \"Manual do Escritório / Prazos\""},"version":{"type":"integer","description":"Versão atual; envie no PATCH"},"updatedAt":{"type":"string","format":"date-time","description":"Última alteração (UTC)"},"updatedByName":{"type":"string","nullable":true,"description":"Quem alterou por último"},"markdown":{"type":"string","description":"Conteúdo em Markdown"}},"required":["id","title","icon","section","parentId","path","version","updatedAt","updatedByName","markdown"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Editar nota da Wiki","tags":["Wiki"],"description":"Altera título, ícone e/ou conteúdo. `markdown` substitui o conteúdo inteiro: o que o Markdown não representa (cores, sublinhado, alinhamento, largura de colunas) se perde. Envie a `version` lida; se alguém salvou antes, a resposta é 409 com a versão atual, e nada é gravado. Nota privada de outra pessoa não pode ser editada.\n\n**Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor.\n\n**Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404.\n\n**Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"integer","description":"Versão lida em GET /wiki/notes/{id}; se outra pessoa salvou antes, 409","exclusiveMinimum":0},"title":{"type":"string","minLength":1,"maxLength":500,"description":"Título da nota"},"icon":{"type":"string","maxLength":16,"nullable":true,"description":"Emoji usado como ícone da nota; null tira o ícone"},"markdown":{"type":"string","maxLength":500000,"description":"Substitui o conteúdo inteiro da nota. Veja o formato aceito em POST /wiki/notes"}},"required":["version"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da nota (página da Wiki)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"integer","description":"Nova versão"}},"required":["version"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"},"code":{"type":"string","description":"WIKI_VERSION_CONFLICT"},"version":{"type":"number","description":"Versão atual da nota"},"updatedAt":{"type":"string","format":"date-time","description":"Quando foi a última alteração"},"updatedByName":{"type":"string","nullable":true,"description":"Quem alterou"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Apagar nota da Wiki","tags":["Wiki"],"description":"Manda a nota e as subnotas para a Lixeira da Wiki. Dá para restaurar pelo Juridiq; a exclusão definitiva só é feita lá.\n\n**Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor.\n\n**Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404.\n\n**Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da nota (página da Wiki)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"Notas enviadas para a Lixeira"}},"required":["count"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/wiki/notes/{id}/comments":{"get":{"summary":"Listar comentários de nota da Wiki","tags":["Wiki"],"description":"Comentários da nota, com as respostas dentro de cada conversa, do mais antigo ao mais novo.\n\n**Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor.\n\n**Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404.\n\n**Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da nota (página da Wiki)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do comentário"},"body":{"type":"string","description":"Texto, com menções no formato @[Nome](userId)"},"authorName":{"type":"string","nullable":true,"description":"Autor; null se a pessoa foi removida"},"createdAt":{"type":"string","format":"date-time","description":"Data do comentário (UTC)"},"resolved":{"type":"boolean","description":"Conversa marcada como resolvida"},"replies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do comentário"},"body":{"type":"string","description":"Texto, com menções no formato @[Nome](userId)"},"authorName":{"type":"string","nullable":true,"description":"Autor; null se a pessoa foi removida"},"createdAt":{"type":"string","format":"date-time","description":"Data do comentário (UTC)"},"resolved":{"type":"boolean","description":"Conversa marcada como resolvida"}},"required":["id","body","authorName","createdAt","resolved"],"additionalProperties":false},"description":"Respostas"}},"required":["id","body","authorName","createdAt","resolved","replies"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"post":{"summary":"Comentar em nota da Wiki","tags":["Wiki"],"description":"Adiciona um comentário (ou resposta, com `parentId`). Menções no formato @[Nome](userId) avisam a pessoa no sino; quem não pode ler a nota não é avisado e aparece em `notNotified`.\n\n**Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor.\n\n**Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404.\n\n**Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":10000,"description":"Texto do comentário. Menção: @[Nome](userId) avisa a pessoa no sino, se ela puder ler a nota"},"parentId":{"type":"string","format":"uuid","description":"Responde a este comentário"}},"required":["body"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da nota (página da Wiki)"}],"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do comentário"},"notNotified":{"type":"array","items":{"type":"string"},"description":"Mencionados sem acesso à nota, que não foram avisados"}},"required":["id","notNotified"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/subaccount/":{"get":{"summary":"Consultar subconta Asaas","tags":["Subaccount"],"description":"Retorna a subconta Asaas vinculada ao escritório.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response"},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/subaccount/customer":{"post":{"summary":"Criar cliente na subconta Asaas","tags":["Subaccount"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"shouldCreateInternalCustomer":{"type":"boolean"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"document":{"type":"string"}},"required":["shouldCreateInternalCustomer","name","email","phone","document"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response"},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/subaccount/billing":{"post":{"summary":"Criar cobrança (boleto ou PIX)","tags":["Subaccount"],"description":"Conta, categoria, processo e cliente (internal.customer) precisam ser do escritório da credencial; vínculo de outro escritório responde 404 antes de qualquer chamada ao Asaas. Informe kind, gateway (dados da cobrança no Asaas) e internal (dados do lançamento). Gera o lançamento de receita no financeiro, vinculado à pessoa, ao processo, à conta e à categoria informados: um em PAYMENT, um por parcela em INSTALLMENT e o primeiro em SUBSCRIPTION. Vencimento em mês fechado é recusado antes de chamar o Asaas, exceto em INSTALLMENT.","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["PAYMENT"],"description":"PAYMENT (à vista), INSTALLMENT (parcelada) ou SUBSCRIPTION (assinatura)"},"gateway":{"type":"object","properties":{"customer":{"type":"string","nullable":true,"description":"ID do cliente no Asaas. Dispensável quando internal.customer é informado"},"billingType":{"type":"string","enum":["BOLETO","CREDIT_CARD","PIX","UNDEFINED"],"description":"Forma de pagamento"},"value":{"type":"number","description":"Valor da cobrança. Em INSTALLMENT, é o total, dividido entre as parcelas","exclusiveMinimum":0},"description":{"type":"string","description":"Descrição exibida ao pagador"},"externalReference":{"type":"string","maxLength":255},"discount":{"type":"object","properties":{"value":{"type":"number","description":"Valor do desconto"},"dueDateLimitDays":{"type":"integer","description":"Dias antes do vencimento até os quais o desconto vale","exclusiveMinimum":0},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false,"description":"Desconto por pagamento antecipado"},"interest":{"type":"object","properties":{"value":{"type":"number","description":"Juros ao mês, em percentual"}},"additionalProperties":false,"description":"Juros por atraso"},"fine":{"type":"object","properties":{"value":{"type":"number","description":"Valor da multa por atraso"},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false,"description":"Multa por atraso"},"split":{"type":"array","items":{"type":"object","properties":{"walletId":{"type":"string"},"fixedValue":{"type":"number"},"percentualValue":{"type":"number","minimum":0,"maximum":100},"totalFixedValue":{"type":"number"},"externalReference":{"type":"string","maxLength":255},"description":{"type":"string"}},"required":["walletId"],"additionalProperties":false}},"callback":{"type":"object","properties":{"successUrl":{"type":"string","format":"uri"},"autoRedirect":{"type":"boolean"}},"required":["successUrl"],"additionalProperties":false},"remoteIp":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}]},"notifications":{"type":"array","items":{"type":"string","enum":["EMAIL","SMS","WHATSAPP"]}},"creditCardToken":{"type":"string"},"dueDate":{"type":"string","description":"Vencimento (AAAA-MM-DD). Usado em PAYMENT e INSTALLMENT"},"daysAfterDueDateToRegistrationCancellation":{"type":"integer","exclusiveMinimum":0}},"required":["billingType","value","dueDate"],"additionalProperties":false},"internal":{"type":"object","properties":{"customer":{"type":"string","nullable":true,"description":"ID da pessoa (cliente) no Juridiq"},"description":{"type":"string","description":"Descrição do lançamento no financeiro"},"billId":{"type":"string","description":"ID da conta bancária do lançamento"},"categoryId":{"type":"string","nullable":true,"description":"ID da categoria financeira"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"annotations":{"type":"string","description":"Observações do lançamento"},"partnerId":{"type":"string","format":"uuid","nullable":true},"isRetroactive":{"type":"boolean"},"generateCommission":{"type":"boolean"}},"required":["description","billId"],"additionalProperties":false},"nfse":{"type":"object","properties":{"serviceDescription":{"type":"string","minLength":1},"observations":{"type":"string","default":""},"value":{"type":"number","exclusiveMinimum":0},"deductions":{"type":"number","default":0},"municipalServiceId":{"type":"string"},"municipalServiceCode":{"type":"string"},"municipalServiceName":{"type":"string","minLength":1},"taxes":{"type":"object","properties":{"retainIss":{"type":"boolean"},"iss":{"type":"number"},"cofins":{"type":"number"},"pis":{"type":"number"},"inss":{"type":"number"},"ir":{"type":"number"},"csll":{"type":"number"},"nbsCode":{"type":"string"},"taxSituationCode":{"type":"string"},"taxClassificationCode":{"type":"string"},"operationIndicatorCode":{"type":"string"},"pisCofinsTaxStatus":{"type":"string"},"operationPis":{"type":"number"},"operationCofins":{"type":"number"},"useTaxSystemReformNT007":{"type":"boolean"}},"additionalProperties":false},"updatePayment":{"type":"boolean"}},"required":["serviceDescription","municipalServiceName","taxes"],"additionalProperties":false}},"required":["kind","gateway","internal"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["INSTALLMENT"]},"gateway":{"type":"object","properties":{"customer":{"type":"string","nullable":true,"description":"ID do cliente no Asaas. Dispensável quando internal.customer é informado"},"billingType":{"type":"string","enum":["BOLETO","CREDIT_CARD","PIX","UNDEFINED"],"description":"Forma de pagamento"},"value":{"type":"number","description":"Valor da cobrança. Em INSTALLMENT, é o total, dividido entre as parcelas","exclusiveMinimum":0},"description":{"type":"string","description":"Descrição exibida ao pagador"},"externalReference":{"type":"string","maxLength":255},"discount":{"type":"object","properties":{"value":{"type":"number","description":"Valor do desconto"},"dueDateLimitDays":{"type":"integer","description":"Dias antes do vencimento até os quais o desconto vale","exclusiveMinimum":0},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false,"description":"Desconto por pagamento antecipado"},"interest":{"type":"object","properties":{"value":{"type":"number","description":"Juros ao mês, em percentual"}},"additionalProperties":false,"description":"Juros por atraso"},"fine":{"type":"object","properties":{"value":{"type":"number","description":"Valor da multa por atraso"},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false,"description":"Multa por atraso"},"split":{"type":"array","items":{"type":"object","properties":{"walletId":{"type":"string"},"fixedValue":{"type":"number"},"percentualValue":{"type":"number","minimum":0,"maximum":100},"totalFixedValue":{"type":"number"},"externalReference":{"type":"string","maxLength":255},"description":{"type":"string"}},"required":["walletId"],"additionalProperties":false}},"callback":{"type":"object","properties":{"successUrl":{"type":"string","format":"uri"},"autoRedirect":{"type":"boolean"}},"required":["successUrl"],"additionalProperties":false},"remoteIp":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}]},"notifications":{"type":"array","items":{"type":"string","enum":["EMAIL","SMS","WHATSAPP"]}},"creditCardToken":{"type":"string"},"dueDate":{"type":"string","description":"Vencimento (AAAA-MM-DD). Usado em PAYMENT e INSTALLMENT"},"installmentCount":{"type":"integer","description":"Número de parcelas. Obrigatório em INSTALLMENT"},"daysAfterDueDateToRegistrationCancellation":{"type":"integer","exclusiveMinimum":0}},"required":["billingType","value","dueDate","installmentCount"],"additionalProperties":false},"internal":{"type":"object","properties":{"customer":{"type":"string","nullable":true,"description":"ID da pessoa (cliente) no Juridiq"},"description":{"type":"string","description":"Descrição do lançamento no financeiro"},"billId":{"type":"string","description":"ID da conta bancária do lançamento"},"categoryId":{"type":"string","nullable":true,"description":"ID da categoria financeira"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"annotations":{"type":"string","description":"Observações do lançamento"},"partnerId":{"type":"string","format":"uuid","nullable":true},"isRetroactive":{"type":"boolean"},"generateCommission":{"type":"boolean"}},"required":["description","billId"],"additionalProperties":false}},"required":["kind","gateway","internal"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["SUBSCRIPTION"]},"gateway":{"type":"object","properties":{"customer":{"type":"string","nullable":true,"description":"ID do cliente no Asaas. Dispensável quando internal.customer é informado"},"billingType":{"type":"string","enum":["BOLETO","CREDIT_CARD","PIX","UNDEFINED"],"description":"Forma de pagamento"},"value":{"type":"number","description":"Valor da cobrança. Em INSTALLMENT, é o total, dividido entre as parcelas","exclusiveMinimum":0},"description":{"type":"string","description":"Descrição exibida ao pagador"},"externalReference":{"type":"string","maxLength":255},"discount":{"type":"object","properties":{"value":{"type":"number","description":"Valor do desconto"},"dueDateLimitDays":{"type":"integer","description":"Dias antes do vencimento até os quais o desconto vale","exclusiveMinimum":0},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false,"description":"Desconto por pagamento antecipado"},"interest":{"type":"object","properties":{"value":{"type":"number","description":"Juros ao mês, em percentual"}},"additionalProperties":false,"description":"Juros por atraso"},"fine":{"type":"object","properties":{"value":{"type":"number","description":"Valor da multa por atraso"},"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Valor fixo ou percentual"}},"additionalProperties":false,"description":"Multa por atraso"},"split":{"type":"array","items":{"type":"object","properties":{"walletId":{"type":"string"},"fixedValue":{"type":"number"},"percentualValue":{"type":"number","minimum":0,"maximum":100},"totalFixedValue":{"type":"number"},"externalReference":{"type":"string","maxLength":255},"description":{"type":"string"}},"required":["walletId"],"additionalProperties":false}},"callback":{"type":"object","properties":{"successUrl":{"type":"string","format":"uri"},"autoRedirect":{"type":"boolean"}},"required":["successUrl"],"additionalProperties":false},"remoteIp":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}]},"notifications":{"type":"array","items":{"type":"string","enum":["EMAIL","SMS","WHATSAPP"]}},"creditCardToken":{"type":"string"},"nextDueDate":{"type":"string","description":"Primeiro vencimento (AAAA-MM-DD). Obrigatório em SUBSCRIPTION"},"endDate":{"type":"string","description":"Fim da assinatura (AAAA-MM-DD)"},"cycle":{"type":"string","enum":["WEEKLY","BIWEEKLY","MONTHLY","QUARTERLY","SEMIANNUALLY","YEARLY"],"description":"Periodicidade. Obrigatória em SUBSCRIPTION"}},"required":["billingType","value","nextDueDate","cycle"],"additionalProperties":false},"internal":{"type":"object","properties":{"customer":{"type":"string","nullable":true,"description":"ID da pessoa (cliente) no Juridiq"},"description":{"type":"string","description":"Descrição do lançamento no financeiro"},"billId":{"type":"string","description":"ID da conta bancária do lançamento"},"categoryId":{"type":"string","nullable":true,"description":"ID da categoria financeira"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo"},"annotations":{"type":"string","description":"Observações do lançamento"},"partnerId":{"type":"string","format":"uuid","nullable":true},"isRetroactive":{"type":"boolean"},"generateCommission":{"type":"boolean"}},"required":["description","billId"],"additionalProperties":false}},"required":["kind","gateway","internal"],"additionalProperties":false}]}}}},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"transactionId":{"type":"string","description":"ID do lançamento criado"},"externalId":{"type":"string","description":"ID da cobrança no Asaas"},"installmentId":{"type":"string","description":"ID do parcelamento no Asaas"},"subscriptionId":{"type":"string","description":"ID da assinatura no Asaas"}},"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/subaccount/payment-link":{"post":{"summary":"Criar link de pagamento","tags":["Subaccount"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"description":{"type":"string"},"endDate":{"type":"string","format":"date-time"},"value":{"type":"number","exclusiveMinimum":0},"billingType":{"type":"string","enum":["UNDEFINED","BOLETO","CREDIT_CARD","PIX"]},"chargeType":{"type":"string","enum":["DETACHED","RECURRENT","INSTALLMENT"]},"dueDateLimitDays":{"type":"integer","exclusiveMinimum":0},"subscriptionCycle":{"type":"string","enum":["WEEKLY","BIWEEKLY","MONTHLY","BIMONTHLY","QUARTERLY","SEMIANNUALLY","YEARLY"]},"maxInstallmentCount":{"type":"integer","default":1,"exclusiveMinimum":0},"externalReference":{"type":"string"},"notificationEnabled":{"type":"boolean","default":true},"callback":{"type":"object","properties":{"successUrl":{"type":"string","format":"uri"},"autoRedirect":{"type":"boolean","default":true}},"required":["successUrl"],"additionalProperties":false},"isAddressRequired":{"type":"boolean"}},"required":["name","billingType","chargeType"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response"},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/credits/summary":{"get":{"summary":"Buscar resumo de créditos","tags":["Credits"],"description":"Retorna o resumo de créditos","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"aiCredits":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"renewal":{"type":"string","enum":["monthly","static"]},"planTotal":{"type":"number"},"used":{"type":"number"},"available":{"type":"number"},"purchasedExtra":{"type":"number"},"purchasedExpiresAt":{"type":"string","nullable":true},"nextResetAt":{"type":"string","nullable":true},"bonusAvailable":{"type":"number"},"bonusNextExpiresAt":{"type":"string","nullable":true}},"required":["id","renewal","planTotal","used","available","purchasedExtra","purchasedExpiresAt","nextResetAt","bonusAvailable","bonusNextExpiresAt"],"additionalProperties":false},"newLawsuitsMonitoringCredits":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"renewal":{"type":"string","enum":["monthly","static"]},"planTotal":{"type":"number"},"used":{"type":"number"},"available":{"type":"number"},"purchasedExtra":{"type":"number"},"purchasedExpiresAt":{"type":"string","nullable":true},"nextResetAt":{"type":"string","nullable":true}},"required":["id","renewal","planTotal","used","available","purchasedExtra","purchasedExpiresAt","nextResetAt"],"additionalProperties":false},"lawsuitsMonitoringCredits":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"renewal":{"type":"string","enum":["monthly","static"]},"planTotal":{"type":"number"},"used":{"type":"number"},"available":{"type":"number"},"purchasedExtra":{"type":"number"},"purchasedExpiresAt":{"type":"string","nullable":true},"nextResetAt":{"type":"string","nullable":true}},"required":["id","renewal","planTotal","used","available","purchasedExtra","purchasedExpiresAt","nextResetAt"],"additionalProperties":false},"calculatorCredits":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"renewal":{"type":"string","enum":["monthly","static"]},"planTotal":{"type":"number"},"used":{"type":"number"},"available":{"type":"number"},"purchasedExtra":{"type":"number"},"purchasedExpiresAt":{"type":"string","nullable":true},"nextResetAt":{"type":"string","nullable":true},"unlimited":{"type":"boolean"}},"required":["id","renewal","planTotal","used","available","purchasedExtra","purchasedExpiresAt","nextResetAt","unlimited"],"additionalProperties":false},"publicationCredits":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"renewal":{"type":"string","enum":["monthly","static"]},"planTotal":{"type":"number"},"used":{"type":"number"},"available":{"type":"number"},"purchasedExtra":{"type":"number"},"purchasedExpiresAt":{"type":"string","nullable":true},"nextResetAt":{"type":"string","nullable":true}},"required":["id","renewal","planTotal","used","available","purchasedExtra","purchasedExpiresAt","nextResetAt"],"additionalProperties":false},"signaturesCredits":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"renewal":{"type":"string","enum":["monthly","static"]},"planTotal":{"type":"number"},"used":{"type":"number"},"available":{"type":"number"},"purchasedExtra":{"type":"number"},"purchasedExpiresAt":{"type":"string","nullable":true},"nextResetAt":{"type":"string","nullable":true},"unlimited":{"type":"boolean"}},"required":["id","renewal","planTotal","used","available","purchasedExtra","purchasedExpiresAt","nextResetAt","unlimited"],"additionalProperties":false}},"required":["aiCredits","newLawsuitsMonitoringCredits","lawsuitsMonitoringCredits","calculatorCredits","publicationCredits","signaturesCredits"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/credits/transactions":{"get":{"summary":"Listar transações de crédito","tags":["Transactions"],"description":"Lista transações de crédito com filtros e paginação","parameters":[{"schema":{"anyOf":[{"type":"string"},{"type":"number"}]},"in":"query","name":"page","required":false},{"schema":{"anyOf":[{"type":"string"},{"type":"number"}]},"in":"query","name":"limit","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"creditModuleId","required":false}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"amount":{"type":"number"},"totalValue":{"type":"number"},"asaasPaymentId":{"type":"string","nullable":true},"officeId":{"type":"string"},"creditModuleId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"creditModule":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["id","name","description"],"additionalProperties":false}},"required":["id","amount","totalValue","asaasPaymentId","officeId","creditModuleId","createdAt","updatedAt"],"additionalProperties":false}},"totalResults":{"type":"number"},"totalPages":{"type":"number"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/notifications/list":{"get":{"summary":"Listar notificações","tags":["Notifications"],"description":"Lista as notificações do usuário dono da chave (cada usuário tem as suas). grouped=true traz uma por item pai; groupKey traz as de um item. Andamentos não vêm aqui: use `GET /movements`. Substitui `GET /alert/` e `GET /alert/tabs` (o contador por tipo está em unreadByLink).","parameters":[{"schema":{"anyOf":[{"type":"string","enum":["true","false"]},{"type":"boolean"}]},"in":"query","name":"grouped","required":false,"description":"true: pagina por item pai e traz as notificações de cada um em groups"},{"schema":{"anyOf":[{"type":"string","enum":["TASK","SUBTASK","WORKFLOW","AUDIENCE","PERSON_BIRTHDAY","USER_BIRTHDAY","WIKI","LAWSUIT_DISCOVERY","BANK_CONNECTION"]},{"type":"array","items":{"type":"string","enum":["TASK","SUBTASK","WORKFLOW","AUDIENCE","PERSON_BIRTHDAY","USER_BIRTHDAY","WIKI","LAWSUIT_DISCOVERY","BANK_CONNECTION"]}}]},"in":"query","name":"links","required":false,"description":"Filtra por tipo de vínculo; repita o parâmetro para mais de um"},{"schema":{"type":"string","minLength":1,"maxLength":200},"in":"query","name":"groupKey","required":false,"description":"Id do item pai (taskId, audienceId...): filtra as notificações daquele item"},{"schema":{"anyOf":[{"type":"string","enum":["true","false"]},{"type":"boolean"}]},"in":"query","name":"unread","required":false,"description":"true: só não lidas"},{"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"in":"query","name":"orderBy","required":false,"description":"Data: desc (mais recentes primeiro, padrão) ou asc"},{"schema":{"anyOf":[{"type":"string","enum":["true","false"]},{"type":"boolean"}]},"in":"query","name":"bell","required":false,"description":"true: aplica as preferências do sino (inAppTasks) na lista e na contagem"},{"schema":{"type":"string","maxLength":200},"in":"query","name":"cursor","required":false,"description":"Cursor devolvido em nextCursor"},{"schema":{"type":"integer","exclusiveMinimum":0},"in":"query","name":"page","required":false,"description":"Paginação por página (com total). Sem page, pagina por cursor"},{"schema":{"type":"integer","maximum":100,"default":20,"exclusiveMinimum":0},"in":"query","name":"limit","required":false}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"link":{"type":"string","enum":["TASK","SUBTASK","WORKFLOW","AUDIENCE","PERSON_BIRTHDAY","USER_BIRTHDAY","WIKI","LAWSUIT_DISCOVERY","BANK_CONNECTION"]},"groupKey":{"type":"string"},"event":{"type":"string"},"title":{"type":"string"},"body":{"type":"string"},"payload":{"nullable":true},"isRead":{"type":"boolean"},"createdAt":{"type":"string"},"taskId":{"type":"string","nullable":true},"subtaskId":{"type":"string","nullable":true},"workflowInstanceId":{"type":"string","nullable":true},"audienceId":{"type":"string","nullable":true},"personId":{"type":"string","nullable":true},"birthdayUserId":{"type":"string","nullable":true},"wikiPageId":{"type":"string","nullable":true},"newLawSuitMonitoringId":{"type":"string","nullable":true},"processNumber":{"type":"string","nullable":true},"dueDate":{"type":"string","nullable":true,"description":"Prazo da tarefa (finalDate, ou initialDate sem final). Null fora de tarefa"},"dueHour":{"type":"string","nullable":true,"description":"Hora do prazo, quando a tarefa tem"},"jurichat":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","PROCESSING","SENT","FAILED","CANCELED","SKIPPED"]},"sentAt":{"type":"string","nullable":true},"failureCode":{"type":"string","nullable":true}},"required":["status","sentAt","failureCode"],"additionalProperties":false,"nullable":true,"description":"Parabéns pelo Jurichat: só em aniversário de cliente com envio criado"}},"required":["id","link","groupKey","event","title","body","isRead","createdAt","taskId","subtaskId","workflowInstanceId","audienceId","personId","birthdayUserId","wikiPageId","newLawSuitMonitoringId","processNumber","dueDate","dueHour","jurichat"],"additionalProperties":false},"description":"Lista plana; vazia com grouped=true"},"groups":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string","enum":["TASK","SUBTASK","WORKFLOW","AUDIENCE","PERSON_BIRTHDAY","USER_BIRTHDAY","WIKI","LAWSUIT_DISCOVERY","BANK_CONNECTION"]},"groupKey":{"type":"string"},"parentTitle":{"type":"string","nullable":true,"description":"Título do item pai (tarefa, audiência, pessoa...); null se não existe mais"},"latestAt":{"type":"string"},"totalCount":{"type":"integer"},"unreadCount":{"type":"integer"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"link":{"type":"string","enum":["TASK","SUBTASK","WORKFLOW","AUDIENCE","PERSON_BIRTHDAY","USER_BIRTHDAY","WIKI","LAWSUIT_DISCOVERY","BANK_CONNECTION"]},"groupKey":{"type":"string"},"event":{"type":"string"},"title":{"type":"string"},"body":{"type":"string"},"payload":{"nullable":true},"isRead":{"type":"boolean"},"createdAt":{"type":"string"},"taskId":{"type":"string","nullable":true},"subtaskId":{"type":"string","nullable":true},"workflowInstanceId":{"type":"string","nullable":true},"audienceId":{"type":"string","nullable":true},"personId":{"type":"string","nullable":true},"birthdayUserId":{"type":"string","nullable":true},"wikiPageId":{"type":"string","nullable":true},"newLawSuitMonitoringId":{"type":"string","nullable":true},"processNumber":{"type":"string","nullable":true},"dueDate":{"type":"string","nullable":true,"description":"Prazo da tarefa (finalDate, ou initialDate sem final). Null fora de tarefa"},"dueHour":{"type":"string","nullable":true,"description":"Hora do prazo, quando a tarefa tem"},"jurichat":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","PROCESSING","SENT","FAILED","CANCELED","SKIPPED"]},"sentAt":{"type":"string","nullable":true},"failureCode":{"type":"string","nullable":true}},"required":["status","sentAt","failureCode"],"additionalProperties":false,"nullable":true,"description":"Parabéns pelo Jurichat: só em aniversário de cliente com envio criado"}},"required":["id","link","groupKey","event","title","body","isRead","createdAt","taskId","subtaskId","workflowInstanceId","audienceId","personId","birthdayUserId","wikiPageId","newLawSuitMonitoringId","processNumber","dueDate","dueHour","jurichat"],"additionalProperties":false},"description":"As notificações mais recentes do item (até 20)"}},"required":["link","groupKey","parentTitle","latestAt","totalCount","unreadCount","items"],"additionalProperties":false},"nullable":true,"description":"Só com grouped=true: itens pai paginados, cada um com as suas notificações"},"nextCursor":{"type":"string","nullable":true},"totalResults":{"type":"integer","nullable":true,"description":"Só com page"},"totalPages":{"type":"integer","nullable":true,"description":"Só com page"},"unread":{"type":"integer","description":"Não lidas do usuário nos tipos filtrados por links (sem links: todas)"},"unreadByLink":{"type":"object","additionalProperties":{"type":"integer"},"description":"Não lidas do usuário por tipo, sem filtro (contador de cada aba)"}},"required":["data","groups","nextCursor","totalResults","totalPages","unread","unreadByLink"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/notifications/read":{"patch":{"summary":"Marcar notificações como lidas","tags":["Notifications"],"description":"Marca como lidas as notificações do usuário dono da chave. Sem filtro no body, marca todas.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"bell":{"type":"boolean","description":"true: não toca nas categorias escondidas do sino"},"ids":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":500},"links":{"type":"array","items":{"type":"string","enum":["TASK","SUBTASK","WORKFLOW","AUDIENCE","PERSON_BIRTHDAY","USER_BIRTHDAY","WIKI","LAWSUIT_DISCOVERY","BANK_CONNECTION"]}},"groupKey":{"type":"string","minLength":1,"maxLength":200,"description":"Id do item pai (taskId, audienceId...): filtra as notificações daquele item"},"groups":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string","enum":["TASK","SUBTASK","WORKFLOW","AUDIENCE","PERSON_BIRTHDAY","USER_BIRTHDAY","WIKI","LAWSUIT_DISCOVERY","BANK_CONNECTION"]},"groupKey":{"type":"string","minLength":1,"maxLength":200,"description":"Id do item pai (taskId, audienceId...): filtra as notificações daquele item"}},"required":["link","groupKey"],"additionalProperties":false},"maxItems":100,"description":"Vários itens pai de uma vez (seleção em lote na lista agrupada)"}},"additionalProperties":false,"default":{},"description":"Sem filtro marca todas as notificações do usuário"}}},"description":"Sem filtro marca todas as notificações do usuário"},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"}},"required":["count"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/notifications/":{"delete":{"summary":"Descartar notificações","tags":["Notifications"],"description":"Apaga notificações do usuário dono da chave, sem volta. Exige ids, groupKey ou groups (400 sem nenhum deles).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"bell":{"type":"boolean","description":"true: não toca nas categorias escondidas do sino"},"ids":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":500},"links":{"type":"array","items":{"type":"string","enum":["TASK","SUBTASK","WORKFLOW","AUDIENCE","PERSON_BIRTHDAY","USER_BIRTHDAY","WIKI","LAWSUIT_DISCOVERY","BANK_CONNECTION"]}},"groupKey":{"type":"string","minLength":1,"maxLength":200,"description":"Id do item pai (taskId, audienceId...): filtra as notificações daquele item"},"groups":{"type":"array","items":{"type":"object","properties":{"link":{"type":"string","enum":["TASK","SUBTASK","WORKFLOW","AUDIENCE","PERSON_BIRTHDAY","USER_BIRTHDAY","WIKI","LAWSUIT_DISCOVERY","BANK_CONNECTION"]},"groupKey":{"type":"string","minLength":1,"maxLength":200,"description":"Id do item pai (taskId, audienceId...): filtra as notificações daquele item"}},"required":["link","groupKey"],"additionalProperties":false},"maxItems":100,"description":"Vários itens pai de uma vez (seleção em lote na lista agrupada)"}},"additionalProperties":false}}}},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"}},"required":["count"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/movements/":{"get":{"summary":"Listar andamentos processuais","tags":["Movements"],"description":"Sem lawSuitId: os andamentos novos do escritório, pela ordem de entrada (todos veem; só quem trata marca como lido). Com lawSuitId: todos os andamentos do processo, pela data do andamento. Filtros e totais como os de publicações. Aceita JWT ou o header `x-juridiq-api-key`; o usuário da chave precisa ver processos (403 sem a permissão). ","parameters":[{"schema":{"type":"integer","default":1,"exclusiveMinimum":0},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"integer","maximum":1000,"default":30,"exclusiveMinimum":0},"in":"query","name":"limit","required":false,"description":"Itens por página. Até 1000: a aba do processo carrega todos de uma vez"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc (padrão: desc)"},{"schema":{"anyOf":[{"type":"string","enum":["true","false"]},{"type":"boolean"}]},"in":"query","name":"grouped","required":false,"description":"true: pagina por processo e traz os andamentos de cada um em groups (data vazio)"},{"schema":{"type":"string","maxLength":200},"in":"query","name":"keySearch","required":false,"description":"Trecho buscado no conteúdo do andamento ou no número do processo"},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"isHandled","required":false,"description":"true: lidos; false: não lidos"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"lawSuitId","required":false,"description":"Todos os andamentos do processo. Sem ele: os andamentos novos do escritório"},{"schema":{"anyOf":[{"type":"string","enum":["MANUAL","COURT_LAWSUIT_INSTANCE","COURT_LAWSUIT_ROW","SECRET","INSS"]},{"type":"array","items":{"type":"string","enum":["MANUAL","COURT_LAWSUIT_INSTANCE","COURT_LAWSUIT_ROW","SECRET","INSS"]}}]},"in":"query","name":"sources","required":false},{"schema":{"anyOf":[{"type":"string","maxLength":40},{"type":"array","items":{"type":"string","maxLength":40}}]},"in":"query","name":"kinds","required":false},{"schema":{"type":"string","maxLength":40},"in":"query","name":"courtAcronym","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"tagId","required":false},{"schema":{"type":"integer","exclusiveMinimum":0},"in":"query","name":"instance","required":false},{"schema":{"type":"string","format":"date"},"in":"query","name":"start","required":false,"description":"Data inicial do andamento (YYYY-MM-DD, São Paulo)"},{"schema":{"type":"string","format":"date"},"in":"query","name":"end","required":false,"description":"Data final do andamento, inclusive (YYYY-MM-DD)"},{"schema":{"type":"string","format":"date"},"in":"query","name":"readStart","required":false,"description":"Data inicial de leitura (YYYY-MM-DD, São Paulo)"},{"schema":{"type":"string","format":"date"},"in":"query","name":"readEnd","required":false,"description":"Data final de leitura, inclusive (YYYY-MM-DD)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"lawSuitId":{"type":"string","nullable":true},"processNumber":{"type":"string"},"parties":{"type":"string","nullable":true,"description":"Partes do processo: \"Cliente x Requerida\""},"externalId":{"type":"string"},"source":{"type":"string","enum":["MANUAL","COURT_LAWSUIT_INSTANCE","COURT_LAWSUIT_ROW","SECRET","INSS"]},"kind":{"type":"string","nullable":true},"courtAcronym":{"type":"string","nullable":true},"courtDegree":{"type":"number","nullable":true},"instance":{"type":"number","nullable":true},"lawSuitInstanceId":{"type":"string","nullable":true},"movementDate":{"type":"string","nullable":true},"rawDate":{"type":"string","nullable":true},"content":{"type":"string"},"authorName":{"type":"string","nullable":true},"metadata":{"nullable":true},"isShared":{"type":"boolean"},"isHandled":{"type":"boolean","description":"Já lido"},"readAt":{"type":"string","nullable":true,"description":"Data da leitura"},"readBy":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Quem leu"},"createdBy":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"imageUrl":{"type":"string","nullable":true}},"required":["id","name","imageUrl"],"additionalProperties":false,"nullable":true,"description":"Quem escreveu o andamento manual. Null nos antigos: só authorName"},"createdAt":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name","color"],"additionalProperties":false}}},"required":["id","lawSuitId","processNumber","parties","externalId","source","kind","courtAcronym","courtDegree","instance","lawSuitInstanceId","movementDate","rawDate","content","authorName","isShared","isHandled","readAt","readBy","createdBy","createdAt","tags"],"additionalProperties":false},"description":"Andamentos"},"groups":{"type":"array","items":{"type":"object","properties":{"processNumber":{"type":"string"},"lawSuitId":{"type":"string","nullable":true},"parties":{"type":"string","nullable":true,"description":"Partes do processo: \"Cliente x Requerida\""},"latestAt":{"type":"string","description":"Andamento mais recente do processo na lista"},"totalCount":{"type":"integer","description":"Andamentos do processo com os filtros"},"unreadCount":{"type":"integer","description":"Não lidos do processo com os filtros"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"lawSuitId":{"type":"string","nullable":true},"processNumber":{"type":"string"},"parties":{"type":"string","nullable":true,"description":"Partes do processo: \"Cliente x Requerida\""},"externalId":{"type":"string"},"source":{"type":"string","enum":["MANUAL","COURT_LAWSUIT_INSTANCE","COURT_LAWSUIT_ROW","SECRET","INSS"]},"kind":{"type":"string","nullable":true},"courtAcronym":{"type":"string","nullable":true},"courtDegree":{"type":"number","nullable":true},"instance":{"type":"number","nullable":true},"lawSuitInstanceId":{"type":"string","nullable":true},"movementDate":{"type":"string","nullable":true},"rawDate":{"type":"string","nullable":true},"content":{"type":"string"},"authorName":{"type":"string","nullable":true},"metadata":{"nullable":true},"isShared":{"type":"boolean"},"isHandled":{"type":"boolean","description":"Já lido"},"readAt":{"type":"string","nullable":true,"description":"Data da leitura"},"readBy":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Quem leu"},"createdBy":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"imageUrl":{"type":"string","nullable":true}},"required":["id","name","imageUrl"],"additionalProperties":false,"nullable":true,"description":"Quem escreveu o andamento manual. Null nos antigos: só authorName"},"createdAt":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string","nullable":true}},"required":["id","name","color"],"additionalProperties":false}}},"required":["id","lawSuitId","processNumber","parties","externalId","source","kind","courtAcronym","courtDegree","instance","lawSuitInstanceId","movementDate","rawDate","content","authorName","isShared","isHandled","readAt","readBy","createdBy","createdAt","tags"],"additionalProperties":false},"description":"Os andamentos do processo, até 20, na ordem pedida"}},"required":["processNumber","lawSuitId","parties","latestAt","totalCount","unreadCount","items"],"additionalProperties":false},"nullable":true,"description":"Só com grouped=true: processos paginados, cada um com os seus andamentos"},"sum":{"type":"object","properties":{"total":{"type":"number","description":"Total"},"read":{"type":"number","description":"Lidos"},"unread":{"type":"number","description":"Não lidos"},"readInPeriod":{"type":"number","description":"Lidos dentro do intervalo de readStart/readEnd. Ausente sem o filtro"}},"required":["total","read","unread"],"additionalProperties":false,"description":"Totais"},"totalPages":{"type":"number","description":"Total de páginas"},"totalResults":{"type":"number","description":"Total de registros"},"canHandle":{"type":"boolean","description":"Pode marcar como lido: Gestor ou quem está em \"Tratar andamentos\""}},"required":["data","sum","totalPages","totalResults","canHandle"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/movements/count":{"get":{"summary":"Andamentos novos não lidos","tags":["Movements"],"description":"Quantos andamentos novos do escritório ainda não foram lidos. Aceita JWT ou o header `x-juridiq-api-key`; o usuário da chave precisa ver processos (403 sem a permissão).","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"number","description":"Não lidos"}},"required":["count"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/templates":{"get":{"operationId":"listTaskBoardTemplates","summary":"Listar templates curados de pastas e quadros","tags":["Task Board"],"description":"Catálogo de templates de pasta e quadro. Use o `id` de cada template em POST /task-board/templates/apply.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string","enum":["board","folder"]},"name":{"type":"string","minLength":1},"description":{"type":"string"},"boards":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"columns":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"hexColor":{"type":"string","pattern":"^#[0-9a-f]{6}$"},"typeSheetStatus":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"]},"isDoneColumn":{"type":"boolean"}},"required":["name","hexColor","typeSheetStatus","isDoneColumn"],"additionalProperties":false},"minItems":1}},"required":["name","columns"],"additionalProperties":false},"minItems":1}},"required":["id","type","name","description","boards"],"additionalProperties":false}}},"required":["id","name","templates"],"additionalProperties":false}}},"required":["categories"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/templates/apply":{"post":{"operationId":"applyTaskBoardTemplate","summary":"Criar estrutura de um template de forma atômica","tags":["Task Board"],"description":"Cria pasta e quadros a partir de um template. Templates simples exigem folderId ou newFolderName. Templates avançados criam a pasta do catálogo, com o nome de newFolderName se vier, e recusam folderId. boards cria só os quadros escolhidos, com nome editado opcional. O criador entra sempre nos responsáveis.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"description":"ID do template. Obtenha em GET /task-board/templates"},"responsiblesId":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"IDs dos responsáveis da pasta e dos quadros criados"},"folderId":{"type":"string","format":"uuid","description":"Pasta existente (templates simples). Não use junto com newFolderName"},"newFolderName":{"type":"string","minLength":1,"description":"Cria pasta nova (templates simples) ou dá nome à pasta de um template avançado. Não use junto com folderId"},"boards":{"type":"array","items":{"type":"object","properties":{"sourceName":{"type":"string","minLength":1,"maxLength":60,"description":"Nome do quadro no catálogo"},"name":{"type":"string","description":"Nome editado do quadro, de 1 a 60 caracteres"}},"required":["sourceName"],"additionalProperties":false},"description":"Subconjunto dos quadros do template, criado na ordem do catálogo. Ausente = todos"}},"required":["templateId"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"folder":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"index":{"type":"integer"},"created":{"type":"boolean"}},"required":["id","name","index","created"],"additionalProperties":false},"boards":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"index":{"type":"integer"}},"required":["id","name","index"],"additionalProperties":false}}},"required":["folder","boards"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/list-folders":{"get":{"operationId":"listTaskBoardFolders","summary":"Listar pastas e quadros do kanban","tags":["Task Board"],"description":"Lista pastas (folders) do kanban de tarefas do escritório, com os quadros (boards) de cada pasta. Use o `id` da pasta em POST /task-board/create-board (`folderBoardId`) e o `id` do quadro em PATCH /task-board/update-board/:id. Inclui pastas arquivadas.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"folders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da pasta kanban"},"name":{"type":"string","description":"Nome da pasta"},"hexColor":{"type":"string","nullable":true,"description":"Cor hexadecimal"},"index":{"type":"integer","description":"Ordem da pasta no escritório"},"isArchived":{"type":"boolean","description":"Pasta arquivada"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"responsibles":{"type":"array","items":{"type":"object","properties":{"responsible":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"imageUrl":{"type":"string","nullable":true}},"required":["id","name"],"additionalProperties":false}},"required":["responsible"],"additionalProperties":false}},"taskKanbanBoards":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do quadro kanban"},"name":{"type":"string","description":"Nome do quadro"},"hexColor":{"type":"string","nullable":true},"index":{"type":"integer"},"responsibles":{"type":"array","items":{"type":"object","properties":{"responsible":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["responsible"],"additionalProperties":false}}},"required":["id","name"],"additionalProperties":true}}},"required":["id","name"],"additionalProperties":true}}},"required":["folders"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/create-folder":{"post":{"operationId":"createTaskBoardFolder","summary":"Criar pasta do kanban","tags":["Task Board"],"description":"Cria uma pasta (folder) de quadros de tarefas. A pasta agrupa quadros. Depois use POST /task-board/create-board com `folderBoardId` igual ao `id` devolvido aqui.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome da pasta"},"hexColor":{"type":"string","description":"Cor hexadecimal, ex. #03a1fc"},"responsiblesId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos usuários responsáveis pela pasta"}},"required":["name"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da pasta kanban"},"name":{"type":"string","description":"Nome da pasta"},"hexColor":{"type":"string","nullable":true,"description":"Cor hexadecimal"},"index":{"type":"integer","description":"Ordem da pasta no escritório"},"isArchived":{"type":"boolean","description":"Pasta arquivada"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"responsibles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do usuário responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"}},"required":["id","name"],"additionalProperties":false}}},"required":["id","name"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/update-folder/{id}":{"patch":{"operationId":"updateTaskBoardFolder","summary":"Editar pasta do kanban","tags":["Task Board"],"description":"Edita nome, cor, responsáveis ou arquiva uma pasta (folder) de quadros. Não remove responsável que ainda for responsável de algum quadro desta pasta.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome da pasta"},"responsiblesId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs dos responsáveis. Quem for responsável de um quadro da pasta não pode ser removido"},"hexColor":{"type":"string","description":"Cor hexadecimal"},"isArchived":{"type":"boolean","description":"true arquiva a pasta"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da pasta kanban (`task_kanban_folder`)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID da pasta kanban"},"name":{"type":"string","description":"Nome da pasta"},"hexColor":{"type":"string","nullable":true,"description":"Cor hexadecimal"},"index":{"type":"integer","description":"Ordem da pasta no escritório"},"isArchived":{"type":"boolean","description":"Pasta arquivada"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"responsibles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do usuário responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"}},"required":["id","name"],"additionalProperties":false}}},"required":["id","name"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/reorder-folders":{"patch":{"operationId":"reorderTaskBoardFolders","summary":"Reordenar pastas do kanban","tags":["Task Board"],"description":"Define a ordem das pastas (folders) ativas. `folderIds` deve listar as pastas na ordem desejada, sem duplicatas.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"folderIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs das pastas ativas na ordem desejada"}},"required":["folderIds"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/delete-folder/{id}":{"delete":{"operationId":"deleteTaskBoardFolder","summary":"Excluir pasta do kanban","tags":["Task Board"],"description":"Exclui uma pasta (folder). Sem saveItems, apaga a pasta e os quadros (cascade nas tarefas). Com saveItems=true e saveFolderId, move os quadros para a pasta destino.","parameters":[{"schema":{"type":"boolean"},"in":"query","name":"saveItems","required":false,"description":"true move os quadros para outra pasta em vez de apagá-los"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"saveFolderId","required":false,"description":"ID da pasta destino. Obrigatório quando saveItems=true"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da pasta kanban (`task_kanban_folder`)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/list-column-with-tasks-by-board":{"post":{"operationId":"listColumnWithTasksByBoard","summary":"Listar colunas com tarefas por quadro","tags":["Task Board"],"description":"Retorna as colunas de um quadro kanban com as tarefas paginadas e filtros. Use para ver o conteúdo do quadro depois de criar ou editar pasta/quadro/coluna. Com filters.overdue true, só as tarefas atrasadas (prazo fatal vencido e fora da coluna de concluídas); com taskType subtask, as subtarefas das tarefas atrasadas, qualquer que seja o prazo da subtarefa. Cada tarefa traz commentsCount (comentários da tarefa, sem as respostas), customFields ([{ fieldId, name, type, value }] só dos campos não arquivados com valor gravado na tarefa, na ordem de criação do campo; o valor pode vir vazio) e timeTracked, sobre os apontamentos do usuário autenticado (com chave de API, o dono da chave) que não estão cancelados: null se nenhum passou por IN_PROGRESS; senão { seconds, runningSince }, em que runningSince é o início do intervalo IN_PROGRESS aberto mais antigo (null se parado) e seconds soma os outros intervalos IN_PROGRESS: os encerrados e, se houver mais de um aberto, os demais até o momento da resposta (pausas, apontamentos cancelados e o intervalo de runningSince não entram). Itens de subtarefa não trazem esses três campos.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"boardId":{"type":"string","format":"uuid","description":"ID do quadro kanban. Obtenha em GET /task-board/list-folders"},"columnId":{"type":"string","format":"uuid","description":"Se informado, lista só esta coluna"},"page":{"type":"integer","default":1,"description":"Página. Começa em 1","exclusiveMinimum":0},"filters":{"type":"object","properties":{"title":{"type":"string","description":"Busca no título da tarefa"},"titleScope":{"type":"string","enum":["all","task","subtask"],"description":"Onde buscar o título: tarefa e subtarefa (padrão), só tarefa ou só subtarefa"},"responsible":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"ID(s) de responsável"},"createdBy":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"ID(s) de usuário gravado como dono da tarefa na criação (ownerId); soma aos outros filtros. Com taskType subtask, vale o dono da tarefa-mãe (subtarefa não tem dono próprio). Tarefa sem dono (ex.: criada pela automação de publicação) não entra. Para o que uma automação criou, use workflowId."},"priority":{"anyOf":[{"type":"string","enum":["Alta","Média","Baixa"]},{"type":"array","items":{"type":"string","enum":["Alta","Média","Baixa"]}}],"description":"Prioridade"},"processNumber":{"type":"string","description":"Número do processo"},"lawSuitId":{"type":"string","description":"ID do processo"},"workflowId":{"type":"string"},"workflowInstanceId":{"type":"string"},"workflowMatch":{"type":"string","enum":["ANY","CREATED"],"description":"Com workflowId: ANY (tudo com vínculo com a automação) ou CREATED (padrão, só o que ela criou)"},"taskTemplateId":{"type":"string"},"personId":{"type":"string","format":"uuid","description":"ID da pessoa vinculada"},"personName":{"type":"string","description":"Nome da pessoa vinculada"},"orderByField":{"type":"string"},"orderBy":{"type":"string","enum":["asc","desc"]},"dateMethod":{"type":"string","enum":["all","initialDate","finalDate","completedAt","subtaskFinalDate"]},"start":{"type":"string"},"end":{"type":"string"},"tag":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"ID(s) de tag"},"points":{"type":"number"},"taskKanbanColumnIds":{"anyOf":[{"type":"string","format":"uuid"},{"type":"array","items":{"type":"string","format":"uuid"}}],"description":"Restringe a estas colunas"},"showCompleted":{"type":"boolean","nullable":true},"overdue":{"type":"boolean","nullable":true,"description":"true lista só as atrasadas: fora da coluna de concluídas e com prazo fatal (dia yyyy-MM-dd de finalDate) antes de hoje em São Paulo. Tarefa sem prazo nunca entra; com showCompleted true o resultado é vazio. Com taskType subtask, vale para a tarefa principal: lista as subtarefas das tarefas atrasadas, qualquer que seja o prazo da subtarefa"},"ignoreOtherSubtasks":{"type":"boolean","nullable":true,"description":"Com responsible, retorna só subtarefas desses responsáveis"},"taskType":{"type":"string","enum":["all","task","subtask"],"description":"all/task listam tarefas principais; subtask lista as subtarefas delas"},"customFields":{"type":"array","items":{},"description":"Filtros por campo personalizado: [{ fieldId, value } | { fieldId, from, to }] (datas)"}},"additionalProperties":false,"default":{}}},"required":["boardId"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/create-board":{"post":{"operationId":"createTaskBoard","summary":"Criar quadro kanban","tags":["Task Board"],"description":"Cria um quadro (board) dentro de uma pasta. O body usa `folderBoardId` (ID da pasta). O quadro nasce com as colunas Pendente, Em progresso e Concluída. Responsáveis do quadro precisam já ser responsáveis da pasta.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome do quadro"},"responsiblesId":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"string","format":"uuid"}],"description":"IDs dos responsáveis. Precisam já ser responsáveis da pasta"},"hexColor":{"type":"string","description":"Cor hexadecimal, ex. #03a1fc"},"folderBoardId":{"type":"string","format":"uuid","description":"ID da pasta (`task_kanban_folder`). Obtenha em GET /task-board/list-folders"}},"required":["name","folderBoardId"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do quadro kanban"},"name":{"type":"string","description":"Nome do quadro"},"hexColor":{"type":"string","nullable":true,"description":"Cor hexadecimal"},"folderId":{"type":"string","format":"uuid","description":"ID da pasta do quadro"},"isArchived":{"type":"boolean","description":"Quadro arquivado"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"responsibles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do usuário responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"}},"required":["id","name"],"additionalProperties":false}}},"required":["id","name"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/update-board/{id}":{"patch":{"operationId":"updateTaskBoard","summary":"Editar quadro kanban","tags":["Task Board"],"description":"Edita nome, cor, responsáveis, pasta (`folderId`) ou arquiva um quadro (board). Obtenha o ID em GET /task-board/list-folders ou GET /task-board/show-folder-board-column.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome do quadro"},"hexColor":{"type":"string","description":"Cor hexadecimal"},"responsiblesId":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"string","format":"uuid"}],"description":"IDs dos responsáveis. Novos responsáveis precisam ser da pasta"},"folderId":{"type":"string","format":"uuid","description":"ID da pasta destino, para mover o quadro"},"isArchived":{"type":"boolean","description":"true arquiva o quadro"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do quadro kanban (`task_kanban_boards`)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do quadro kanban"},"name":{"type":"string","description":"Nome do quadro"},"hexColor":{"type":"string","nullable":true,"description":"Cor hexadecimal"},"folderId":{"type":"string","format":"uuid","description":"ID da pasta do quadro"},"isArchived":{"type":"boolean","description":"Quadro arquivado"},"createdAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"updatedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"responsibles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID do usuário responsável"},"name":{"type":"string","description":"Nome do responsável"},"imageUrl":{"type":"string","nullable":true,"description":"URL da foto"}},"required":["id","name"],"additionalProperties":false}}},"required":["id","name"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/reorder-boards":{"patch":{"operationId":"reorderTaskBoards","summary":"Reordenar quadros do kanban","tags":["Task Board"],"description":"Define a ordem dos quadros (boards) ativos de uma pasta. `boardIds` na ordem desejada, todos da mesma pasta.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"folderId":{"type":"string","format":"uuid","description":"ID da pasta cujos quadros serão reordenados"},"boardIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs dos quadros ativos da pasta na ordem desejada"}},"required":["folderId","boardIds"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/delete-board/{id}":{"delete":{"operationId":"deleteTaskBoard","summary":"Excluir quadro kanban","tags":["Task Board"],"description":"Exclui um quadro (board). Sem saveItems, apaga o quadro e as tarefas. Com saveItems=true e saveBoardId, move as colunas para o quadro destino.","parameters":[{"schema":{"type":"boolean"},"in":"query","name":"saveItems","required":false,"description":"true move as colunas e tarefas para outro quadro em vez de apagá-las"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"saveBoardId","required":false,"description":"ID do quadro destino. Obrigatório quando saveItems=true"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do quadro kanban (`task_kanban_boards`)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/create-column":{"post":{"operationId":"createTaskBoardColumn","summary":"Criar coluna do kanban","tags":["Task Board"],"description":"Cria uma coluna em um quadro (board). `boardId` é o ID do quadro. Colunas formam uma cadeia via `nextColumnId`. Use isDoneColumn para coluna de conclusão.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome da coluna"},"boardId":{"type":"string","format":"uuid","description":"ID do quadro (`task_kanban_boards`). Obtenha em GET /task-board/list-folders"},"hexColor":{"type":"string","description":"Cor hexadecimal, ex. #4B5563"},"isArchived":{"type":"boolean","description":"true cria a coluna já arquivada"},"nextColumnId":{"type":"string","format":"uuid","nullable":true,"description":"ID da próxima coluna na cadeia. Null se for a última"},"isDoneColumn":{"type":"boolean","description":"true marca como coluna de conclusão"},"archivesItemsOnEntry":{"type":"boolean","description":"true arquiva a tarefa ao entrar nesta coluna"},"typeSheetStatus":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED","CANCELLED"],"description":"Status de timesheet associado à coluna"}},"required":["name","boardId"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/delete-column/{id}":{"delete":{"operationId":"deleteTaskBoardColumn","summary":"Excluir coluna do kanban","tags":["Task Board"],"description":"Exclui uma coluna do quadro. Sem saveItems, apaga a coluna e as tarefas nela. Com saveItems=true e saveColumnId, move as tarefas para a coluna destino.","parameters":[{"schema":{"type":"boolean"},"in":"query","name":"saveItems","required":false,"description":"true move as tarefas para outra coluna em vez de apagá-las"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"saveColumnId","required":false,"description":"ID da coluna destino. Obrigatório quando saveItems=true"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da coluna kanban (`task_kanban_columns`)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/update-column/{id}":{"patch":{"operationId":"updateTaskBoardColumn","summary":"Editar coluna do kanban","tags":["Task Board"],"description":"Edita nome, cor, ordem (`nextColumnId`), arquivamento ou status de uma coluna do quadro. Obtenha o ID em GET /task-board/show-folder-board-column.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome da coluna"},"hexColor":{"type":"string","description":"Cor hexadecimal"},"isArchived":{"type":"boolean","description":"true arquiva a coluna"},"isDoneColumn":{"type":"boolean","description":"true marca como coluna de conclusão"},"archivesItemsOnEntry":{"type":"boolean","description":"true arquiva a tarefa ao entrar nesta coluna"},"isLastColumn":{"type":"boolean","description":"true marca como última coluna da cadeia"},"nextColumnId":{"type":"string","format":"uuid","description":"ID da próxima coluna na cadeia"},"isFirstColumn":{"type":"boolean","description":"true marca como primeira coluna da cadeia"},"taskKanbanBoardId":{"type":"string","format":"uuid","description":"ID do quadro, para mover a coluna"},"typeSheetStatus":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED","CANCELLED"],"description":"Status de timesheet associado à coluna"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID da coluna kanban (`task_kanban_columns`)"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/show-folder-board-column":{"get":{"operationId":"showFolderBoardColumn","summary":"Exibir pastas, quadros e colunas ativas","tags":["Task Board"],"description":"Árvore ativa pasta → quadro → coluna do kanban. Use para descobrir IDs de pasta e quadro antes de editar. Não lista tarefas; para cards use POST /task-board/list-column-with-tasks-by-board ou GET /task.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/task-board/show-archived-folder-board-column":{"get":{"operationId":"showArchivedFolderBoardColumn","summary":"Exibir pastas, quadros e colunas arquivadas","tags":["Task Board"],"description":"Árvore arquivada pasta → quadro → coluna do kanban. Use para achar IDs de itens arquivados antes de desarquivar via PATCH.","security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/time-sheet/":{"get":{"summary":"Listar apontamentos","tags":["TimeSheets"],"description":"Lista paginada: page começa em 1 e, sem limit, vêm todos os registros numa página só. orderByField aceita createdAt, updatedAt, completedAt ou title (padrão createdAt, orderBy desc); outro valor dá 400. Sem a permissão time_sheets.view, quem não é Gestor vê só os próprios apontamentos. personId e lawSuitId incluem os apontamentos que chegam por tarefa, subtarefa, audiência e atendimento, além do vínculo direto. costValue = timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos, ou null sem hourlyRate. startDate e endDate filtram pela data de criação do apontamento, no dia de São Paulo; início depois do fim dá 400. includeSummary=true com personId ou lawSuitId soma o tempo inteiro e o custo de cada apontamento filtrado, deixando de fora os de status atual CANCELLED; sem esse escopo summary não vem.","parameters":[{"schema":{"type":"string"},"in":"query","name":"page","required":false,"description":"Página. Começa em 1"},{"schema":{"type":"string"},"in":"query","name":"limit","required":false,"description":"Itens por página"},{"schema":{"type":"string"},"in":"query","name":"title","required":false,"description":"Filtra por título"},{"schema":{"type":"string","enum":["TASK","AUDIENCE","SUBTASK","GENERAL"]},"in":"query","name":"module","required":false,"description":"Filtra por módulo"},{"schema":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED","FINISHED"]},"in":"query","name":"status","required":false,"description":"Filtra pelo status atual (FINISHED = Concluídos + Cancelados)"},{"schema":{"type":"string"},"in":"query","name":"isDone","required":false,"description":"true ou false"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"userId","required":false,"description":"Filtra por usuário"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"taskId","required":false,"description":"Filtra por tarefa"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"audienceId","required":false,"description":"Filtra por audiência"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"subtaskId","required":false,"description":"Filtra por subtarefa"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"personId","required":false,"description":"Apontamentos da pessoa: vínculo direto, tarefa ou subtarefa em que ela está vinculada, audiência dela ou em que está vinculada e atendimento dela"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"lawSuitId","required":false,"description":"Apontamentos do processo: vínculo direto, tarefa, subtarefa, audiência e atendimento do processo"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc"},{"schema":{"type":"string"},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação"},{"schema":{"type":"string","format":"date"},"in":"query","name":"startDate","required":false,"description":"Criados a partir deste dia, no fuso America/Sao_Paulo. Formato YYYY-MM-DD, de 1900-01-01 a 9999-12-30"},{"schema":{"type":"string","format":"date"},"in":"query","name":"endDate","required":false,"description":"Criados até este dia, no fuso America/Sao_Paulo. Formato YYYY-MM-DD, de 1900-01-01 a 9999-12-30"},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"includeSummary","required":false,"description":"true devolve summary quando vier com personId ou lawSuitId"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do apontamento"},"title":{"type":"string","description":"Título"},"module":{"type":"string","enum":["TASK","AUDIENCE","SUBTASK","GENERAL"],"description":"Módulo"},"isDone":{"type":"boolean","description":"Concluído"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"],"nullable":true,"description":"Status atual"},"officeId":{"type":"string","description":"ID do escritório"},"userId":{"type":"string","nullable":true,"description":"ID do usuário"},"taskId":{"type":"string","nullable":true,"description":"ID da tarefa"},"audienceId":{"type":"string","nullable":true,"description":"ID da audiência"},"subtaskId":{"type":"string","nullable":true,"description":"ID da subtarefa"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa/cliente vinculada"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo vinculado"},"consultingId":{"type":"string","nullable":true,"description":"ID do atendimento vinculado"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome da pessoa"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Pessoa/cliente vinculada"},"lawSuit":{"type":"object","properties":{"id":{"type":"string","description":"ID do processo"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo"}},"required":["id"],"additionalProperties":false,"nullable":true,"description":"Processo vinculado"},"consulting":{"type":"object","properties":{"id":{"type":"string","description":"ID do atendimento"},"subject":{"type":"string","description":"Assunto do atendimento"}},"required":["id","subject"],"additionalProperties":false,"nullable":true,"description":"Atendimento do CRM vinculado"},"estimatedTimeMinutes":{"type":"number","nullable":true,"description":"Tempo estimado (minutos)"},"timeSpentSeconds":{"type":"number","description":"Tempo gasto somando os históricos (segundos)"},"hourlyRate":{"type":"number","nullable":true,"description":"Valor da hora em reais; null quando não informado"},"costValue":{"type":"number","nullable":true,"description":"Custo em reais: timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos; null sem hourlyRate"},"cancelReason":{"type":"string","nullable":true,"description":"Motivo do cancelamento"},"completedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data de finalização (conclusão/cancelamento)"},"vinculateItem":{"type":"object","properties":{"id":{"type":"string","description":"ID do item vinculado"},"name":{"type":"string","description":"Nome/título do item vinculado"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo vinculado"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Item vinculado (tarefa/subtarefa/audiência)"},"thisUserCanEdit":{"type":"boolean","description":"Indica se o usuário da requisição é o dono do apontamento"},"userDetail":{"type":"object","properties":{"name":{"type":"string","description":"Nome do usuário"},"urlImage":{"type":"string","nullable":true,"description":"URL da imagem do usuário"}},"required":["name"],"additionalProperties":false,"nullable":true,"description":"Dados do usuário do apontamento"},"statusHistories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do histórico"},"description":{"type":"string","nullable":true,"description":"Descrição"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"],"description":"Status"},"startedAt":{"type":"string","format":"date-time","description":"Início do status"},"endedAt":{"type":"string","format":"date-time","nullable":true,"description":"Fim do status"},"timeSpent":{"type":"number","nullable":true,"description":"Tempo gasto (segundos)"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"}},"required":["id","status","startedAt","createdAt","updatedAt"],"additionalProperties":false},"description":"Históricos de status"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"}},"required":["id","title","module","isDone","officeId","timeSpentSeconds","createdAt","updatedAt"],"additionalProperties":true},"description":"Lista de apontamentos"},"totalResults":{"type":"number","description":"Total de registros"},"totalPages":{"type":"number","description":"Total de páginas"},"summary":{"type":"object","properties":{"count":{"type":"number","description":"Apontamentos somados, sem cancelados"},"totalSeconds":{"type":"number","description":"Tempo gasto somado, em segundos"},"totalCost":{"type":"number","description":"Custo somado em reais; 0 quando nenhum tem valor da hora"},"countWithoutRate":{"type":"number","description":"Apontamentos somados no tempo e fora do custo, por não terem hourlyRate"},"byUser":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","nullable":true,"description":"ID do responsável; null quando não há"},"userName":{"type":"string","nullable":true,"description":"Nome do responsável; null quando não há"},"count":{"type":"number","description":"Apontamentos somados, sem cancelados"},"totalSeconds":{"type":"number","description":"Tempo gasto somado, em segundos"},"totalCost":{"type":"number","description":"Custo somado em reais; 0 quando nenhum tem valor da hora"}},"required":["userId","userName","count","totalSeconds","totalCost"],"additionalProperties":false},"description":"Totais por responsável, do maior tempo para o menor; empate por nome e id"}},"required":["count","totalSeconds","totalCost","countWithoutRate","byUser"],"additionalProperties":false,"description":"Totais de todos os filtrados, não só da página; só com includeSummary=true e personId ou lawSuitId"}},"required":["data","totalResults","totalPages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}},"post":{"summary":"Criar apontamento de um item existente","tags":["TimeSheets"],"description":"GENERAL exige título e aceita pessoa, processo, atendimento e hourlyRate (valor da hora em reais). Vínculos são checados entre si: atendimento de outra pessoa ou de outro processo e pessoa que não é parte do processo dão 400; atendimento privado de outro dono dá 404 para quem não vê atendimentos privados. TASK, SUBTASK e AUDIENCE exigem o id do item e sincronizam os apontamentos dele, sem vínculos nem hourlyRate. A resposta lista os apontamentos do item; costValue = timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos, ou null sem hourlyRate.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"module":{"type":"string","enum":["TASK","AUDIENCE","SUBTASK","GENERAL"],"description":"Módulo do apontamento"},"id":{"type":"string","format":"uuid","description":"ID da tarefa/subtarefa/audiência (obrigatório, exceto GENERAL)"},"title":{"type":"string","minLength":1,"description":"Título do apontamento (obrigatório para GENERAL)"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"],"description":"Status inicial (apenas GENERAL; padrão PENDING)"},"estimatedTimeMinutes":{"type":"integer","minimum":0,"description":"Tempo previsto em minutos (apenas GENERAL)"},"hourlyRate":{"type":"number","minimum":0,"maximum":1000000,"description":"Valor da hora em reais, de 0 a 1.000.000, com até 2 casas decimais (apenas GENERAL)"},"personId":{"type":"string","format":"uuid","description":"Pessoa/cliente vinculada (apenas GENERAL)"},"lawSuitId":{"type":"string","format":"uuid","description":"Processo vinculado (apenas GENERAL)"},"consultingId":{"type":"string","format":"uuid","description":"Atendimento do CRM vinculado (apenas GENERAL)"}},"required":["module"],"additionalProperties":false,"description":"Cria o apontamento (TimeSheet) de um item já existente"}}},"required":true,"description":"Cria o apontamento (TimeSheet) de um item já existente"},"security":[{"apiKeyAuth":[]}],"responses":{"201":{"description":"Apontamentos criados/relacionados ao item","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do apontamento"},"title":{"type":"string","description":"Título"},"module":{"type":"string","enum":["TASK","AUDIENCE","SUBTASK","GENERAL"],"description":"Módulo"},"isDone":{"type":"boolean","description":"Concluído"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"],"nullable":true,"description":"Status atual"},"officeId":{"type":"string","description":"ID do escritório"},"userId":{"type":"string","nullable":true,"description":"ID do usuário"},"taskId":{"type":"string","nullable":true,"description":"ID da tarefa"},"audienceId":{"type":"string","nullable":true,"description":"ID da audiência"},"subtaskId":{"type":"string","nullable":true,"description":"ID da subtarefa"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa/cliente vinculada"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo vinculado"},"consultingId":{"type":"string","nullable":true,"description":"ID do atendimento vinculado"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome da pessoa"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Pessoa/cliente vinculada"},"lawSuit":{"type":"object","properties":{"id":{"type":"string","description":"ID do processo"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo"}},"required":["id"],"additionalProperties":false,"nullable":true,"description":"Processo vinculado"},"consulting":{"type":"object","properties":{"id":{"type":"string","description":"ID do atendimento"},"subject":{"type":"string","description":"Assunto do atendimento"}},"required":["id","subject"],"additionalProperties":false,"nullable":true,"description":"Atendimento do CRM vinculado"},"estimatedTimeMinutes":{"type":"number","nullable":true,"description":"Tempo estimado (minutos)"},"timeSpentSeconds":{"type":"number","description":"Tempo gasto somando os históricos (segundos)"},"hourlyRate":{"type":"number","nullable":true,"description":"Valor da hora em reais; null quando não informado"},"costValue":{"type":"number","nullable":true,"description":"Custo em reais: timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos; null sem hourlyRate"},"cancelReason":{"type":"string","nullable":true,"description":"Motivo do cancelamento"},"completedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data de finalização (conclusão/cancelamento)"},"vinculateItem":{"type":"object","properties":{"id":{"type":"string","description":"ID do item vinculado"},"name":{"type":"string","description":"Nome/título do item vinculado"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo vinculado"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Item vinculado (tarefa/subtarefa/audiência)"},"thisUserCanEdit":{"type":"boolean","description":"Indica se o usuário da requisição é o dono do apontamento"},"userDetail":{"type":"object","properties":{"name":{"type":"string","description":"Nome do usuário"},"urlImage":{"type":"string","nullable":true,"description":"URL da imagem do usuário"}},"required":["name"],"additionalProperties":false,"nullable":true,"description":"Dados do usuário do apontamento"},"statusHistories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do histórico"},"description":{"type":"string","nullable":true,"description":"Descrição"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"],"description":"Status"},"startedAt":{"type":"string","format":"date-time","description":"Início do status"},"endedAt":{"type":"string","format":"date-time","nullable":true,"description":"Fim do status"},"timeSpent":{"type":"number","nullable":true,"description":"Tempo gasto (segundos)"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"}},"required":["id","status","startedAt","createdAt","updatedAt"],"additionalProperties":false},"description":"Históricos de status"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"}},"required":["id","title","module","isDone","officeId","timeSpentSeconds","createdAt","updatedAt"],"additionalProperties":true},"description":"Apontamentos criados/relacionados ao item"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir apontamentos em lote","tags":["TimeSheets"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs dos apontamentos"}},"required":["ids"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"204":{"description":"Sem conteúdo","content":{"application/json":{"schema":{"enum":["null"],"nullable":true,"description":"Sem conteúdo"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/time-sheet/cancel":{"patch":{"summary":"Cancelar apontamentos em lote","tags":["TimeSheets"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"IDs dos apontamentos"},"cancelReason":{"type":"string","description":"Motivo do cancelamento"}},"required":["ids"],"additionalProperties":false}}},"required":true},"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Resultado do cancelamento em lote","content":{"application/json":{"schema":{"type":"object","properties":{"cancelled":{"type":"number","description":"Quantidade cancelada"}},"required":["cancelled"],"additionalProperties":false,"description":"Resultado do cancelamento em lote"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/time-sheet/report":{"get":{"summary":"Gerar relatório de apontamentos (Excel/PDF)","tags":["TimeSheets"],"description":"Gera Excel ou PDF com até 5000 apontamentos, com a regra de visibilidade da listagem e os filtros desta rota. orderByField aceita createdAt, updatedAt, completedAt ou title (padrão createdAt, orderBy desc); outro valor dá 400. personId e lawSuitId incluem os apontamentos que chegam por tarefa, subtarefa, audiência e atendimento. As colunas Valor da hora e Custo saem em reais; sem hourlyRate saem como —. startDate e endDate filtram pela data de criação do apontamento, no dia de São Paulo; início depois do fim dá 400. Com linhas, os Totais (aba no Excel, bloco no PDF) somam o tempo e o custo das linhas do arquivo por responsável, deixando de fora os de status atual CANCELLED, e avisam quantos estão sem valor da hora e se o filtro passou de 5000.","parameters":[{"schema":{"type":"string","enum":["excel","pdf"]},"in":"query","name":"format","required":true,"description":"Formato do relatório"},{"schema":{"type":"string"},"in":"query","name":"title","required":false,"description":"Filtra por título"},{"schema":{"type":"string","enum":["TASK","AUDIENCE","SUBTASK","GENERAL"]},"in":"query","name":"module","required":false,"description":"Filtra por módulo"},{"schema":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED","FINISHED"]},"in":"query","name":"status","required":false,"description":"Filtra pelo status atual (FINISHED = Concluídos + Cancelados)"},{"schema":{"type":"string"},"in":"query","name":"isDone","required":false,"description":"true ou false"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"userId","required":false,"description":"Filtra por usuário"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"personId","required":false,"description":"Apontamentos da pessoa: vínculo direto, tarefa ou subtarefa em que ela está vinculada, audiência dela ou em que está vinculada e atendimento dela"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"lawSuitId","required":false,"description":"Apontamentos do processo: vínculo direto, tarefa, subtarefa, audiência e atendimento do processo"},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderBy","required":false,"description":"asc ou desc"},{"schema":{"type":"string"},"in":"query","name":"orderByField","required":false,"description":"Campo de ordenação"},{"schema":{"type":"string","format":"date"},"in":"query","name":"startDate","required":false,"description":"Criados a partir deste dia, no fuso America/Sao_Paulo. Formato YYYY-MM-DD, de 1900-01-01 a 9999-12-30"},{"schema":{"type":"string","format":"date"},"in":"query","name":"endDate","required":false,"description":"Criados até este dia, no fuso America/Sao_Paulo. Formato YYYY-MM-DD, de 1900-01-01 a 9999-12-30"}],"security":[{"apiKeyAuth":[]}],"responses":{"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}}}},"/time-sheet/{id}":{"get":{"summary":"Buscar apontamento","tags":["TimeSheets"],"description":"Busca um apontamento do escritório pelo id. costValue = timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos, ou null sem hourlyRate.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do apontamento"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do apontamento"},"title":{"type":"string","description":"Título"},"module":{"type":"string","enum":["TASK","AUDIENCE","SUBTASK","GENERAL"],"description":"Módulo"},"isDone":{"type":"boolean","description":"Concluído"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"],"nullable":true,"description":"Status atual"},"officeId":{"type":"string","description":"ID do escritório"},"userId":{"type":"string","nullable":true,"description":"ID do usuário"},"taskId":{"type":"string","nullable":true,"description":"ID da tarefa"},"audienceId":{"type":"string","nullable":true,"description":"ID da audiência"},"subtaskId":{"type":"string","nullable":true,"description":"ID da subtarefa"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa/cliente vinculada"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo vinculado"},"consultingId":{"type":"string","nullable":true,"description":"ID do atendimento vinculado"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome da pessoa"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Pessoa/cliente vinculada"},"lawSuit":{"type":"object","properties":{"id":{"type":"string","description":"ID do processo"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo"}},"required":["id"],"additionalProperties":false,"nullable":true,"description":"Processo vinculado"},"consulting":{"type":"object","properties":{"id":{"type":"string","description":"ID do atendimento"},"subject":{"type":"string","description":"Assunto do atendimento"}},"required":["id","subject"],"additionalProperties":false,"nullable":true,"description":"Atendimento do CRM vinculado"},"estimatedTimeMinutes":{"type":"number","nullable":true,"description":"Tempo estimado (minutos)"},"timeSpentSeconds":{"type":"number","description":"Tempo gasto somando os históricos (segundos)"},"hourlyRate":{"type":"number","nullable":true,"description":"Valor da hora em reais; null quando não informado"},"costValue":{"type":"number","nullable":true,"description":"Custo em reais: timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos; null sem hourlyRate"},"cancelReason":{"type":"string","nullable":true,"description":"Motivo do cancelamento"},"completedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data de finalização (conclusão/cancelamento)"},"vinculateItem":{"type":"object","properties":{"id":{"type":"string","description":"ID do item vinculado"},"name":{"type":"string","description":"Nome/título do item vinculado"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo vinculado"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Item vinculado (tarefa/subtarefa/audiência)"},"thisUserCanEdit":{"type":"boolean","description":"Indica se o usuário da requisição é o dono do apontamento"},"userDetail":{"type":"object","properties":{"name":{"type":"string","description":"Nome do usuário"},"urlImage":{"type":"string","nullable":true,"description":"URL da imagem do usuário"}},"required":["name"],"additionalProperties":false,"nullable":true,"description":"Dados do usuário do apontamento"},"statusHistories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do histórico"},"description":{"type":"string","nullable":true,"description":"Descrição"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"],"description":"Status"},"startedAt":{"type":"string","format":"date-time","description":"Início do status"},"endedAt":{"type":"string","format":"date-time","nullable":true,"description":"Fim do status"},"timeSpent":{"type":"number","nullable":true,"description":"Tempo gasto (segundos)"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"}},"required":["id","status","startedAt","createdAt","updatedAt"],"additionalProperties":false},"description":"Históricos de status"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"}},"required":["id","title","module","isDone","officeId","timeSpentSeconds","createdAt","updatedAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"patch":{"summary":"Atualizar apontamento","tags":["TimeSheets"],"description":"Só o dono do apontamento ou o Gestor altera. status aplica a transição do cronômetro; personId, lawSuitId e consultingId só valem em GENERAL. Vínculos são checados entre si: atendimento de outra pessoa ou de outro processo e pessoa que não é parte do processo dão 400; atendimento privado de outro dono dá 404 para quem não vê atendimentos privados. hourlyRate vale em qualquer módulo e null remove o valor. Na resposta, costValue = timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos, ou null sem hourlyRate.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"],"description":"Status a ser aplicado pelo front (retomar, pausar, concluir, cancelar ou pendente)"},"title":{"type":"string","minLength":1,"description":"Novo título (apontamentos GERAIS)"},"estimatedTimeMinutes":{"type":"integer","minimum":0,"description":"Tempo previsto em minutos (apontamentos GERAIS)"},"cancelReason":{"type":"string","description":"Motivo do cancelamento"},"hourlyRate":{"type":"number","minimum":0,"maximum":1000000,"nullable":true,"description":"Valor da hora em reais, de 0 a 1.000.000, com até 2 casas decimais (qualquer módulo; null remove o valor)"},"personId":{"type":"string","format":"uuid","nullable":true,"description":"Pessoa/cliente vinculada (apenas GENERAL; null remove o vínculo)"},"lawSuitId":{"type":"string","format":"uuid","nullable":true,"description":"Processo vinculado (apenas GENERAL; null remove o vínculo)"},"consultingId":{"type":"string","format":"uuid","nullable":true,"description":"Atendimento do CRM vinculado (apenas GENERAL; null remove o vínculo)"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do apontamento"}],"security":[{"apiKeyAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID do apontamento"},"title":{"type":"string","description":"Título"},"module":{"type":"string","enum":["TASK","AUDIENCE","SUBTASK","GENERAL"],"description":"Módulo"},"isDone":{"type":"boolean","description":"Concluído"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"],"nullable":true,"description":"Status atual"},"officeId":{"type":"string","description":"ID do escritório"},"userId":{"type":"string","nullable":true,"description":"ID do usuário"},"taskId":{"type":"string","nullable":true,"description":"ID da tarefa"},"audienceId":{"type":"string","nullable":true,"description":"ID da audiência"},"subtaskId":{"type":"string","nullable":true,"description":"ID da subtarefa"},"personId":{"type":"string","nullable":true,"description":"ID da pessoa/cliente vinculada"},"lawSuitId":{"type":"string","nullable":true,"description":"ID do processo vinculado"},"consultingId":{"type":"string","nullable":true,"description":"ID do atendimento vinculado"},"person":{"type":"object","properties":{"id":{"type":"string","description":"ID da pessoa"},"name":{"type":"string","description":"Nome da pessoa"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Pessoa/cliente vinculada"},"lawSuit":{"type":"object","properties":{"id":{"type":"string","description":"ID do processo"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo"}},"required":["id"],"additionalProperties":false,"nullable":true,"description":"Processo vinculado"},"consulting":{"type":"object","properties":{"id":{"type":"string","description":"ID do atendimento"},"subject":{"type":"string","description":"Assunto do atendimento"}},"required":["id","subject"],"additionalProperties":false,"nullable":true,"description":"Atendimento do CRM vinculado"},"estimatedTimeMinutes":{"type":"number","nullable":true,"description":"Tempo estimado (minutos)"},"timeSpentSeconds":{"type":"number","description":"Tempo gasto somando os históricos (segundos)"},"hourlyRate":{"type":"number","nullable":true,"description":"Valor da hora em reais; null quando não informado"},"costValue":{"type":"number","nullable":true,"description":"Custo em reais: timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos; null sem hourlyRate"},"cancelReason":{"type":"string","nullable":true,"description":"Motivo do cancelamento"},"completedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data de finalização (conclusão/cancelamento)"},"vinculateItem":{"type":"object","properties":{"id":{"type":"string","description":"ID do item vinculado"},"name":{"type":"string","description":"Nome/título do item vinculado"},"processNumber":{"type":"string","nullable":true,"description":"Número do processo vinculado"}},"required":["id","name"],"additionalProperties":false,"nullable":true,"description":"Item vinculado (tarefa/subtarefa/audiência)"},"thisUserCanEdit":{"type":"boolean","description":"Indica se o usuário da requisição é o dono do apontamento"},"userDetail":{"type":"object","properties":{"name":{"type":"string","description":"Nome do usuário"},"urlImage":{"type":"string","nullable":true,"description":"URL da imagem do usuário"}},"required":["name"],"additionalProperties":false,"nullable":true,"description":"Dados do usuário do apontamento"},"statusHistories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do histórico"},"description":{"type":"string","nullable":true,"description":"Descrição"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"],"description":"Status"},"startedAt":{"type":"string","format":"date-time","description":"Início do status"},"endedAt":{"type":"string","format":"date-time","nullable":true,"description":"Fim do status"},"timeSpent":{"type":"number","nullable":true,"description":"Tempo gasto (segundos)"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"}},"required":["id","status","startedAt","createdAt","updatedAt"],"additionalProperties":false},"description":"Históricos de status"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","description":"Data de atualização"}},"required":["id","title","module","isDone","officeId","timeSpentSeconds","createdAt","updatedAt"],"additionalProperties":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"issues":{}},"required":["message"],"additionalProperties":false},{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}},"delete":{"summary":"Excluir apontamento","tags":["TimeSheets"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"ID do apontamento"}],"security":[{"apiKeyAuth":[]}],"responses":{"204":{"description":"Sem conteúdo","content":{"application/json":{"schema":{"enum":["null"],"nullable":true,"description":"Sem conteúdo"}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}}}},"/workflow/":{"get":{"summary":"List workflows","tags":["Workflows"],"parameters":[{"schema":{"type":"array","items":{"type":"string","enum":["FULL","TASK_FLOW","RECURRING","AUDIENCE_REMINDER","BIRTHDAY","EVENT_REMINDER","PUBLICATION","MOVEMENT"]}},"in":"query","name":"variant","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workflows":{"type":"array"}},"required":["workflows"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]},"post":{"summary":"Create workflow","tags":["Workflows"],"description":"Cria uma automação. Via API key fica sempre pausada: o usuário revisa e ativa no módulo de Automações. Formato completo, gatilhos, ações e variáveis {{...}} em GET /workflow/catalog.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome da automação"},"description":{"type":"string","maxLength":1000,"nullable":true,"description":"Descrição livre"},"isActive":{"type":"boolean","description":"Ignorado para API key/IA: a automação sempre fica pausada até o usuário ativar na tela"},"variant":{"type":"string","enum":["FULL","TASK_FLOW","RECURRING","AUDIENCE_REMINDER","BIRTHDAY","EVENT_REMINDER","PUBLICATION","MOVEMENT"],"description":"Tela que edita o fluxo. Use FULL (editor completo) para automações novas"},"trigger":{"type":"string","enum":["MANUAL_START","ON_SCHEDULE","ON_PUBLICATION_CREATED","ON_CRM_CREATED","ON_TASK_CREATED","ON_EVENT_CREATED","ON_AUDIENCE_CREATED","ON_FINANCIAL_CREATED","ON_MOVEMENT_CREATED","ON_SIGNATURE_SIGNED","ON_DOCUMENT_CREATED","ON_LAWSUIT_CREATED","ON_PERSON_CREATED","ON_TASK_COLUMN_ENTERED","ON_CRM_COLUMN_ENTERED","ON_STATE_CHANGED","ON_DATE_APPROACHING"],"description":"Gatilho; o mesmo do passo type \"trigger\" em content"},"triggerData":{"type":"object","properties":{"keywords":{"type":"array","items":{"type":"string","minLength":1}},"funnelId":{"type":"string"},"columnId":{"type":"string"},"stateRule":{"type":"object","properties":{"entityType":{"type":"string","enum":["TASK","CONSULTING","TRANSACTION"]},"state":{"type":"string","minLength":1},"op":{"type":"string","enum":["EQ","NEQ"],"default":"EQ"},"value":{"type":"string","minLength":1}},"required":["entityType","state","value"],"additionalProperties":false},"dateTrigger":{"type":"object","properties":{"target":{"type":"string","enum":["TASK_FINAL","TASK_INITIAL","EVENT","AUDIENCE","TRANSACTION_DUE"]},"daysBefore":{"type":"integer","minimum":0,"maximum":365},"businessDays":{"type":"boolean"}},"required":["target","daysBefore"],"additionalProperties":false},"requireAllKeywords":{"type":"boolean"},"athenaAnalysis":{"type":"object","properties":{"enabled":{"type":"boolean"},"prompt":{"type":"string"}},"required":["enabled","prompt"],"additionalProperties":false},"schedule":{"type":"object","properties":{"frequency":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","EVERY_N_DAYS","EVERY_N_HOURS"]},"time":{"type":"string","pattern":"^\\d{2}:\\d{2}$"},"weekday":{"type":"integer","minimum":0,"maximum":6},"monthDay":{"type":"integer","minimum":1,"maximum":31},"interval":{"type":"integer","minimum":1,"maximum":365},"timezone":{"type":"string","minLength":1},"ignoreWeekdays":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"ignoreHours":{"type":"array","items":{"type":"integer","minimum":0,"maximum":23}},"minute":{"anyOf":[{"type":"number","enum":[0]},{"type":"number","enum":[15]},{"type":"number","enum":[30]},{"type":"number","enum":[45]}]},"periodInterval":{"type":"integer","minimum":1,"maximum":365},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"endDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["frequency"],"additionalProperties":false},"startLinks":{"type":"object","properties":{"lawSuit":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED"]},"person":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED","LAWSUIT"]},"responsibles":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED"]}},"additionalProperties":false},"startItems":{"type":"array","items":{"type":"object","properties":{"module":{"type":"string","enum":["LAWSUIT","PERSON","TASK","CONSULTING","TRANSACTION","EVENT","AUDIENCE","USER"]},"required":{"type":"boolean","default":false},"includeParties":{"type":"boolean"}},"required":["module"],"additionalProperties":false}},"createLawsuitIfMissing":{"type":"boolean"}},"additionalProperties":false,"description":"Dados do gatilho. Formato completo, gatilhos, ações e variáveis {{...}} em GET /workflow/catalog."},"content":{"type":"object","properties":{"steps":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1},"nextStepId":{"type":"string","nullable":true},"nextStepIds":{"type":"array","items":{"type":"string"}},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"requiresPreviousComplete":{"type":"boolean"},"dependsOnStepId":{"type":"string","nullable":true},"delay":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"maximum":8760},"unit":{"type":"string","enum":["MINUTES","HOURS","DAYS"]}},"required":["amount","unit"],"additionalProperties":false,"nullable":true},"manualRelease":{"type":"boolean"},"type":{"type":"string","enum":["trigger"]},"trigger":{"type":"string","enum":["MANUAL_START","ON_SCHEDULE","ON_PUBLICATION_CREATED","ON_CRM_CREATED","ON_TASK_CREATED","ON_EVENT_CREATED","ON_AUDIENCE_CREATED","ON_FINANCIAL_CREATED","ON_MOVEMENT_CREATED","ON_SIGNATURE_SIGNED","ON_DOCUMENT_CREATED","ON_LAWSUIT_CREATED","ON_PERSON_CREATED","ON_TASK_COLUMN_ENTERED","ON_CRM_COLUMN_ENTERED","ON_STATE_CHANGED","ON_DATE_APPROACHING"]},"triggerData":{"type":"object","properties":{"keywords":{"type":"array","items":{"type":"string","minLength":1}},"funnelId":{"type":"string"},"columnId":{"type":"string"},"stateRule":{"type":"object","properties":{"entityType":{"type":"string","enum":["TASK","CONSULTING","TRANSACTION"]},"state":{"type":"string","minLength":1},"op":{"type":"string","enum":["EQ","NEQ"],"default":"EQ"},"value":{"type":"string","minLength":1}},"required":["entityType","state","value"],"additionalProperties":false},"dateTrigger":{"type":"object","properties":{"target":{"type":"string","enum":["TASK_FINAL","TASK_INITIAL","EVENT","AUDIENCE","TRANSACTION_DUE"]},"daysBefore":{"type":"integer","minimum":0,"maximum":365},"businessDays":{"type":"boolean"}},"required":["target","daysBefore"],"additionalProperties":false},"requireAllKeywords":{"type":"boolean"},"athenaAnalysis":{"type":"object","properties":{"enabled":{"type":"boolean"},"prompt":{"type":"string"}},"required":["enabled","prompt"],"additionalProperties":false},"schedule":{"type":"object","properties":{"frequency":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","EVERY_N_DAYS","EVERY_N_HOURS"]},"time":{"type":"string","pattern":"^\\d{2}:\\d{2}$"},"weekday":{"type":"integer","minimum":0,"maximum":6},"monthDay":{"type":"integer","minimum":1,"maximum":31},"interval":{"type":"integer","minimum":1,"maximum":365},"timezone":{"type":"string","minLength":1},"ignoreWeekdays":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"ignoreHours":{"type":"array","items":{"type":"integer","minimum":0,"maximum":23}},"minute":{"anyOf":[{"type":"number","enum":[0]},{"type":"number","enum":[15]},{"type":"number","enum":[30]},{"type":"number","enum":[45]}]},"periodInterval":{"type":"integer","minimum":1,"maximum":365},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"endDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["frequency"],"additionalProperties":false},"startLinks":{"type":"object","properties":{"lawSuit":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED"]},"person":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED","LAWSUIT"]},"responsibles":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED"]}},"additionalProperties":false},"startItems":{"type":"array","items":{"type":"object","properties":{"module":{"type":"string","enum":["LAWSUIT","PERSON","TASK","CONSULTING","TRANSACTION","EVENT","AUDIENCE","USER"]},"required":{"type":"boolean","default":false},"includeParties":{"type":"boolean"}},"required":["module"],"additionalProperties":false}},"createLawsuitIfMissing":{"type":"boolean"}},"additionalProperties":false}},"required":["id","type","trigger"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1},"nextStepId":{"type":"string","nullable":true},"nextStepIds":{"type":"array","items":{"type":"string"}},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"requiresPreviousComplete":{"type":"boolean"},"dependsOnStepId":{"type":"string","nullable":true},"delay":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"maximum":8760},"unit":{"type":"string","enum":["MINUTES","HOURS","DAYS"]}},"required":["amount","unit"],"additionalProperties":false,"nullable":true},"manualRelease":{"type":"boolean"},"type":{"type":"string","enum":["action"]},"action":{"type":"string","enum":["CREATE","APPROVE","ALERT","MANAGE","WEBHOOK","JURICHAT_MESSAGE","CREATE_TASK","CREATE_EVENT","CREATE_AUDIENCE","CREATE_CONSULTING","CREATE_TRANSACTION","UPDATE_CONSULTING_COLUMN","CREATE_SIGNATURE","CREATE_DOCUMENT","CREATE_ALERT"]},"targetModule":{"type":"string","enum":["TASK","EVENT","AUDIENCE","CONSULTING","TRANSACTION","SIGNATURE","DOCUMENT","LAWSUIT"]},"itemCode":{"type":"string","minLength":1},"targetItemCode":{"type":"string","minLength":1},"completeOnCreate":{"type":"boolean","default":false},"config":{"type":"object","additionalProperties":{},"default":{}}},"required":["id","type","action"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1},"nextStepId":{"type":"string","nullable":true},"nextStepIds":{"type":"array","items":{"type":"string"}},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"requiresPreviousComplete":{"type":"boolean"},"dependsOnStepId":{"type":"string","nullable":true},"delay":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"maximum":8760},"unit":{"type":"string","enum":["MINUTES","HOURS","DAYS"]}},"required":["amount","unit"],"additionalProperties":false,"nullable":true},"manualRelease":{"type":"boolean"},"type":{"type":"string","enum":["condition"]},"condition":{"type":"string","enum":["IF_KEYWORD_IN_CONTENT","IF_STEP_OVERDUE","IF_HAS_LAWSUIT","IF_HAS_PERSON","WAIT_FOR_STATE"]},"conditionData":{"type":"object","additionalProperties":{}},"options":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"title":{"type":"string"},"value":{"type":"string"},"nextStepId":{"type":"string","nullable":true},"kind":{"type":"string","enum":["KEYWORD","ATHENA"]},"instruction":{"type":"string","maxLength":2000},"keywords":{"type":"array","items":{"type":"string","maxLength":200},"maxItems":50}},"required":["text","title","value","nextStepId"],"additionalProperties":false}}},"required":["id","type","condition","options"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1},"nextStepId":{"type":"string","nullable":true},"nextStepIds":{"type":"array","items":{"type":"string"}},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"requiresPreviousComplete":{"type":"boolean"},"dependsOnStepId":{"type":"string","nullable":true},"delay":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"maximum":8760},"unit":{"type":"string","enum":["MINUTES","HOURS","DAYS"]}},"required":["amount","unit"],"additionalProperties":false,"nullable":true},"manualRelease":{"type":"boolean"},"type":{"type":"string","enum":["gate"]},"waitForStepId":{"type":"string","minLength":1}},"required":["id","type","waitForStepId"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1},"nextStepId":{"enum":["null"],"nullable":true},"nextStepIds":{"type":"array","items":{"type":"string"}},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"requiresPreviousComplete":{"type":"boolean"},"dependsOnStepId":{"type":"string","nullable":true},"delay":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"maximum":8760},"unit":{"type":"string","enum":["MINUTES","HOURS","DAYS"]}},"required":["amount","unit"],"additionalProperties":false,"nullable":true},"manualRelease":{"type":"boolean"},"type":{"type":"string","enum":["end"]}},"required":["id","type"],"additionalProperties":false}]}},"initialStepId":{"type":"string","nullable":true}},"required":["steps"],"additionalProperties":false,"description":"Grafo de passos: { initialStepId, steps: [...] }. Formato completo, gatilhos, ações e variáveis {{...}} em GET /workflow/catalog."},"tagIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Etiquetas (ids)"}},"required":["name","trigger","content"],"additionalProperties":false}}},"required":true},"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workflow":{}},"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/catalog":{"get":{"summary":"Workflow catalog","tags":["Workflows"],"description":"Tudo o que uma automação aceita: estrutura do content, gatilhos (com as variáveis {{gatilho.*}} de cada um), ações e campos de config, condições, regras de encaixe dos passos, guia de variáveis e um esqueleto de exemplo. Leia antes de criar ou editar.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"catalog":{}},"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/states":{"get":{"summary":"Item states a workflow can wait on","tags":["Workflows"],"description":"Estados de cada módulo usados pelo passo \"Se chegar em\" (condição WAIT_FOR_STATE): { TASK: { label, states: { coluna: { label, kind } } } }.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"states":{}},"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/states/options":{"get":{"summary":"Possible values of an item state (columns, funnel stages, yes/no)","tags":["Workflows"],"parameters":[{"schema":{"type":"string","enum":["TASK","CONSULTING","TRANSACTION"]},"in":"query","name":"entityType","required":true},{"schema":{"type":"string","minLength":1},"in":"query","name":"state","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}},"required":["value","label"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/start-items":{"get":{"summary":"Search items (task, CRM, transaction, event, audience) to start a manual workflow","tags":["Workflows"],"parameters":[{"schema":{"type":"string","enum":["TASK","CONSULTING","TRANSACTION","EVENT","AUDIENCE"]},"in":"query","name":"module","required":true},{"schema":{"type":"string"},"in":"query","name":"search","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"}},"required":["value","label"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/requests":{"get":{"summary":"List open \"create now\" requests (lawsuit/signature) waiting for someone","tags":["Workflows"],"parameters":[{"schema":{"type":"string","enum":["LAWSUIT","SIGNATURE","DOCUMENT"]},"in":"query","name":"module","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"instanceId","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array"}},"required":["items"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/pending":{"get":{"summary":"What the current user has to do in workflows (create requested items, approve steps)","tags":["Workflows"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array"}},"required":["items"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/instances/{id}/steps/{stepId}/link":{"post":{"summary":"Link the item created for a workflow request to its step","tags":["Workflows"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"entityType":{"type":"string","enum":["LAWSUIT","SIGNATURE","DOCUMENT"]},"entityId":{"type":"string","format":"uuid"}},"required":["entityType","entityId"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"stepId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"completed":{"type":"boolean"}},"required":["completed"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/instances":{"get":{"summary":"List workflow instances","tags":["Workflows"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"workflowId","required":false},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"status","required":false},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"variants","required":false},{"schema":{"type":"string","maxLength":200},"in":"query","name":"search","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"cursor","required":false},{"schema":{"type":"number","minimum":1,"maximum":100},"in":"query","name":"limit","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array"},"nextCursor":{"type":"string","nullable":true}},"required":["items","nextCursor"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/instances/{id}":{"get":{"summary":"Get workflow instance detail","tags":["Workflows"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/instances/{id}/cancel":{"post":{"summary":"Cancel workflow instance","tags":["Workflows"],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{"deleteCreatedItems":{"type":"boolean"}},"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{}},"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/instances/{id}/steps/{stepId}/webhook/retry":{"post":{"summary":"Retry a failed workflow webhook step","tags":["Workflows"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true},{"schema":{"type":"string","minLength":1},"in":"path","name":"stepId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"retried":{"type":"boolean"}},"required":["retried"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/instances/{id}/steps/{stepId}/approve":{"post":{"summary":"Approve a workflow step waiting for approval","tags":["Workflows"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true},{"schema":{"type":"string","minLength":1},"in":"path","name":"stepId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"approved":{"type":"boolean"}},"required":["approved"],"additionalProperties":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/{id}":{"get":{"summary":"Get workflow","tags":["Workflows"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workflow":{}},"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}},"security":[{"apiKeyAuth":[]}]},"patch":{"summary":"Update workflow","tags":["Workflows"],"description":"Edita uma automação (campos parciais). Via API key a automação é pausada a cada edição: o usuário revisa e reativa na tela. Formato completo, gatilhos, ações e variáveis {{...}} em GET /workflow/catalog.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Nome da automação"},"description":{"type":"string","maxLength":1000,"nullable":true,"description":"Descrição livre"},"isActive":{"type":"boolean","description":"Ignorado para API key/IA: a automação sempre fica pausada até o usuário ativar na tela"},"variant":{"type":"string","enum":["FULL","TASK_FLOW","RECURRING","AUDIENCE_REMINDER","BIRTHDAY","EVENT_REMINDER","PUBLICATION","MOVEMENT"],"description":"Tela que edita o fluxo. Use FULL (editor completo) para automações novas"},"trigger":{"type":"string","enum":["MANUAL_START","ON_SCHEDULE","ON_PUBLICATION_CREATED","ON_CRM_CREATED","ON_TASK_CREATED","ON_EVENT_CREATED","ON_AUDIENCE_CREATED","ON_FINANCIAL_CREATED","ON_MOVEMENT_CREATED","ON_SIGNATURE_SIGNED","ON_DOCUMENT_CREATED","ON_LAWSUIT_CREATED","ON_PERSON_CREATED","ON_TASK_COLUMN_ENTERED","ON_CRM_COLUMN_ENTERED","ON_STATE_CHANGED","ON_DATE_APPROACHING"],"description":"Gatilho; o mesmo do passo type \"trigger\" em content"},"triggerData":{"type":"object","properties":{"keywords":{"type":"array","items":{"type":"string","minLength":1}},"funnelId":{"type":"string"},"columnId":{"type":"string"},"stateRule":{"type":"object","properties":{"entityType":{"type":"string","enum":["TASK","CONSULTING","TRANSACTION"]},"state":{"type":"string","minLength":1},"op":{"type":"string","enum":["EQ","NEQ"],"default":"EQ"},"value":{"type":"string","minLength":1}},"required":["entityType","state","value"],"additionalProperties":false},"dateTrigger":{"type":"object","properties":{"target":{"type":"string","enum":["TASK_FINAL","TASK_INITIAL","EVENT","AUDIENCE","TRANSACTION_DUE"]},"daysBefore":{"type":"integer","minimum":0,"maximum":365},"businessDays":{"type":"boolean"}},"required":["target","daysBefore"],"additionalProperties":false},"requireAllKeywords":{"type":"boolean"},"athenaAnalysis":{"type":"object","properties":{"enabled":{"type":"boolean"},"prompt":{"type":"string"}},"required":["enabled","prompt"],"additionalProperties":false},"schedule":{"type":"object","properties":{"frequency":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","EVERY_N_DAYS","EVERY_N_HOURS"]},"time":{"type":"string","pattern":"^\\d{2}:\\d{2}$"},"weekday":{"type":"integer","minimum":0,"maximum":6},"monthDay":{"type":"integer","minimum":1,"maximum":31},"interval":{"type":"integer","minimum":1,"maximum":365},"timezone":{"type":"string","minLength":1},"ignoreWeekdays":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"ignoreHours":{"type":"array","items":{"type":"integer","minimum":0,"maximum":23}},"minute":{"anyOf":[{"type":"number","enum":[0]},{"type":"number","enum":[15]},{"type":"number","enum":[30]},{"type":"number","enum":[45]}]},"periodInterval":{"type":"integer","minimum":1,"maximum":365},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"endDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["frequency"],"additionalProperties":false},"startLinks":{"type":"object","properties":{"lawSuit":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED"]},"person":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED","LAWSUIT"]},"responsibles":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED"]}},"additionalProperties":false},"startItems":{"type":"array","items":{"type":"object","properties":{"module":{"type":"string","enum":["LAWSUIT","PERSON","TASK","CONSULTING","TRANSACTION","EVENT","AUDIENCE","USER"]},"required":{"type":"boolean","default":false},"includeParties":{"type":"boolean"}},"required":["module"],"additionalProperties":false}},"createLawsuitIfMissing":{"type":"boolean"}},"additionalProperties":false,"description":"Dados do gatilho. Formato completo, gatilhos, ações e variáveis {{...}} em GET /workflow/catalog."},"content":{"type":"object","properties":{"steps":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1},"nextStepId":{"type":"string","nullable":true},"nextStepIds":{"type":"array","items":{"type":"string"}},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"requiresPreviousComplete":{"type":"boolean"},"dependsOnStepId":{"type":"string","nullable":true},"delay":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"maximum":8760},"unit":{"type":"string","enum":["MINUTES","HOURS","DAYS"]}},"required":["amount","unit"],"additionalProperties":false,"nullable":true},"manualRelease":{"type":"boolean"},"type":{"type":"string","enum":["trigger"]},"trigger":{"type":"string","enum":["MANUAL_START","ON_SCHEDULE","ON_PUBLICATION_CREATED","ON_CRM_CREATED","ON_TASK_CREATED","ON_EVENT_CREATED","ON_AUDIENCE_CREATED","ON_FINANCIAL_CREATED","ON_MOVEMENT_CREATED","ON_SIGNATURE_SIGNED","ON_DOCUMENT_CREATED","ON_LAWSUIT_CREATED","ON_PERSON_CREATED","ON_TASK_COLUMN_ENTERED","ON_CRM_COLUMN_ENTERED","ON_STATE_CHANGED","ON_DATE_APPROACHING"]},"triggerData":{"type":"object","properties":{"keywords":{"type":"array","items":{"type":"string","minLength":1}},"funnelId":{"type":"string"},"columnId":{"type":"string"},"stateRule":{"type":"object","properties":{"entityType":{"type":"string","enum":["TASK","CONSULTING","TRANSACTION"]},"state":{"type":"string","minLength":1},"op":{"type":"string","enum":["EQ","NEQ"],"default":"EQ"},"value":{"type":"string","minLength":1}},"required":["entityType","state","value"],"additionalProperties":false},"dateTrigger":{"type":"object","properties":{"target":{"type":"string","enum":["TASK_FINAL","TASK_INITIAL","EVENT","AUDIENCE","TRANSACTION_DUE"]},"daysBefore":{"type":"integer","minimum":0,"maximum":365},"businessDays":{"type":"boolean"}},"required":["target","daysBefore"],"additionalProperties":false},"requireAllKeywords":{"type":"boolean"},"athenaAnalysis":{"type":"object","properties":{"enabled":{"type":"boolean"},"prompt":{"type":"string"}},"required":["enabled","prompt"],"additionalProperties":false},"schedule":{"type":"object","properties":{"frequency":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","EVERY_N_DAYS","EVERY_N_HOURS"]},"time":{"type":"string","pattern":"^\\d{2}:\\d{2}$"},"weekday":{"type":"integer","minimum":0,"maximum":6},"monthDay":{"type":"integer","minimum":1,"maximum":31},"interval":{"type":"integer","minimum":1,"maximum":365},"timezone":{"type":"string","minLength":1},"ignoreWeekdays":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"ignoreHours":{"type":"array","items":{"type":"integer","minimum":0,"maximum":23}},"minute":{"anyOf":[{"type":"number","enum":[0]},{"type":"number","enum":[15]},{"type":"number","enum":[30]},{"type":"number","enum":[45]}]},"periodInterval":{"type":"integer","minimum":1,"maximum":365},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"endDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["frequency"],"additionalProperties":false},"startLinks":{"type":"object","properties":{"lawSuit":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED"]},"person":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED","LAWSUIT"]},"responsibles":{"type":"string","enum":["NONE","OPTIONAL","REQUIRED"]}},"additionalProperties":false},"startItems":{"type":"array","items":{"type":"object","properties":{"module":{"type":"string","enum":["LAWSUIT","PERSON","TASK","CONSULTING","TRANSACTION","EVENT","AUDIENCE","USER"]},"required":{"type":"boolean","default":false},"includeParties":{"type":"boolean"}},"required":["module"],"additionalProperties":false}},"createLawsuitIfMissing":{"type":"boolean"}},"additionalProperties":false}},"required":["id","type","trigger"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1},"nextStepId":{"type":"string","nullable":true},"nextStepIds":{"type":"array","items":{"type":"string"}},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"requiresPreviousComplete":{"type":"boolean"},"dependsOnStepId":{"type":"string","nullable":true},"delay":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"maximum":8760},"unit":{"type":"string","enum":["MINUTES","HOURS","DAYS"]}},"required":["amount","unit"],"additionalProperties":false,"nullable":true},"manualRelease":{"type":"boolean"},"type":{"type":"string","enum":["action"]},"action":{"type":"string","enum":["CREATE","APPROVE","ALERT","MANAGE","WEBHOOK","JURICHAT_MESSAGE","CREATE_TASK","CREATE_EVENT","CREATE_AUDIENCE","CREATE_CONSULTING","CREATE_TRANSACTION","UPDATE_CONSULTING_COLUMN","CREATE_SIGNATURE","CREATE_DOCUMENT","CREATE_ALERT"]},"targetModule":{"type":"string","enum":["TASK","EVENT","AUDIENCE","CONSULTING","TRANSACTION","SIGNATURE","DOCUMENT","LAWSUIT"]},"itemCode":{"type":"string","minLength":1},"targetItemCode":{"type":"string","minLength":1},"completeOnCreate":{"type":"boolean","default":false},"config":{"type":"object","additionalProperties":{},"default":{}}},"required":["id","type","action"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1},"nextStepId":{"type":"string","nullable":true},"nextStepIds":{"type":"array","items":{"type":"string"}},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"requiresPreviousComplete":{"type":"boolean"},"dependsOnStepId":{"type":"string","nullable":true},"delay":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"maximum":8760},"unit":{"type":"string","enum":["MINUTES","HOURS","DAYS"]}},"required":["amount","unit"],"additionalProperties":false,"nullable":true},"manualRelease":{"type":"boolean"},"type":{"type":"string","enum":["condition"]},"condition":{"type":"string","enum":["IF_KEYWORD_IN_CONTENT","IF_STEP_OVERDUE","IF_HAS_LAWSUIT","IF_HAS_PERSON","WAIT_FOR_STATE"]},"conditionData":{"type":"object","additionalProperties":{}},"options":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"title":{"type":"string"},"value":{"type":"string"},"nextStepId":{"type":"string","nullable":true},"kind":{"type":"string","enum":["KEYWORD","ATHENA"]},"instruction":{"type":"string","maxLength":2000},"keywords":{"type":"array","items":{"type":"string","maxLength":200},"maxItems":50}},"required":["text","title","value","nextStepId"],"additionalProperties":false}}},"required":["id","type","condition","options"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1},"nextStepId":{"type":"string","nullable":true},"nextStepIds":{"type":"array","items":{"type":"string"}},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"requiresPreviousComplete":{"type":"boolean"},"dependsOnStepId":{"type":"string","nullable":true},"delay":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"maximum":8760},"unit":{"type":"string","enum":["MINUTES","HOURS","DAYS"]}},"required":["amount","unit"],"additionalProperties":false,"nullable":true},"manualRelease":{"type":"boolean"},"type":{"type":"string","enum":["gate"]},"waitForStepId":{"type":"string","minLength":1}},"required":["id","type","waitForStepId"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1},"nextStepId":{"enum":["null"],"nullable":true},"nextStepIds":{"type":"array","items":{"type":"string"}},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"requiresPreviousComplete":{"type":"boolean"},"dependsOnStepId":{"type":"string","nullable":true},"delay":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"maximum":8760},"unit":{"type":"string","enum":["MINUTES","HOURS","DAYS"]}},"required":["amount","unit"],"additionalProperties":false,"nullable":true},"manualRelease":{"type":"boolean"},"type":{"type":"string","enum":["end"]}},"required":["id","type"],"additionalProperties":false}]}},"initialStepId":{"type":"string","nullable":true}},"required":["steps"],"additionalProperties":false,"description":"Grafo de passos: { initialStepId, steps: [...] }. Formato completo, gatilhos, ações e variáveis {{...}} em GET /workflow/catalog."},"tagIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Etiquetas (ids)"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workflow":{}},"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}},"security":[{"apiKeyAuth":[]}]},"delete":{"summary":"Delete workflow","tags":["Workflows"],"parameters":[{"schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]},"in":"query","name":"deleteCreatedItems","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{"enum":["null"],"nullable":true}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"],"additionalProperties":false}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/{id}/start":{"post":{"summary":"Start workflow manually","tags":["Workflows"],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{"context":{"type":"object","additionalProperties":{}}},"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{}},"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}},"/workflow/{id}/start-responsibles":{"get":{"summary":"Suggested responsible per distributed step for a manual start","tags":["Workflows"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"stepId":{"type":"string"},"userId":{"type":"string"}},"required":["stepId","userId"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false}}}},"403":{"description":"A chave não tem a permissão desta ação no perfil dela, ou quem a criou não tem mais.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"statusCode":{"type":"number"},"translateMessage":{"type":"string"}},"required":["message","statusCode","translateMessage"]}}}}},"security":[{"apiKeyAuth":[]}]}}},"servers":[{"url":"https://api.juridiq.com.br","description":"Production server"}],"security":[{"apiKeyAuth":[]}],"tags":[]}