Apontamento de horas

Base: https://api.nivesistemas.com.br · 6 endpoints

GET /time-entries

Listar apontamentos

Query params

Campo	Tipo	Obrigatório	Descrição
`userId`	uuid	não	Colaborador
`projectId`	uuid	não	Projeto
`serviceOrderId`	uuid	não	OS
`from`	string	não	Data inicial
`to`	string	não	Data final
`billable`	string	não	true \| false

curl -X GET "https://api.nivesistemas.com.br/time-entries" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/time-entries", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/time-entries",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /time-entries/report

Relatório de horas

Query params

Campo	Tipo	Obrigatório	Descrição
`from`	string	não	Data inicial
`to`	string	não	Data final
`customerId`	uuid	não	Cliente
`userId`	uuid	não	Colaborador
`projectId`	uuid	não	Projeto

curl -X GET "https://api.nivesistemas.com.br/time-entries/report" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/time-entries/report", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/time-entries/report",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /time-entries/:id

Detalhe do apontamento

Parâmetros de rota: id

curl -X GET "https://api.nivesistemas.com.br/time-entries/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/time-entries/{id}", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/time-entries/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /time-entries

Criar apontamento

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`userId`	uuid	sim	Colaborador
`projectId`	uuid	não	Projeto
`serviceOrderId`	uuid	não	OS
`workDate`	string	sim	Data do trabalho
`startTime`	string	não	Início (ISO)
`endTime`	string	não	Fim (ISO)
`totalMinutes`	integer	não	Duração em minutos (se não informar intervalo)
`description`	string	não	Descrição
`billable`	boolean	não	Faturável

Resposta: 201 Created

curl -X POST "https://api.nivesistemas.com.br/time-entries" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"userId":"00000000-0000-0000-0000-000000000000","projectId":"00000000-0000-0000-0000-000000000000","serviceOrderId":"00000000-0000-0000-0000-000000000000","workDate":"","startTime":"","endTime":"","totalMinutes":1,"description":"","billable":true}'

const res = await fetch("https://api.nivesistemas.com.br/time-entries", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "userId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "serviceOrderId": "00000000-0000-0000-0000-000000000000",
    "workDate": "",
    "startTime": "",
    "endTime": "",
    "totalMinutes": 1,
    "description": "",
    "billable": true
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/time-entries",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "userId": "00000000-0000-0000-0000-000000000000",
      "projectId": "00000000-0000-0000-0000-000000000000",
      "serviceOrderId": "00000000-0000-0000-0000-000000000000",
      "workDate": "",
      "startTime": "",
      "endTime": "",
      "totalMinutes": 1,
      "description": "",
      "billable": True
    },
)
print(res.json())

PATCH /time-entries/:id

Atualizar apontamento

Parâmetros de rota: id

curl -X PATCH "https://api.nivesistemas.com.br/time-entries/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/time-entries/{id}", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/time-entries/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /time-entries/:id

Excluir apontamento

Parâmetros de rota: id

Resposta: 204 No Content

curl -X DELETE "https://api.nivesistemas.com.br/time-entries/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/time-entries/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "DELETE",
    "https://api.nivesistemas.com.br/time-entries/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())