Listar apontamentos

curl --request GET \
  --url https://api.juridiq.com.br/time-sheet/ \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/time-sheet/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/time-sheet/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/time-sheet/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/time-sheet/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "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
        }
      ]
    }
  ],
  "totalResults": 123,
  "totalPages": 123,
  "summary": {
    "count": 123,
    "totalSeconds": 123,
    "totalCost": 123,
    "countWithoutRate": 123,
    "byUser": [
      {
        "userId": "<string>",
        "userName": "<string>",
        "count": 123,
        "totalSeconds": 123,
        "totalCost": 123
      }
    ]
  }
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

TimeSheets

Listar apontamentos

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.

GET

time-sheet

Listar apontamentos

curl --request GET \
  --url https://api.juridiq.com.br/time-sheet/ \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/time-sheet/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/time-sheet/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/time-sheet/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/time-sheet/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "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
        }
      ]
    }
  ],
  "totalResults": 123,
  "totalPages": 123,
  "summary": {
    "count": 123,
    "totalSeconds": 123,
    "totalCost": 123,
    "countWithoutRate": 123,
    "byUser": [
      {
        "userId": "<string>",
        "userName": "<string>",
        "count": 123,
        "totalSeconds": 123,
        "totalCost": 123
      }
    ]
  }
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

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

Query Parameters

page

string

Página. Começa em 1

limit

string

Itens por página

title

string

Filtra por título

module

enum<string>

Filtra por módulo

Available options:

TASK,

AUDIENCE,

SUBTASK,

GENERAL

status

enum<string>

Filtra pelo status atual (FINISHED = Concluídos + Cancelados)

Available options:

PENDING,

IN_PROGRESS,

PAUSED,

COMPLETED,

CANCELLED,

FINISHED

isDone

string

true ou false

userId

string<uuid>

Filtra por usuário

taskId

string<uuid>

Filtra por tarefa

audienceId

string<uuid>

Filtra por audiência

subtaskId

string<uuid>

Filtra por subtarefa

personId

string<uuid>

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

lawSuitId

string<uuid>

Apontamentos do processo: vínculo direto, tarefa, subtarefa, audiência e atendimento do processo

orderBy

enum<string>

asc ou desc

Available options:

asc,

desc

orderByField

string

Campo de ordenação

startDate

string<date>

Criados a partir deste dia, no fuso America/Sao_Paulo. Formato YYYY-MM-DD, de 1900-01-01 a 9999-12-30

endDate

string<date>

Criados até este dia, no fuso America/Sao_Paulo. Formato YYYY-MM-DD, de 1900-01-01 a 9999-12-30

includeSummary

enum<string>

true devolve summary quando vier com personId ou lawSuitId

Available options:

true,

false

Response

Default Response

data

object[]

required

Lista de apontamentos

Show child attributes

totalResults

number

required

Total de registros

totalPages

number

required

Total de páginas

summary

object

Totais de todos os filtrados, não só da página; só com includeSummary=true e personId ou lawSuitId

Show child attributes

Primeiros Passos

API Reference

Listar apontamentos

Authorizations

Query Parameters

Response