Atualizar apontamento

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.

PATCH /time-sheet/{id}

Atualizar apontamento

cURL

curl --request PATCH \
  --url https://api.juridiq.com.br/time-sheet/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "estimatedTimeMinutes": 1,
  "cancelReason": "<string>",
  "hourlyRate": 500000,
  "personId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lawSuitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "consultingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

200

{
  "id": "<string>",
  "title": "<string>",
  "module": "TASK",
  "isDone": true,
  "officeId": "<string>",
  "timeSpentSeconds": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "status": "PENDING",
  "userId": "<string>",
  "taskId": "<string>",
  "audienceId": "<string>",
  "subtaskId": "<string>",
  "personId": "<string>",
  "lawSuitId": "<string>",
  "consultingId": "<string>",
  "person": {
    "id": "<string>",
    "name": "<string>"
  },
  "lawSuit": {
    "id": "<string>",
    "processNumber": "<string>"
  },
  "consulting": {
    "id": "<string>",
    "subject": "<string>"
  },
  "estimatedTimeMinutes": 123,
  "hourlyRate": 123,
  "costValue": 123,
  "cancelReason": "<string>",
  "completedAt": "2023-11-07T05:31:56Z",
  "vinculateItem": {
    "id": "<string>",
    "name": "<string>",
    "processNumber": "<string>"
  },
  "thisUserCanEdit": true,
  "userDetail": {
    "name": "<string>",
    "urlImage": "<string>"
  },
  "statusHistories": [
    {
      "id": "<string>",
      "status": "PENDING",
      "startedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "endedAt": "2023-11-07T05:31:56Z",
      "timeSpent": 123
    }
  ]
}

Authorizations

x-juridiq-api-key · string · header · required

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).

Path Parameters

id · string<uuid> · required

ID do apontamento

Body

application/json

status · enum<string>

Status a ser aplicado pelo front (retomar, pausar, concluir, cancelar ou pendente)

Available options: PENDING, IN_PROGRESS, PAUSED, COMPLETED, CANCELLED

title · string

Novo título (apontamentos GERAIS)

Minimum string length: 1

estimatedTimeMinutes · integer

Tempo previsto em minutos (apontamentos GERAIS)

Required range: x >= 0

cancelReason · string

Motivo do cancelamento

hourlyRate · number | null

Valor da hora em reais, de 0 a 1.000.000, com até 2 casas decimais (qualquer módulo; null remove o valor)

Required range: 0 <= x <= 1000000

personId · string<uuid> | null

Pessoa/cliente vinculada (apenas GENERAL; null remove o vínculo)

lawSuitId · string<uuid> | null

Processo vinculado (apenas GENERAL; null remove o vínculo)

consultingId · string<uuid> | null

Atendimento do CRM vinculado (apenas GENERAL; null remove o vínculo)

Response

200

application/json

Default Response

id · string · required

ID do apontamento

title · string · required

Título

module · enum<string> · required

Módulo

Available options: TASK, AUDIENCE, SUBTASK, GENERAL

isDone · boolean · required

Concluído

officeId · string · required

ID do escritório

timeSpentSeconds · number · required

Tempo gasto somando os históricos (segundos)

createdAt · string<date-time> · required

Data de criação

updatedAt · string<date-time> · required

Data de atualização

status · enum<string> | null

Status atual

Available options: PENDING, IN_PROGRESS, PAUSED, COMPLETED, CANCELLED

userId · string | null

ID do usuário

taskId · string | null

ID da tarefa

audienceId · string | null

ID da audiência

subtaskId · string | null

ID da subtarefa

personId · string | null

ID da pessoa/cliente vinculada

lawSuitId · string | null

ID do processo vinculado

consultingId · string | null

ID do atendimento vinculado

person · object | null

Pessoa/cliente vinculada

Show child attributes

lawSuit · object | null

Processo vinculado

Show child attributes

consulting · object | null

Atendimento do CRM vinculado

Show child attributes

estimatedTimeMinutes · number | null

Tempo estimado (minutos)

hourlyRate · number | null

Valor da hora em reais; null quando não informado

costValue · number | null

Custo em reais: timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos; null sem hourlyRate

cancelReason · string | null

Motivo do cancelamento

completedAt · string<date-time> | null

Data de finalização (conclusão/cancelamento)

vinculateItem · object | null

Item vinculado (tarefa/subtarefa/audiência)

Show child attributes

thisUserCanEdit · boolean

Indica se o usuário da requisição é o dono do apontamento

userDetail · object | null

Dados do usuário do apontamento

Show child attributes

statusHistories · object[]

Históricos de status

Show child attributes