Auth

Alterando a senha

Este método serve para alterar a senha do usuário atual.

Endpoint

PATCH /v1/auth/password

Parameters

Name	Description
password required	(String) Nova senha do usuário.
password_confirmation required	(String) Confirmar a mesma senha.

Request

Route

PATCH /v1/auth/password

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

password=test12&password_confirmation=test12

cURL

curl "http://api.lvh.me:3000/v1/auth/password" -d 'password=test12&password_confirmation=test12' -X PATCH \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Object) Atributos do Usuário.
message	(String) Mensagem do resulta do recurso.
success	(Boolean) Status do recurso.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"071f166babfe5d83121af33a5d06f9a3"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: fd612fb2-811f-49fb-8426-e8bb62f2ef9f
X-Runtime: 0.210959
Vary: Origin
Content-Length: 3446

Body

{
  "success": true,
  "data": "{\"first_name\":\"funcionario1\",\"last_name\":\"\",\"cpf\":\"010.333.111-22\",\"username\":\"funcionario1\",\"station_user\":\"Funcionario\",\"roles\":[\"funcionario\"],\"created_at\":\"2023-09-27T09:51:27.000-03:00\",\"updated_at\":\"2023-09-27T09:51:28.630-03:00\",\"funcionario_uid\":\"71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0\",\"temporary_password\":false,\"empresa\":{\"uid\":\"a43bedds-ba77-4062-46c0-58f4444dad33\",\"name\":\"Empresa03\",\"nome_fantasia\":\"EmpFantasia03\",\"cnpj\":\"00.000.000/0000-03\",\"cei\":null,\"cpf\":null,\"inscricao_estadual\":null,\"address\":{\"cep\":\"85555-222\",\"city\":\"Guarapuava\",\"complement\":\"Apto52\",\"country\":\"Brasil\",\"number\":\"101\",\"state\":\"PR\",\"street\":\"Rua Armando Ribas\",\"district\":\"Rua Armando Ribas\"},\"contact\":null,\"codigo_registro_folha\":\"23\",\"ativo\":true},\"franquia\":{\"uid\":\"71ba8bd7-3b65-40fa-8e11-7daf5f0fe3f0\",\"name\":\"Franquia01\",\"nome_fantasia\":\"FranquiaFantasia01\",\"cnpj\":\"00.000.000/0000-00\",\"inscricao_estadual\":null,\"cpf\":null,\"logo\":\"/uploads/franquia/879004013/logo/879004013/logo.png\",\"clausula_aceite\":null,\"address\":{\"cep\":\"85555-222\",\"city\":\"Guarapuava\",\"complement\":\"Apto52\",\"country\":\"Brasil\",\"number\":\"101\",\"state\":\"PR\",\"street\":\"Rua Armando Ribas\",\"district\":\"Rua Armando Ribas\"},\"condicoes_comerciais\":null,\"contacts\":[{\"email\":\"[email protected]\",\"name\":\"My Contact\",\"phone\":\"(42) 05555-4444\",\"cpf\":null,\"whatsapp\":null,\"site\":null,\"instagram\":null},{\"email\":\"[email protected]\",\"name\":\"My Contact Legal\",\"phone\":\"(42) 05555-4444\",\"cpf\":null,\"whatsapp\":null,\"site\":null,\"instagram\":null},{\"email\":\"[email protected]\",\"name\":\"My Contact Tecnico\",\"phone\":\"(42) 05555-4444\",\"cpf\":null,\"whatsapp\":null,\"site\":null,\"instagram\":null}]},\"email\":\"[email protected]\",\"station\":{\"cpf\":\"07155744989\",\"cracha\":\"1\",\"data_admissao\":null,\"data_demissao\":null,\"name\":\"Func1\",\"pis\":\"123929234315\",\"registro_folha\":\"1\",\"rg\":null,\"uid\":\"71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0\",\"nacionalidade\":null,\"nome_da_mae\":null,\"nome_do_pai\":null,\"estado_civil\":null,\"conjuge\":null,\"nascimento\":null,\"ctps\":null,\"cnh\":null,\"certidao_militar\":null,\"tipo_sanguineo\":null,\"escolaridade\":null,\"observacoes\":null,\"cargos\":[{\"data\":\"2017-01-10\",\"funcao\":\"test\",\"name\":\"Auxiliar (123456)\"},{\"data\":\"2018-01-01\",\"funcao\":\"auxiliar\",\"name\":null}],\"exames\":[{\"data\":\"2017-01-10\",\"apto\":true,\"tipo_exame\":null,\"observacoes\":null,\"arquivo\":{\"url\":null}}],\"empresa\":{\"uid\":\"a43bedds-ba77-4062-46c0-58f4444dad33\",\"name\":\"Empresa03\",\"nome_fantasia\":\"EmpFantasia03\",\"cnpj\":\"00.000.000/0000-03\",\"cei\":null,\"cpf\":null,\"inscricao_estadual\":null,\"address\":{\"cep\":\"85555-222\",\"city\":\"Guarapuava\",\"complement\":\"Apto52\",\"country\":\"Brasil\",\"number\":\"101\",\"state\":\"PR\",\"street\":\"Rua Armando Ribas\",\"district\":\"Rua Armando Ribas\"},\"contact\":null,\"codigo_registro_folha\":\"23\",\"ativo\":true},\"departamento\":null,\"biometria\":null},\"blocked\":false,\"avatar\":{\"url\":\"/assets/default-avatar.svg\"},\"accepted_terms\":true,\"uid\":\"[email protected]\",\"platform_auth\":\"all_platform_auth\"}",
  "message": "Your password has been successfully updated."
}

Encerrando a conta

Este método serve para excluir a conta do usuário atual.

Endpoint

DELETE /v1/auth

Request

Route

DELETE /v1/auth

Headers

Host: api.lvh.me
Access-Token: TMLJleqrezgbGLjaf2VYSA
Token-Type: Bearer
Client: Zc14Bd0aegsU8EOr3v5KhQ
Expiry: 1697028688
Uid: [email protected]
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/auth" -d '' -X DELETE \
	-H "Host: api.lvh.me" \
	-H "Access-Token: TMLJleqrezgbGLjaf2VYSA" \
	-H "Token-Type: Bearer" \
	-H "Client: Zc14Bd0aegsU8EOr3v5KhQ" \
	-H "Expiry: 1697028688" \
	-H "Uid: [email protected]" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
message	(String) Mensagem do resultado do recurso.
success	(Boolean) Status do recurso.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"6d072e9fa748b4e48b9a13b3d5ad4480"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _ptrp_session=ODcrVWY5dmNURm96OWd3ck93WVZBS2lzQmdycmx4UC90d3hMTUJKaHZxMEJldEVqbnVYUkJIWHJvRHJIZHZTL0ZwWGZPV2wxTXB4WGxSTVMyeld3bUcvQlRJV2NIaWZvZHF5emVOeVhvRGZ0d3JKSUVJMlM3UWI1RkQyQWRIQnhCaXFpY3RKVUNwMFFqQTZxOXh3TmdaRVREWVI3RHluQkRrbXI1b21HUzZEZ0ZnbFhMV2tVWTd3Rm1jOFgxaUlTLS1DLzhncDBBVWN6cnRLVnJEbXNmTE5nPT0%3D--1e7b6081ace94495a796d597b12e08f950cbfb1c; domain=.api.lvh.me; path=/; HttpOnly
X-Request-Id: 8496f178-f1ec-41a5-9695-5b5796c3f6d5
X-Runtime: 0.099586
Vary: Origin
Content-Length: 87

Body

{
  "status": "success",
  "message": "A conta com uid '[email protected]' foi excluída."
}

Login

Este método serve para obter chave de acesso (access-token, client e UID) através de login e senha.Este é um método alternativo para clientes que utilizam cabeçalho “access-token” ao invés de “X-Auth-Token” para se autenticar na API.

Endpoint

POST /v1/auth/sign_in

Parameters

Name	Description
login required	(String) E-mail ou username.
password required	(String) Senha do usuário.

Request

Route

POST /v1/auth/sign_in

Headers

Host: api.lvh.me
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

login=funcionario%40email.com&password=teste123

cURL

curl "http://api.lvh.me:3000/v1/auth/sign_in" -d 'login=funcionario%40email.com&password=teste123' -X POST \
	-H "Host: api.lvh.me" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Object) Atributos do Usuário.
message	(String) Mensagem do resulta do recurso.
success	(Boolean) Status do recurso.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
access-token: UcjEkN4J9GqYwOlo5573cA
token-type: Bearer
client: Px6z_Jl-KgOU7DJVvxDYQg
expiry: 1697028689
uid: [email protected]
Content-Type: application/json; charset=utf-8
ETag: W/"aa8a217a01a48000973d792cd508fa57"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 34a3aee7-c252-4bf2-a327-31ed3384eb97
X-Runtime: 0.269338
Vary: Origin
Content-Length: 3453

Body

{
  "data": {
    "first_name": "funcionario1",
    "last_name": "",
    "cpf": "010.333.111-22",
    "username": "funcionario1",
    "station_type": "Funcionario",
    "roles": [
      "funcionario"
    ],
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "updated_at": "2023-09-27T09:51:29.203-03:00",
    "funcionario_uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
    "temporary_password": false,
    "empresa": {
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "85555-222",
        "city": "Guarapuava",
        "complement": "Apto52",
        "country": "Brasil",
        "number": "101",
        "state": "PR",
        "street": "Rua Armando Ribas",
        "district": "Rua Armando Ribas"
      },
      "contact": null,
      "codigo_registro_folha": "23",
      "ativo": true
    },
    "franquia": {
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe3f0",
      "name": "Franquia01",
      "nome_fantasia": "FranquiaFantasia01",
      "cnpj": "00.000.000/0000-00",
      "inscricao_estadual": null,
      "cpf": null,
      "logo": "/uploads/franquia/879004013/logo/879004013/logo.png",
      "clausula_aceite": null,
      "address": {
        "cep": "85555-222",
        "city": "Guarapuava",
        "complement": "Apto52",
        "country": "Brasil",
        "number": "101",
        "state": "PR",
        "street": "Rua Armando Ribas",
        "district": "Rua Armando Ribas"
      },
      "condicoes_comerciais": null,
      "contacts": [
        {
          "email": "[email protected]",
          "name": "My Contact",
          "phone": "(42) 05555-4444",
          "cpf": null,
          "whatsapp": null,
          "site": null,
          "instagram": null
        },
        {
          "email": "[email protected]",
          "name": "My Contact Legal",
          "phone": "(42) 05555-4444",
          "cpf": null,
          "whatsapp": null,
          "site": null,
          "instagram": null
        },
        {
          "email": "[email protected]",
          "name": "My Contact Tecnico",
          "phone": "(42) 05555-4444",
          "cpf": null,
          "whatsapp": null,
          "site": null,
          "instagram": null
        }
      ]
    },
    "email": "[email protected]",
    "station": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": null,
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "1",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "cei": null,
        "cpf": null,
        "inscricao_estadual": null,
        "address": {
          "cep": "85555-222",
          "city": "Guarapuava",
          "complement": "Apto52",
          "country": "Brasil",
          "number": "101",
          "state": "PR",
          "street": "Rua Armando Ribas",
          "district": "Rua Armando Ribas"
        },
        "contact": null,
        "codigo_registro_folha": "23",
        "ativo": true
      },
      "departamento": {
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "name": "Departamento01",
        "empresa": {
          "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
          "name": "Empresa03",
          "nome_fantasia": "EmpFantasia03",
          "cnpj": "00.000.000/0000-03",
          "cei": null,
          "cpf": null,
          "inscricao_estadual": null,
          "address": {
            "cep": "85555-222",
            "city": "Guarapuava",
            "complement": "Apto52",
            "country": "Brasil",
            "number": "101",
            "state": "PR",
            "street": "Rua Armando Ribas",
            "district": "Rua Armando Ribas"
          },
          "contact": null,
          "codigo_registro_folha": "23",
          "ativo": true
        },
        "ativo": true
      },
      "biometria": null
    },
    "blocked": false,
    "avatar": {
      "url": "/assets/default-avatar.svg"
    },
    "accepted_terms": true,
    "uid": "[email protected]",
    "platform_auth": "all_platform_auth"
  }
}

Renovar token

Este método serve para renovar a chave de acesso (access-token, client e UID).O novo token terá o tempo de validade novo.

Endpoint

PATCH /v1/auth/refresh

Request

Route

PATCH /v1/auth/refresh

Headers

Access-Token: IB-3X2_WT6fhF0jMBD73BA
Client: AIWePENTMAuYdGNhqmqY8B
Uid: [email protected]
Token-Type: Bearer
Host: api.lvh.me
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/auth/refresh" -d '' -X PATCH \
	-H "Access-Token: IB-3X2_WT6fhF0jMBD73BA" \
	-H "Client: AIWePENTMAuYdGNhqmqY8B" \
	-H "Uid: [email protected]" \
	-H "Token-Type: Bearer" \
	-H "Host: api.lvh.me" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
access-token	(String) Token de acesso.
expiry	(String) Timestamp de vencimento do token.
token-type	(String) Tipo do token.
uid	(String) UID do usuário.
client	(String) id do cliente.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"c24a6d03f2d69ffc6ec5d9ab25e824a2"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 2e127415-cb56-43fd-afc6-9e408db21c3b
X-Runtime: 0.200589
Vary: Origin
Content-Length: 130

Body

{
  "access-token": "Sh5E4K7QzOf_LjR6Nk2g8w",
  "token-type": "Bearer",
  "client": "sEBkxLB4MnHiSwklwgmXgA",
  "expiry": "1697028689",
  "uid": null
}

Ações em Massa

Criando Justificativas

Este método cria Justificativa para vários funcionários no intervalo entre duas datas. Retorna um array de Justificativas criadas.

Endpoint

POST /v1/acoes-em-massa/justificativas

Parameters

Name	Description
justificativas[funcionario_uids] required	(Array) Array com UIDs dos funcionários.
justificativas[start_date] required	(Date) Data inicial.
justificativas[end_date] required	(Date) Data final.
justificativas[hora] required	(Time) Quantidade de horas para justificar. Ex: "01:30".
justificativas[motivo_id] required	(Integer) Id do Motivo (ver artigo de Motivos) da justificativa.
justificativas[motivo_personalizado_id]	(Integer) ID do Motivo personalizado.
justificativas[abonar]	(Boolean) "true" para a justificativa que serve para abonar horas do dia.

Request

Route

POST /v1/acoes-em-massa/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

justificativas[start_date]=2019-01-01&justificativas[end_date]=2019-01-09&justificativas[hora]=01%3A00&justificativas[motivo_id]=267869265&justificativas[funcionario_uids][]=71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0

cURL

curl "http://api.lvh.me:3000/v1/acoes-em-massa/justificativas" -d 'justificativas[start_date]=2019-01-01&justificativas[end_date]=2019-01-09&justificativas[hora]=01%3A00&justificativas[motivo_id]=267869265&justificativas[funcionario_uids][]=71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) Id da Justificativa.
data	(Date) Data.
hora	(Time) Quantidade de horas.
desconta_dsr	(Bool) Descontar DSR?
abonar	(Bool) Assinalado para abonar?
motivo	(Object) Objeto Motivo (ver artigo Motivos).
message	(String) Resposta da requisição quando há erros.
errors[motivo]	(Array) Mensagens de erros para o campo motivo_id.
errors[start_date]	(Array) Mensagens de erros para o campo start_date.
errors[end_date]	(Array) Mensagens de erros para o campo end_date.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"2dc87e139b13623c996b203efca67877"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: bab842b0-12ff-4eae-9f3a-104a33bc71e5
X-Runtime: 0.130446
Vary: Origin
Content-Length: 1873

Body

[
  {
    "id": 1070701488,
    "data": "2019-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "desconta_dsr": null,
    "abonar": null,
    "motivo": {
      "id": 267869265,
      "name": "Afastado(+de15dias)",
      "e_social_id": null
    },
    "motivo_personalizado": null
  },
  {
    "id": 1070701489,
    "data": "2019-01-02",
    "hora": "2000-01-01T01:00:00.000Z",
    "desconta_dsr": null,
    "abonar": null,
    "motivo": {
      "id": 267869265,
      "name": "Afastado(+de15dias)",
      "e_social_id": null
    },
    "motivo_personalizado": null
  },
  {
    "id": 1070701490,
    "data": "2019-01-03",
    "hora": "2000-01-01T01:00:00.000Z",
    "desconta_dsr": null,
    "abonar": null,
    "motivo": {
      "id": 267869265,
      "name": "Afastado(+de15dias)",
      "e_social_id": null
    },
    "motivo_personalizado": null
  },
  {
    "id": 1070701491,
    "data": "2019-01-04",
    "hora": "2000-01-01T01:00:00.000Z",
    "desconta_dsr": null,
    "abonar": null,
    "motivo": {
      "id": 267869265,
      "name": "Afastado(+de15dias)",
      "e_social_id": null
    },
    "motivo_personalizado": null
  },
  {
    "id": 1070701492,
    "data": "2019-01-05",
    "hora": "2000-01-01T01:00:00.000Z",
    "desconta_dsr": null,
    "abonar": null,
    "motivo": {
      "id": 267869265,
      "name": "Afastado(+de15dias)",
      "e_social_id": null
    },
    "motivo_personalizado": null
  },
  {
    "id": 1070701493,
    "data": "2019-01-06",
    "hora": "2000-01-01T01:00:00.000Z",
    "desconta_dsr": null,
    "abonar": null,
    "motivo": {
      "id": 267869265,
      "name": "Afastado(+de15dias)",
      "e_social_id": null
    },
    "motivo_personalizado": null
  },
  {
    "id": 1070701494,
    "data": "2019-01-07",
    "hora": "2000-01-01T01:00:00.000Z",
    "desconta_dsr": null,
    "abonar": null,
    "motivo": {
      "id": 267869265,
      "name": "Afastado(+de15dias)",
      "e_social_id": null
    },
    "motivo_personalizado": null
  },
  {
    "id": 1070701495,
    "data": "2019-01-08",
    "hora": "2000-01-01T01:00:00.000Z",
    "desconta_dsr": null,
    "abonar": null,
    "motivo": {
      "id": 267869265,
      "name": "Afastado(+de15dias)",
      "e_social_id": null
    },
    "motivo_personalizado": null
  },
  {
    "id": 1070701496,
    "data": "2019-01-09",
    "hora": "2000-01-01T01:00:00.000Z",
    "desconta_dsr": null,
    "abonar": null,
    "motivo": {
      "id": 267869265,
      "name": "Afastado(+de15dias)",
      "e_social_id": null
    },
    "motivo_personalizado": null
  }
]

Criando Justificativas - erros

Mostrando erros do método para criar Justificativa para vários funcionários no intervalo entre duas datas. Retorna um objeto com as falhas de validação.

Endpoint

POST /v1/acoes-em-massa/justificativas

Parameters

Name	Description
justificativas[funcionario_uids] required	(Array) Array com UIDs dos funcionários.
justificativas[start_date] required	(Date) Data inicial.
justificativas[end_date] required	(Date) Data final.
justificativas[hora] required	(Time) Quantidade de horas para justificar. Ex: "01:30".
justificativas[motivo_id] required	(Integer) Id do Motivo (ver artigo de Motivos) da justificativa.
justificativas[motivo_personalizado_id]	(Integer) ID do Motivo personalizado.
justificativas[abonar]	(Boolean) "true" para a justificativa que serve para abonar horas do dia.

Request

Route

POST /v1/acoes-em-massa/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

justificativas[start_date]=&justificativas[end_date]=&justificativas[hora]=&justificativas[motivo_id]=0&justificativas[funcionario_uids][]=23

cURL

curl "http://api.lvh.me:3000/v1/acoes-em-massa/justificativas" -d 'justificativas[start_date]=&justificativas[end_date]=&justificativas[hora]=&justificativas[motivo_id]=0&justificativas[funcionario_uids][]=23' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) Id da Justificativa.
data	(Date) Data.
hora	(Time) Quantidade de horas.
desconta_dsr	(Bool) Descontar DSR?
abonar	(Bool) Assinalado para abonar?
motivo	(Object) Objeto Motivo (ver artigo Motivos).
message	(String) Resposta da requisição quando há erros.
errors[motivo]	(Array) Mensagens de erros para o campo motivo_id.
errors[start_date]	(Array) Mensagens de erros para o campo start_date.
errors[end_date]	(Array) Mensagens de erros para o campo end_date.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 60e69274-924e-46f0-96fd-ab8ce0f09738
X-Runtime: 0.035309
Vary: Origin
Content-Length: 239

Body

{
  "message": "Validation Failed!",
  "errors": {
    "start_date": [
      "can't be blank",
      "Invalid Date",
      "Invalid Date"
    ],
    "end_date": [
      "can't be blank",
      "Invalid Date",
      "Invalid Date",
      "Invalid Date"
    ],
    "hora": [
      "can't be blank"
    ],
    "motivo_id": [
      "Record not found"
    ]
  }
}

Excluindo Justificativas

Este método exclui as justificativas dos funcionários entre duas datas.

Endpoint

DELETE /v1/acoes-em-massa/justificativas

Parameters

Name	Description
justificativas[funcionario_uids] required	(Array) Array com UIDs dos funcionários.
justificativas[start_date] required	(Date) Data inicial.
justificativas[end_date] required	(Date) Data final.
justificativas[motivo_id] required	(Integer) Id do Motivo (ver artigo de Motivos) da justificativa.

Request

Route

DELETE /v1/acoes-em-massa/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

justificativas[start_date]=2014-01-10&justificativas[end_date]=2014-01-13&justificativas[motivo_id]=267869265&justificativas[funcionario_uids][]=71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0

cURL

curl "http://api.lvh.me:3000/v1/acoes-em-massa/justificativas" -d 'justificativas[start_date]=2014-01-10&justificativas[end_date]=2014-01-13&justificativas[motivo_id]=267869265&justificativas[funcionario_uids][]=71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0' -X DELETE \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
message	(String) Resposta da requisição quando há erros.
errors[start_date]	(Array) Mensagens de erros para o campo start_date.
errors[end_date]	(Array) Mensagens de erros para o campo end_date.
errors[funcionario_uids]	(Array) Mensagens de erros para o campo funcionario_uids.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache
X-Request-Id: 413cf0f7-1dce-420a-bb19-fa676aa72467
X-Runtime: 0.041237
Vary: Origin

Excluindo Justificativas - erros

Mostrando erros da exclusão das justificativas dos funcionários entre duas datas.

Endpoint

DELETE /v1/acoes-em-massa/justificativas

Parameters

Name	Description
justificativas[funcionario_uids] required	(Array) Array com UIDs dos funcionários.
justificativas[start_date] required	(Date) Data inicial.
justificativas[end_date] required	(Date) Data final.
justificativas[motivo_id] required	(Integer) Id do Motivo (ver artigo de Motivos) da justificativa.

Request

Route

DELETE /v1/acoes-em-massa/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

justificativas[start_date]=2014-01-10&justificativas[end_date]=2014-05-13&justificativas[motivo_id]=267869265&justificativas[funcionario_uids][]=71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0

cURL

curl "http://api.lvh.me:3000/v1/acoes-em-massa/justificativas" -d 'justificativas[start_date]=2014-01-10&justificativas[end_date]=2014-05-13&justificativas[motivo_id]=267869265&justificativas[funcionario_uids][]=71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0' -X DELETE \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
message	(String) Resposta da requisição quando há erros.
errors[start_date]	(Array) Mensagens de erros para o campo start_date.
errors[end_date]	(Array) Mensagens de erros para o campo end_date.
errors[funcionario_uids]	(Array) Mensagens de erros para o campo funcionario_uids.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 7467dc04-20f6-4e4e-b1a4-e3fc50999df9
X-Runtime: 0.032835
Vary: Origin
Content-Length: 91

Body

{
  "message": "Destroy Failed!",
  "errors": {
    "end_date": [
      "Interval bounds of maximum 60 days."
    ]
  }
}

Cartão Ponto > Jutificativas

Criando Justificativa

Este método cria uma justificativa no periodo do cartão ponto.

Endpoint

POST /v1/funcionarios/:funcionario_id/cartao_ponto/:year/:month/justificativas

Parameters

Name	Description
funcionario_id required	(String) UID do funcionário.
year required	(Int) Ano do periodo do cartão ponto. Ex: 2017.
month required	(Int) Mês do periodo do cartão ponto. Ex: 10.
cartao_ponto_justificativa[data] required	(Date) Data da justificativa. Ex: "2017-01-01".
cartao_ponto_justificativa[hora] required	(Time) Quantidade de horas da justificativa. Ex: "08:00".
cartao_ponto_justificativa[motivo_id] required	(Int) ID do Motivo.
cartao_ponto_justificativa[motivo_personalizado_id]	(Int) ID do Motivo personalizado.
cartao_ponto_justificativa[descontar_dsr]	(Boolean) Descontar DSR.
cartao_ponto_justificativa[abonar]	(Boolean) Identifica se a justificativa serve para abonar horas do dia.

Request

Route

POST /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2014/1/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

cartao_ponto_justificativa[data]=2014-01-01&cartao_ponto_justificativa[hora]=04%3A00&cartao_ponto_justificativa[motivo_id]=267869265

cURL

curl "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2014/1/justificativas" -d 'cartao_ponto_justificativa[data]=2014-01-01&cartao_ponto_justificativa[hora]=04%3A00&cartao_ponto_justificativa[motivo_id]=267869265' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) Identificador da Justificativa no cartão ponto.
data	(Date) Data da justificativa.
hora	(Time) Quantidade de horas da justificativa.
descontar_dsr	(Boolean) Descontar DSR.
abonar	(Boolean) Identifica se a justificativa serve para abonar horas do dia.
motivo	(Motivo) motivo da justificativa.
motivo[id]	(Int) ID do Motivo.
motivo[name]	(String) Nome do motivo.
motivo[e_social_id]	(Int) Código da tabela E-Social.
motivo_personalizado	(Motivo) motivo personalizado da justificativa.
motivo_personalizado[id]	(Int) ID do Motivo.
motivo_personalizado[name]	(String) Nome do motivo.
motivo_personalizado[e_social_id]	(Int) Código da tabela E-Social.
errors[hora]	(Array) Mensagens de erros para o campo hora.
errors[motivo_id]	(Array) Mensagens de erros para o campo motivo_id.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"415c991574f348099e48864eb297d222"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 0c3b1869-c896-40ba-89eb-21c01542bae5
X-Runtime: 0.050821
Vary: Origin
Content-Length: 208

Body

{
  "id": 1070701487,
  "data": "2014-01-01",
  "hora": "2000-01-01T04:00:00.000Z",
  "desconta_dsr": false,
  "abonar": true,
  "motivo": {
    "id": 267869265,
    "name": "Afastado(+de15dias)",
    "e_social_id": null
  },
  "motivo_personalizado": null
}

Criando Justificativa - erros

Este método mostra falhas na validação da justificativa.

Endpoint

POST /v1/funcionarios/:funcionario_id/cartao_ponto/:year/:month/justificativas

Parameters

Name	Description
funcionario_id required	(String) UID do funcionário.
year required	(Int) Ano do periodo do cartão ponto. Ex: 2017.
month required	(Int) Mês do periodo do cartão ponto. Ex: 10.
cartao_ponto_justificativa[data] required	(Date) Data da justificativa. Ex: "2017-01-01".
cartao_ponto_justificativa[hora] required	(Time) Quantidade de horas da justificativa. Ex: "08:00".
cartao_ponto_justificativa[motivo_id] required	(Int) ID do Motivo.
cartao_ponto_justificativa[motivo_personalizado_id]	(Int) ID do Motivo personalizado.
cartao_ponto_justificativa[descontar_dsr]	(Boolean) Descontar DSR.
cartao_ponto_justificativa[abonar]	(Boolean) Identifica se a justificativa serve para abonar horas do dia.

Request

Route

POST /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2014/1/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

cartao_ponto_justificativa[data]=2014-01-01

cURL

curl "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2014/1/justificativas" -d 'cartao_ponto_justificativa[data]=2014-01-01' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) Identificador da Justificativa no cartão ponto.
data	(Date) Data da justificativa.
hora	(Time) Quantidade de horas da justificativa.
descontar_dsr	(Boolean) Descontar DSR.
abonar	(Boolean) Identifica se a justificativa serve para abonar horas do dia.
motivo	(Motivo) motivo da justificativa.
motivo[id]	(Int) ID do Motivo.
motivo[name]	(String) Nome do motivo.
motivo[e_social_id]	(Int) Código da tabela E-Social.
motivo_personalizado	(Motivo) motivo personalizado da justificativa.
motivo_personalizado[id]	(Int) ID do Motivo.
motivo_personalizado[name]	(String) Nome do motivo.
motivo_personalizado[e_social_id]	(Int) Código da tabela E-Social.
errors[hora]	(Array) Mensagens de erros para o campo hora.
errors[motivo_id]	(Array) Mensagens de erros para o campo motivo_id.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 4d188532-e5f6-4e47-abd2-699034b60869
X-Runtime: 0.042088
Vary: Origin
Content-Length: 141

Body

{
  "message": "Validation Failed!",
  "errors": {
    "hora": [
      "can't be blank"
    ],
    "motivo_id": [
      "can't be blank"
    ],
    "motivo": [
      "is not included in the list"
    ]
  }
}

Excluindo uma justificativa do cartão ponto

Este método exclui a justificativa do cartão ponto do funcionário.

Endpoint

DELETE /v1/funcionarios/:funcionario_id/cartao_ponto/:year/:month/justificativas/:id

Parameters

Name	Description
funcionario_id required	(String) UID do funcionário.
year required	(Int) Ano do periodo do cartão ponto. Ex: 2017.
month required	(Int) Mês do periodo do cartão ponto. Ex: 10.
id required	(Int) ID da Justificativa.

Request

Route

DELETE /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2014/1/justificativas/516301284

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2014/1/justificativas/516301284" -d '' -X DELETE \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache
X-Request-Id: 8ca9ac32-4a35-4a3b-9827-c1df64fa5274
X-Runtime: 0.041633
Vary: Origin

Listando Justificativas no periodo

Este método retorna um array de justificativas no periodo do cartão ponto do funcionario.

Endpoint

GET /v1/funcionarios/:funcionario_id/cartao_ponto/:year/:month/justificativas

Parameters

Name	Description
funcionario_id required	(String) UID do funcionário.
year required	(Int) Ano do periodo do cartão ponto. Ex: 2017.
month required	(Int) Mês do periodo do cartão ponto. Ex: 10.

Request

Route

GET /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2014/1/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2014/1/justificativas" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) Identificador da Justificativa no cartão ponto.
data	(Date) Data da justificativa.
hora	(Time) Quantidade de horas da justificativa.
descontar_dsr	(Boolean) Descontar DSR.
abonar	(Boolean) Identifica se a justificativa serve para abonar horas do dia.
motivo	(Motivo) Motivo da justificativa.
motivo[id]	(Int) ID do Motivo.
motivo[name]	(String) Nome do motivo.
motivo[e_social_id]	(Int) Código da tabela E-Social.
motivo_personalizado	(Motivo) Motivo personalizado da justificativa.
motivo_personalizado[id]	(Int) ID do Motivo.
motivo_personalizado[name]	(String) Nome do motivo.
motivo_personalizado[e_social_id]	(Int) Código da tabela E-Social.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"028106516bf3b5d5295097ed2395d0c4"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 3c992463-1052-44ca-99c4-6c0bc07fe616
X-Runtime: 0.086083
Vary: Origin
Content-Length: 401

Body

[
  {
    "id": 516301284,
    "data": "2014-01-13",
    "hora": "2000-01-01T08:00:00.000Z",
    "desconta_dsr": false,
    "abonar": true,
    "motivo": {
      "id": 385748469,
      "name": "APS",
      "e_social_id": null
    },
    "motivo_personalizado": null
  },
  {
    "id": 362056319,
    "data": "2014-01-10",
    "hora": "2000-01-01T08:00:00.000Z",
    "desconta_dsr": false,
    "abonar": true,
    "motivo": {
      "id": 267869265,
      "name": "Afastado(+de15dias)",
      "e_social_id": null
    },
    "motivo_personalizado": null
  }
]

Coletas

Creating a Coleta with option to process

This method creates and process a new Coleta.

Endpoint

POST /v1/coletas

Parameters

Name	Description
coleta[arquivo] required	String of filename.
coleta[folha_de_rosto_id]	Folha de Rosto Id.
coleta[equipamento_id]	Equipamento Id. Required if file has no head with equipment details or API current user is not a Funcionario.
coleta[afd]	Boolean if file is an AFD.
coleta[afd_parcial]	Boolean if file is an AFD parcial.
process	Boolean to process the file, set to "true". The request might be little longer.

Request

Route

POST /v1/coletas

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Cookie:

Body

------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="coleta[arquivo]"; filename="AFD_func_1_parcial.txt"
Content-Type: text/txt
Content-Length: 630

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="process"

true
------------XnJLe9ZIbbGUYtzPQJ16u1--

cURL

curl "http://api.lvh.me:3000/v1/coletas" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="coleta[arquivo]"; filename="AFD_func_1_parcial.txt"
Content-Type: text/txt
Content-Length: 630

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="process"

true
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
arquivo	Filename.
processado	Boolean if coleta has been processed.
equipamento	Object that coleta belongs to.
equipamento[name]	Name.
equipamento[fabricante]	Fabricante name.
equipamento[modelo_equipamento]	Modelo Equipamento.
equipamento[ip]	IP address.
equipamento[nequipamento]	Nequipamento.
equipamento[nserie_rep]	Serial number of equipment.
equipamento[ativo]	Boolean state of equipment.
equipamento[integration_rep]	Boolean if has integration with REP.
equipamento[total_marcacoes]	Count of marcações.
equipamento[total_marcacoes_bobina]	Count of marcações/bobina.
equipamento[metragem_bobina_recomendada]	Metragem Bobina Recomendada.
created_at	Creation DateTime.
updated_at	Update DateTime.
folha_de_rosto	Folha de rosto Object that coleta belongs to.
first_line_date	DateTime of first line.
last_line_date	DateTime of last line.
post_messages	Array of notice messages after creation.
message	String alert about response.
errors	Object with field names that contain validation errors.
errors[arquivo]	Array of error messages of field arquivo.
errors[equipamento_id]	Array of error messages of field equipamento_id.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"7e58a1c90ce02debe9e4508414f8bc5e"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 3422d6e7-e310-45fa-bca3-055c18e06da3
X-Runtime: 0.293136
Vary: Origin
Content-Length: 1028

Body

{
  "arquivo": "AFD_func_1_parcial.txt",
  "processado": true,
  "equipamento": {
    "id": 51636476,
    "name": "app",
    "fabricante": null,
    "modelo_equipamento": null,
    "ip": "192.168.254.40",
    "nequipamento": null,
    "nserie_rep": "153Qu3uJSzX7tAV6rN3FHp3-3zgR-KZ_TYkzCoeqQLa26YekcMJzxE8HVit2",
    "ativo": true,
    "integration_rep": false,
    "total_marcacoes": null,
    "total_marcacoes_bobina": null,
    "metragem_bobina_recomendada": null,
    "cpf": null,
    "app": true,
    "empresa_uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
  },
  "created_at": "2023-09-27T09:51:29.888-03:00",
  "updated_at": "2023-09-27T09:51:30.126-03:00",
  "folha_de_rosto": null,
  "first_line_date": "2019-09-01T08:01:00.000+00:00",
  "last_line_date": "2019-09-03T17:08:00.000+00:00",
  "post_messages": [
    "NSR error, line 2, verify equipment port communication and try again. If the issue persists contact us.",
    " This \"coleta\" has \"marcações\" until Tue, 03 Sep 2019 17:08:00 +0000. After this date will not be possible to see the \"marcações\" in the system. If you want actual \"marcações\" then try to import again."
  ],
  "unshared": true
}

Creating a Coleta with user Funcionario

This method creates a new Coleta by user Funcionario.

Endpoint

POST /v1/coletas

Parameters

Name	Description
coleta[arquivo] required	String of filename.
coleta[folha_de_rosto_id]	Folha de Rosto Id.
coleta[equipamento_id]	Equipamento Id. Required if file has no head with equipment details or API current user is not a Funcionario.
coleta[afd]	Boolean if file is an AFD.
coleta[afd_parcial]	Boolean if file is an AFD parcial.
process	Boolean to process the file, set to "true". The request might be little longer.

Request

Route

POST /v1/coletas

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Cookie:

Body

------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="coleta[arquivo]"; filename="AFD_func_1_parcial.txt"
Content-Type: text/txt
Content-Length: 630

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

cURL

curl "http://api.lvh.me:3000/v1/coletas" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="coleta[arquivo]"; filename="AFD_func_1_parcial.txt"
Content-Type: text/txt
Content-Length: 630

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
arquivo	Filename.
processado	Boolean if coleta has been processed.
equipamento	Object that coleta belongs to.
equipamento[name]	Name.
equipamento[fabricante]	Fabricante name.
equipamento[modelo_equipamento]	Modelo Equipamento.
equipamento[ip]	IP address.
equipamento[nequipamento]	Nequipamento.
equipamento[nserie_rep]	Serial number of equipment.
equipamento[ativo]	Boolean state of equipment.
equipamento[integration_rep]	Boolean if has integration with REP.
equipamento[total_marcacoes]	Count of marcações.
equipamento[total_marcacoes_bobina]	Count of marcações/bobina.
equipamento[metragem_bobina_recomendada]	Metragem Bobina Recomendada.
created_at	Creation DateTime.
updated_at	Update DateTime.
folha_de_rosto	Folha de rosto Object that coleta belongs to.
first_line_date	DateTime of first line.
last_line_date	DateTime of last line.
post_messages	Array of notice messages after creation.
message	String alert about response.
errors	Object with field names that contain validation errors.
errors[arquivo]	Array of error messages of field arquivo.
errors[equipamento_id]	Array of error messages of field equipamento_id.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"68a865bd7047430d4dbfce18374d6650"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e21a10c6-2756-4c9d-828a-773bf2eda134
X-Runtime: 0.085003
Vary: Origin
Content-Length: 1029

Body

{
  "arquivo": "AFD_func_1_parcial.txt",
  "processado": false,
  "equipamento": {
    "id": 51636476,
    "name": "app",
    "fabricante": null,
    "modelo_equipamento": null,
    "ip": "192.168.254.40",
    "nequipamento": null,
    "nserie_rep": "A--uAu2b6zyBhAz9SpeeWj7XqxaoppAdZJrHb8pvzdTZoEHBkPGwJrx9posG",
    "ativo": true,
    "integration_rep": false,
    "total_marcacoes": null,
    "total_marcacoes_bobina": null,
    "metragem_bobina_recomendada": null,
    "cpf": null,
    "app": true,
    "empresa_uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
  },
  "created_at": "2023-09-27T09:51:29.821-03:00",
  "updated_at": "2023-09-27T09:51:29.836-03:00",
  "folha_de_rosto": null,
  "first_line_date": "2019-09-01T08:01:00.000+00:00",
  "last_line_date": "2019-09-03T17:08:00.000+00:00",
  "post_messages": [
    "NSR error, line 2, verify equipment port communication and try again. If the issue persists contact us.",
    " This \"coleta\" has \"marcações\" until Tue, 03 Sep 2019 17:08:00 +0000. After this date will not be possible to see the \"marcações\" in the system. If you want actual \"marcações\" then try to import again."
  ],
  "unshared": true
}

Creating a coleta

This method creates a new coleta.

Endpoint

POST /v1/coletas

Parameters

Name	Description
coleta[arquivo] required	String of filename.
coleta[folha_de_rosto_id]	Folha de Rosto Id.
coleta[equipamento_id]	Equipamento Id. Required if file has no head with equipment details or API current user is not a Funcionario.
coleta[afd]	Boolean if file is an AFD.
coleta[afd_parcial]	Boolean if file is an AFD parcial.
process	Boolean to process the file, set to "true". The request might be little longer.

Request

Route

POST /v1/coletas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Cookie:

Body

------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="coleta[arquivo]"; filename="AFD_HEAD.txt"
Content-Type: text/txt
Content-Length: 3404

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

cURL

curl "http://api.lvh.me:3000/v1/coletas" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="coleta[arquivo]"; filename="AFD_HEAD.txt"
Content-Type: text/txt
Content-Length: 3404

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
arquivo	Filename.
processado	Boolean if coleta has been processed.
equipamento	Object that coleta belongs to.
equipamento[name]	Name.
equipamento[fabricante]	Fabricante name.
equipamento[modelo_equipamento]	Modelo Equipamento.
equipamento[ip]	IP address.
equipamento[nequipamento]	Nequipamento.
equipamento[nserie_rep]	Serial number of equipment.
equipamento[ativo]	Boolean state of equipment.
equipamento[integration_rep]	Boolean if has integration with REP.
equipamento[total_marcacoes]	Count of marcações.
equipamento[total_marcacoes_bobina]	Count of marcações/bobina.
equipamento[metragem_bobina_recomendada]	Metragem Bobina Recomendada.
created_at	Creation DateTime.
updated_at	Update DateTime.
folha_de_rosto	Folha de rosto Object that coleta belongs to.
first_line_date	DateTime of first line.
last_line_date	DateTime of last line.
post_messages	Array of notice messages after creation.
message	String alert about response.
errors	Object with field names that contain validation errors.
errors[arquivo]	Array of error messages of field arquivo.
errors[equipamento_id]	Array of error messages of field equipamento_id.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"792ede49501f4a0cde7bc0c8090aa380"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 571f4b2c-4860-40f6-980b-26bc48854555
X-Runtime: 0.110158
Vary: Origin
Content-Length: 868

Body

{
  "arquivo": "AFD_HEAD.txt",
  "processado": false,
  "equipamento": {
    "id": 851363599,
    "name": "Equipamento não cadastrado 851363599",
    "fabricante": null,
    "modelo_equipamento": null,
    "ip": null,
    "nequipamento": "851363599",
    "nserie_rep": "00042002250000110",
    "ativo": true,
    "integration_rep": false,
    "total_marcacoes": null,
    "total_marcacoes_bobina": null,
    "metragem_bobina_recomendada": null,
    "cpf": null,
    "app": false,
    "empresa_uid": null
  },
  "created_at": "2023-09-27T09:51:29.686-03:00",
  "updated_at": "2023-09-27T09:51:29.686-03:00",
  "folha_de_rosto": null,
  "first_line_date": "2014-11-03T11:30:00.000+00:00",
  "last_line_date": "2014-11-10T16:37:00.000+00:00",
  "post_messages": [
    " This \"coleta\" has \"marcações\" until Mon, 10 Nov 2014 16:37:00 +0000. After this date will not be possible to see the \"marcações\" in the system. If you want actual \"marcações\" then try to import again."
  ],
  "unshared": false
}

Creating a coleta - errors

This method shows validation fails.

Endpoint

POST /v1/coletas

Parameters

Name	Description
coleta[arquivo] required	String of filename.
coleta[folha_de_rosto_id]	Folha de Rosto Id.
coleta[equipamento_id]	Equipamento Id. Required if file has no head with equipment details or API current user is not a Funcionario.
coleta[afd]	Boolean if file is an AFD.
coleta[afd_parcial]	Boolean if file is an AFD parcial.
process	Boolean to process the file, set to "true". The request might be little longer.

Request

Route

POST /v1/coletas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/json
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/coletas" -d '' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/json" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
arquivo	Filename.
processado	Boolean if coleta has been processed.
equipamento	Object that coleta belongs to.
equipamento[name]	Name.
equipamento[fabricante]	Fabricante name.
equipamento[modelo_equipamento]	Modelo Equipamento.
equipamento[ip]	IP address.
equipamento[nequipamento]	Nequipamento.
equipamento[nserie_rep]	Serial number of equipment.
equipamento[ativo]	Boolean state of equipment.
equipamento[integration_rep]	Boolean if has integration with REP.
equipamento[total_marcacoes]	Count of marcações.
equipamento[total_marcacoes_bobina]	Count of marcações/bobina.
equipamento[metragem_bobina_recomendada]	Metragem Bobina Recomendada.
created_at	Creation DateTime.
updated_at	Update DateTime.
folha_de_rosto	Folha de rosto Object that coleta belongs to.
first_line_date	DateTime of first line.
last_line_date	DateTime of last line.
post_messages	Array of notice messages after creation.
message	String alert about response.
errors	Object with field names that contain validation errors.
errors[arquivo]	Array of error messages of field arquivo.
errors[equipamento_id]	Array of error messages of field equipamento_id.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 2587d6a2-a82c-4310-8e67-e349d25ce500
X-Runtime: 0.040655
Vary: Origin
Content-Length: 105

Body

{
  "message": "Validation Failed!",
  "errors": {
    "arquivo": [
      "can't be blank"
    ],
    "equipamento": [
      "can't be blank"
    ]
  }
}

Departamentos

Listando Departamentos

Este método retorna um array de departamentos.

Endpoint

GET /v1/departamentos

Request

Route

GET /v1/departamentos

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/departamentos" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
uid	(String) UID do Departamento.
name	(String) Nome do departamento.
empresa	(Empresa) Objeto [Empresa] com dados sobre a empresa vinculada.
ativo	(Boolean) Se o departamento está atualmente ativo.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"ff24bf31aa212fabce80d18704099331"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e48f412d-e953-48d1-a5ee-618823c28468
X-Runtime: 0.043575
Vary: Origin
Content-Length: 347

Body

[
  {
    "uid": "0e2a94fe-7663-4f52-9a56-679ffff4c490",
    "name": "Nome do departamento",
    "empresa": {
      "uid": "c43becdf-ba77-4062-97c0-58f3335dad92",
      "name": "Empresa01",
      "nome_fantasia": "EmpFantasia01",
      "cnpj": "00.000.000/0000-01",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": null,
      "contact": null,
      "codigo_registro_folha": null,
      "ativo": true
    },
    "ativo": true
  }
]

Empresas

Listando Empresas

Este método retorna um array de empresas.

Endpoint

GET /v1/empresas

Request

Route

GET /v1/empresas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/empresas" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
uid	(String) UID da Empresa.
name	(String) Razão social.
nome_fantasia	(String) Nome fantasia.
cnpj	(String) CNPJ.
cei	(String) CEI.
cpf	(String) CPF.
inscricao_estadual	(String) Inscrição Estadual.
address	(Address) Objeto com dados do endereço.
address[cep]	(String) CEP.
address[city]	(String) Cidade.
address[complement]	(String) Complemento.
address[country]	(String) País.
address[number]	(String) Número.
address[state]	(String) Estado.
address[street]	(String) Logradouro.
address[district]	(String) Bairro.
contact	(Contact) Objeto com dados do contato.
contact[name]	(String) Nome do responsável.
contact[email]	(String) E-mail.
contact[phone]	(String) Telefone.
contact[cpf]	(String) CPF.
contact[site]	(String) Endereço do Site.
contact[whatsapp]	(String) Número de Whatsapp.
contact[instagram]	(String) Endereço do instagram.
codigo_registro_folha	(String) Código do registro de folha de pagamento.
ativo	(Boolean) Se a empresa está atualmente ativa.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"e36034eac8197984ab31bb64484b68aa"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 6666332e-fae8-4e71-82bb-ab6cce2395c6
X-Runtime: 0.041101
Vary: Origin
Content-Length: 489

Body

[
  {
    "uid": "3d1f4aef-102d-4ef1-8304-3484f25431f7",
    "name": "Nome Da Empresa",
    "nome_fantasia": "Nome Fantasia",
    "cnpj": null,
    "cei": null,
    "cpf": null,
    "inscricao_estadual": null,
    "address": {
      "cep": "85020-001",
      "city": "Cidade",
      "complement": null,
      "country": "Brasil",
      "number": null,
      "state": "PR",
      "street": null,
      "district": null
    },
    "contact": {
      "email": "[email protected]",
      "name": "Nome Do Contato",
      "phone": "4236223344",
      "cpf": null,
      "whatsapp": null,
      "site": null,
      "instagram": null
    },
    "codigo_registro_folha": null,
    "ativo": true
  }
]

Equipamentos

Adicionando usuário

Este método registra um usuário para registro de ponto. Apenas equipamentos virtuais do tipo “app” são permitidos.

Endpoint

POST /v1/equipamentos/:id/usuarios/:cpf

Parameters

Name	Description
id	(Int) Id do equipamento virtual (Apenas equipamentos do tipo "app")
cpf	(Int) CPF do funcionário (somente números)

Request

Route

POST /v1/equipamentos/51636476/usuarios/07155744989

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/equipamentos/51636476/usuarios/07155744989" -d '' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
cpf	(String) CPF do funcionário.
password	(String) Senha para registro de pontos.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"20da5acf9d9b0909e6841842011b9889"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 6b3f35b5-169b-4890-adc1-409deb9f4170
X-Runtime: 0.236051
Vary: Origin
Content-Length: 41

Body

{
  "cpf": "07155744989",
  "password": "699478"
}

Listando Equipamentos

Este método retorna um array de equipamentos.

Endpoint

GET /v1/equipamentos

Parameters

Name	Description
per_page	(Int) Número de registros por página. Padrão: 5.
page	(Int) Número da página de referência da paginação. Padrão: 1.

Request

Route

GET /v1/equipamentos

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/equipamentos" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
X-Current-Page	(Int) [Header] Página atual da paginação.
X-Per-Page	(Int) [Header] Número máximo de registros da resposta à requisição.
name	(String) Nome do equipamento.
fabricante	(String) Nome do fabricante.
modelo_equipamento	(String) Nome do modelo do equipamento.
ip	(String) IP local do equipamento.
nequipamento	(String) Número do equipamento.
nserie_rep	(String) Número de Série do equipamento.
ativo	(Boolean) Equipamento ativo?
integration_rep	(Boolean) Integração com o REP está disponível?
total_marcacoes	(Int) Total de marcações.
total_marcacoes_bobina	(Int) Total de marcações para Bobina.
metragem_bobina_recomendada	(String) Metragem da bobina recomendada para o equipamento.
cpf	(String) CPF da licença do equipamento.
app	(Booleano) Equipamento do tipo virtual do tipo "app".
empresa_uid	(String) Identificador da empresa.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Per-Page: 5
X-Current-Page: 1
Content-Type: application/json; charset=utf-8
ETag: W/"b150a771dd76be76121f955ae33964d2"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 47d5d822-5872-402c-aca9-af26e6687620
X-Runtime: 0.085601
Vary: Origin
Content-Length: 1707

Body

[
  {
    "id": 193764514,
    "name": "equipamento01",
    "fabricante": "HENRY",
    "modelo_equipamento": "primme sf",
    "ip": "192.168.254.20",
    "nequipamento": "1",
    "nserie_rep": "01111000011110000",
    "ativo": true,
    "integration_rep": false,
    "total_marcacoes": null,
    "total_marcacoes_bobina": null,
    "metragem_bobina_recomendada": null,
    "cpf": null,
    "app": false,
    "empresa_uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
  },
  {
    "id": 310758694,
    "name": "equipamento02",
    "fabricante": null,
    "modelo_equipamento": null,
    "ip": "192.168.254.20",
    "nequipamento": "2",
    "nserie_rep": "40200896286722",
    "ativo": true,
    "integration_rep": false,
    "total_marcacoes": null,
    "total_marcacoes_bobina": null,
    "metragem_bobina_recomendada": null,
    "cpf": null,
    "app": false,
    "empresa_uid": null
  },
  {
    "id": 648772564,
    "name": "equipamento03",
    "fabricante": null,
    "modelo_equipamento": null,
    "ip": "192.168.254.30",
    "nequipamento": "2",
    "nserie_rep": "40200896286723",
    "ativo": true,
    "integration_rep": false,
    "total_marcacoes": null,
    "total_marcacoes_bobina": null,
    "metragem_bobina_recomendada": null,
    "cpf": null,
    "app": false,
    "empresa_uid": null
  },
  {
    "id": 393371806,
    "name": "equipamento04",
    "fabricante": null,
    "modelo_equipamento": null,
    "ip": "192.168.254.40",
    "nequipamento": "2",
    "nserie_rep": "12345678912345678",
    "ativo": true,
    "integration_rep": false,
    "total_marcacoes": null,
    "total_marcacoes_bobina": null,
    "metragem_bobina_recomendada": null,
    "cpf": null,
    "app": false,
    "empresa_uid": null
  },
  {
    "id": 51636476,
    "name": "app",
    "fabricante": null,
    "modelo_equipamento": null,
    "ip": "192.168.254.40",
    "nequipamento": null,
    "nserie_rep": "1234567891234567834232323sadfsdf2332r",
    "ativo": true,
    "integration_rep": false,
    "total_marcacoes": null,
    "total_marcacoes_bobina": null,
    "metragem_bobina_recomendada": null,
    "cpf": null,
    "app": true,
    "empresa_uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
  }
]

Obtendo o comprovante em formato pdf do ponto

Este método retorna o arquivo do comprovante do ponto em formato pdf (somente para equipamentos app).

Endpoint

GET /v1/equipamentos/:equipamento_id/pontos/:id.pdf

Parameters

Name	Description
equipamento_id	(Int) ID do Equipamento (obs: o equipamento deve ser do tipo "app").
id	(Int) ID do Ponto.

Request

Route

GET /v1/equipamentos/51636476/pontos/215362412.pdf

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/equipamentos/51636476/pontos/215362412.pdf" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Disposition: attachment; filename="comprovante-1.pdf"
Content-Transfer-Encoding: binary
Content-Type: application/pdf
Cache-Control: private
X-Request-Id: a9458451-4862-4568-8dc7-7c4fecf259ad
X-Runtime: 0.272862
Vary: Origin
Content-Length: 37592

Body

[binary data]

Registrando o ponto

Este método registra o ponto para um funcionário. Apenas equipamentos virtuais do tipo “app” são permitidos.

Endpoint

POST /v1/equipamentos/:id/pontos

Parameters

Name	Description
id	(Int) Id do equipamento virtual (Apenas equipamentos do tipo "app").
password	(String) Senha de registro do usuário do equipamento.

Request

Route

POST /v1/equipamentos/51636476/pontos

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

password=536368

cURL

curl "http://api.lvh.me:3000/v1/equipamentos/51636476/pontos" -d 'password=536368' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Date) Data de registro do ponto.
hora	(DateTime) Hora do registro do ponto.
equipamento_id	(Int) Id do equipamento que foi registrado o ponto.
processado	(Boolean) Se a coleta que pertence o ponto já foi processada.
nsr	(Int) Número sequencial de registro.
registro_inpi	(String) Número do registro INPI.
coletor_id	(Int) Identificação do equipamento de coleta. Valores: 1 - Mobile, 2 - Web.
offline	(Bool) Se o ponto foi registrado offline.
cpf	(Int) CPF do funcionário.
codigo_hash	(String) SHA-256 dos dados registrados.
utc_offset	(String) Deslocamento UTC da marcação.
ponto_geo_locale[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto_geo_locale[longitude]	(Float) Longitude do registro do Ponto (quando disponível).
funcionario[uid]	(String) Funcionário UID.
funcionario[cpf]	(String) Identificador de CPF.
funcionario[data_admissao]	(Date) Data de admissão.
funcionario[data_demissao]	(Date) Data de demissão.
funcionario[name]	(String) Nome do funcionário.
funcionario[pis]	(String) Identificador de PIS.
funcionario[registro_folha]	(String) Identificador de Registro de Folha de pagamento.
funcionario[rg]	(String) Identificador de RG.
funcionario[nacionalidade]	(String) Nacionalidade.
funcionario[nome_da_mae]	(String) Nome da mãe.
funcionario[nome_do_pai]	(String) Nome da pai.
funcionario[estado_civil]	(String) Estado civil.
funcionario[conjuge]	(String) Nome do conjuge.
funcionario[nascimento]	(Date) Data de nascimento.
funcionario[ctps]	(String) Identificador de CTPS.
funcionario[cnh]	(String) Identificador de CNH.
funcionario[certidao_militar]	(String) Identificador de Certidão Militar.
funcionario[tipo_sanguineo]	(String) Tipo sanguíneo.
funcionario[escolaridade]	(String) Escolaridade.
funcionario[observacoes]	(String) Observações.
funcionario[biometria]	(String) Hash da biometria cadastrada em um equipamento.
funcionario[cargos]	(Array) Cargos do funcionário.
cargos[data]	(Date) Data de atribuição do cargo.
cargos[funcao]	(String) Nome da função.
cargos[name]	(String) Nome do cargo.
funcionario[exames]	(Array) Exames do funcionário.
exames[data]	(Date) Data de atribuição do cargo.
exames[apto]	(Boolean) Apto?
funcionario[dependentes]	(Array) Dependentes do funcionário.
dependentes[name]	(String) Nome do dependente.
dependentes[birth]	(Date) Data de nascimento.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"85b63c15d65923e16ce82cb3ad38c6da"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 6a6c77e7-9b15-449a-ad0a-f440e853e6c0
X-Runtime: 0.233077
Vary: Origin
Content-Length: 1718

Body

{
  "id": 1071408923,
  "data": "2023-09-27",
  "hora": "09:51",
  "equipamento_id": 51636476,
  "processado": false,
  "ponto_geo_locale": null,
  "nsr": 1,
  "registro_inpi": "BR512022000771-1 e BR512022000798-3",
  "coletor_id": 2,
  "offline": false,
  "created_at": "2023-09-27T09:51:34.311-03:00",
  "cpf": "07155744989",
  "codigo_hash": "31b611acb0bee2ddc84e20cdd1112cffa283115fb9d085727f7fdc09a323bb06",
  "utc_offset": "-0300",
  "funcionario": {
    "cpf": "07155744989",
    "cracha": "1",
    "data_admissao": null,
    "data_demissao": null,
    "name": "Func1",
    "pis": "123929234315",
    "registro_folha": "1",
    "rg": null,
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [
      {
        "data": "2017-01-10",
        "funcao": "test",
        "name": "Auxiliar (123456)"
      },
      {
        "data": "2018-01-01",
        "funcao": "auxiliar",
        "name": null
      }
    ],
    "exames": [
      {
        "data": "2017-01-10",
        "apto": true,
        "tipo_exame": null,
        "observacoes": null,
        "arquivo": {
          "url": null
        }
      }
    ],
    "empresa": {
      "id": 471928375,
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "inscricao_estadual": null,
      "cpf": null,
      "created_at": "2023-09-27T09:51:27.000-03:00",
      "updated_at": "2023-09-27T09:51:27.000-03:00",
      "cliente_id": 571096427,
      "cei": null,
      "codigo_registro_folha": "23",
      "ativo": true,
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
    },
    "departamento": {
      "id": 980190962,
      "name": "Departamento01 (Empresa03)",
      "empresa_id": 471928375,
      "created_at": "2023-09-27T09:51:27.000-03:00",
      "updated_at": "2023-09-27T09:51:27.000-03:00",
      "ativo": true,
      "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
      "codigo_registro_folha": "1",
      "full_name": "Departamento01 (Empresa03)"
    },
    "biometria": null
  }
}

Registrando o ponto - falha de senha não encontrada

Este método mostra falha quando a senha do funcionário não é encontrada.

Endpoint

POST /v1/equipamentos/:id/pontos

Parameters

Name	Description
id	(Int) Id do equipamento virtual (Apenas equipamentos do tipo "app").
password	(String) Senha de registro do usuário do equipamento.

Request

Route

POST /v1/equipamentos/51636476/pontos

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

password=1234

cURL

curl "http://api.lvh.me:3000/v1/equipamentos/51636476/pontos" -d 'password=1234' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Date) Data de registro do ponto.
hora	(DateTime) Hora do registro do ponto.
equipamento_id	(Int) Id do equipamento que foi registrado o ponto.
processado	(Boolean) Se a coleta que pertence o ponto já foi processada.
nsr	(Int) Número sequencial de registro.
registro_inpi	(String) Número do registro INPI.
coletor_id	(Int) Identificação do equipamento de coleta. Valores: 1 - Mobile, 2 - Web.
offline	(Bool) Se o ponto foi registrado offline.
cpf	(Int) CPF do funcionário.
codigo_hash	(String) SHA-256 dos dados registrados.
utc_offset	(String) Deslocamento UTC da marcação.
ponto_geo_locale[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto_geo_locale[longitude]	(Float) Longitude do registro do Ponto (quando disponível).
funcionario[uid]	(String) Funcionário UID.
funcionario[cpf]	(String) Identificador de CPF.
funcionario[data_admissao]	(Date) Data de admissão.
funcionario[data_demissao]	(Date) Data de demissão.
funcionario[name]	(String) Nome do funcionário.
funcionario[pis]	(String) Identificador de PIS.
funcionario[registro_folha]	(String) Identificador de Registro de Folha de pagamento.
funcionario[rg]	(String) Identificador de RG.
funcionario[nacionalidade]	(String) Nacionalidade.
funcionario[nome_da_mae]	(String) Nome da mãe.
funcionario[nome_do_pai]	(String) Nome da pai.
funcionario[estado_civil]	(String) Estado civil.
funcionario[conjuge]	(String) Nome do conjuge.
funcionario[nascimento]	(Date) Data de nascimento.
funcionario[ctps]	(String) Identificador de CTPS.
funcionario[cnh]	(String) Identificador de CNH.
funcionario[certidao_militar]	(String) Identificador de Certidão Militar.
funcionario[tipo_sanguineo]	(String) Tipo sanguíneo.
funcionario[escolaridade]	(String) Escolaridade.
funcionario[observacoes]	(String) Observações.
funcionario[biometria]	(String) Hash da biometria cadastrada em um equipamento.
funcionario[cargos]	(Array) Cargos do funcionário.
cargos[data]	(Date) Data de atribuição do cargo.
cargos[funcao]	(String) Nome da função.
cargos[name]	(String) Nome do cargo.
funcionario[exames]	(Array) Exames do funcionário.
exames[data]	(Date) Data de atribuição do cargo.
exames[apto]	(Boolean) Apto?
funcionario[dependentes]	(Array) Dependentes do funcionário.
dependentes[name]	(String) Nome do dependente.
dependentes[birth]	(Date) Data de nascimento.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 67414549-e668-4e2b-b132-9cdfc3cf3494
X-Runtime: 0.194429
Vary: Origin
Content-Length: 75

Body

{
  "message": "Validation Failed!",
  "errors": {
    "password": [
      "Record not found"
    ]
  }
}

Registrando usuário - falha de cpf não encontrado

Este método mostra falha quando o cpf do funcionário não é encontrado.

Endpoint

POST /v1/equipamentos/:id/usuarios/:cpf

Parameters

Name	Description
id	(Int) Id do equipamento virtual (Apenas equipamentos do tipo "app")
cpf	(Int) CPF do funcionário (somente números)

Request

Route

POST /v1/equipamentos/51636476/usuarios/3

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/equipamentos/51636476/usuarios/3" -d '' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
cpf	(String) CPF do funcionário.
password	(String) Senha para registro de pontos.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: da236245-49c3-40cd-a8bc-560cc6709eee
X-Runtime: 0.038764
Vary: Origin
Content-Length: 82

Body

{
  "message": "Validation Failed!",
  "errors": {
    "cpf": [
      "Funcionário não encontrado"
    ]
  }
}

Funcionário > Extrato Banco de horas

Listando extrato do banco de horas para o funcionário

Este método retorna um objeto para o período do cartão ponto.

Endpoint

GET /v1/relatorios/funcionario/:funcionario_uid/extrato-de-banco-de-horas/:year/:month

Parameters

Name	Description
funcionario_uid	(String) UID do funcionário.
year	(Int) Ano do período.
date	(Int) Mês do período.

Request

Route

GET /v1/relatorios/funcionario/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d1/extrato-de-banco-de-horas/2015/12

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/relatorios/funcionario/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d1/extrato-de-banco-de-horas/2015/12" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario_uid	(String) UID do funcionário.
dates	(Array) Array de objetos para as datas de extrato.
date	(Date) Data da movimentação.
credit	(DateTime) Quantidade de horas de crédito.
debit	(DateTime) Quantidade de horas de Débito.
total[]	(Int). Saldo até a data (em segundos).
total	(Int) Saldo total (em segundos).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"eec3657ec176491f9a3a96f6e5e142de"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: f9370fa2-b6ff-4d24-b99c-d88f6672c840
X-Runtime: 0.056181
Vary: Origin
Content-Length: 167

Body

{
  "funcionario_uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d1",
  "dates": [
    {
      "date": "2015-12-01",
      "debit": "2000-01-01T01:00:32.000Z",
      "credit": null,
      "total": -3600
    }
  ],
  "total": -3600
}

Resposta para funcionário não encontrado

Endpoint

GET /v1/relatorios/funcionario/:funcionario_uid/extrato-de-banco-de-horas/:year/:month

Parameters

Name	Description
funcionario_uid	(String) UID do funcionário.
year	(Int) Ano do período.
date	(Int) Mês do período.

Request

Route

GET /v1/relatorios/funcionario/1/extrato-de-banco-de-horas/2015/12

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/relatorios/funcionario/1/extrato-de-banco-de-horas/2015/12" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario_uid	(String) UID do funcionário.
dates	(Array) Array de objetos para as datas de extrato.
date	(Date) Data da movimentação.
credit	(DateTime) Quantidade de horas de crédito.
debit	(DateTime) Quantidade de horas de Débito.
total[]	(Int). Saldo até a data (em segundos).
total	(Int) Saldo total (em segundos).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: f999c31c-2bbf-49e2-b18f-e7f05ed3a55a
X-Runtime: 0.024300
Vary: Origin
Content-Length: 82

Body

{
  "message": "Validation Failed!",
  "errors": {
    "funcionario_uid": [
      "Record not found"
    ]
  }
}

Funcionários

Alterando o funcionário

Este método altera os dados cadastrais do funcionário.

Endpoint

PATCH /v1/funcionarios/:uid

Parameters

Name	Description
uid required	(String) UID do funcionário.
funcionario[pis] required	(String) Identificador de PIS.
funcionario[cpf]	(String) Identificador de CPF.
funcionario[data_admissao] required	(Date) Data de admissão.
funcionario[data_demissao]	(Date) Data de demissão.
funcionario[name] required	(String) Nome do funcionário.
funcionario[empresa_id] required	(String) UID da Empresa.
funcionario[departamento_id]	(String) UID do Departamento.
funcionario[registro_folha]	(String) Identificador de Registro de Folha de pagamento.
funcionario[rg]	(String) Identificador de RG.
funcionario[nacionalidade]	(String) Nacionalidade.
funcionario[nome_da_mae]	(String) Nome da mãe.
funcionario[nome_do_pai]	(String) Nome da pai.
funcionario[estado_civil]	(String) Estado civil.
funcionario[conjuge]	(String) Nome do conjuge.
funcionario[nascimento]	(Date) Data de nascimento.
funcionario[ctps]	(String) Identificador de CTPS.
funcionario[cnh]	(String) Identificador de CNH.
funcionario[certidao_militar]	(String) Identificador de Certidão Militar.
funcionario[tipo_sanguineo]	(String) Tipo sanguíneo.
funcionario[escolaridade]	(String) Escolaridade.
funcionario[observacoes]	(String) Observações.
funcionario[biometria]	(String) Hash da biometria cadastrada em um equipamento.
funcionario[funcionario_cargos_attributes]	(Array) Cargos do funcionário.
funcionario_cargos_attributes[data]	(Date) Data de atribuição do cargo.
funcionario_cargos_attributes[funcao]	(String) Nome da função.
funcionario_cargos_attributes[name]	(String) Nome do cargo.
funcionario[funcionario_exames_attributes]	(Array) Exames do funcionário.
funcionario_exames_attributes[data]	(Date) Data de atribuição do cargo.
funcionario_exames_attributes[apto]	(Boolean) Apto?
funcionario[funcionario_dependentes_attributes]	(Array) Dependentes do funcionário.
funcionario_dependentes_attributes[name]	(String) Nome do dependente.
funcionario_dependentes_attributes[birth]	(Date) Data de nascimento.

Request

Route

PATCH /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

funcionario[name]=Katia

cURL

curl "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0" -d 'funcionario[name]=Katia' -X PATCH \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
uid	(String) Funcionário ID.
cpf	(String) Identificador de CPF.
data_admissao	(Date) Data de admissão.
data_demissao	(Date) Data de demissão.
name	(String) Nome do funcionário.
pis	(String) Identificador de PIS.
registro_folha	(String) Identificador de Registro de Folha de pagamento.
rg	(String) Identificador de RG.
nacionalidade	(String) Nacionalidade.
nome_da_mae	(String) Nome da mãe.
nome_do_pai	(String) Nome da pai.
estado_civil	(String) Estado civil.
conjuge	(String) Nome do conjuge.
nascimento	(Date) Data de nascimento.
ctps	(String) Identificador de CTPS.
cnh	(String) Identificador de CNH.
certidao_militar	(String) Identificador de Certidão Militar.
tipo_sanguineo	(String) Tipo sanguíneo.
escolaridade	(String) Escolaridade.
observacoes	(String) Observações.
biometria	(String) Hash da biometria cadastrada em um equipamento.
cargos	(Array) Cargos do funcionário.
cargos[data]	(Date) Data de atribuição do cargo.
cargos[funcao]	(String) Nome da função.
cargos[name]	(String) Nome do cargo.
exames	(Array) Exames do funcionário.
exames[data]	(Date) Data de atribuição do cargo.
exames[apto]	(Boolean) Apto?
dependentes	(Array) Dependentes do funcionário.
dependentes[name]	(String) Nome do dependente.
dependentes[birth]	(Date) Data de nascimento.
errors[name]	(Array) Mensagens de erros para o campo name.
errors[pis]	(Array) Mensagens de erros para o campo PIS.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"9dad42faad6bb3f1ef424dd6724bed97"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 7de39df1-d1e0-4b80-aa9b-9551c3ed8950
X-Runtime: 0.045933
Vary: Origin
Content-Length: 1609

Body

{
  "cpf": "07155744989",
  "cracha": "1",
  "data_admissao": "2017-01-01",
  "data_demissao": null,
  "name": "Katia",
  "pis": "123929234315",
  "registro_folha": "123",
  "rg": null,
  "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
  "nacionalidade": null,
  "nome_da_mae": null,
  "nome_do_pai": null,
  "estado_civil": null,
  "conjuge": null,
  "nascimento": null,
  "ctps": null,
  "cnh": null,
  "certidao_militar": null,
  "tipo_sanguineo": null,
  "escolaridade": null,
  "observacoes": null,
  "cargos": [
    {
      "data": "2017-01-10",
      "funcao": "test",
      "name": "Auxiliar (123456)"
    },
    {
      "data": "2018-01-01",
      "funcao": "auxiliar",
      "name": null
    }
  ],
  "exames": [
    {
      "data": "2017-01-10",
      "apto": true,
      "tipo_exame": null,
      "observacoes": null,
      "arquivo": {
        "url": null
      }
    }
  ],
  "empresa": {
    "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
    "name": "Empresa03",
    "nome_fantasia": "EmpFantasia03",
    "cnpj": "00.000.000/0000-03",
    "cei": null,
    "cpf": null,
    "inscricao_estadual": null,
    "address": {
      "cep": "85555-222",
      "city": "Guarapuava",
      "complement": "Apto52",
      "country": "Brasil",
      "number": "101",
      "state": "PR",
      "street": "Rua Armando Ribas",
      "district": "Rua Armando Ribas"
    },
    "contact": null,
    "codigo_registro_folha": "23",
    "ativo": true
  },
  "departamento": {
    "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
    "name": "Departamento01",
    "empresa": {
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "85555-222",
        "city": "Guarapuava",
        "complement": "Apto52",
        "country": "Brasil",
        "number": "101",
        "state": "PR",
        "street": "Rua Armando Ribas",
        "district": "Rua Armando Ribas"
      },
      "contact": null,
      "codigo_registro_folha": "23",
      "ativo": true
    },
    "ativo": true
  },
  "biometria": null
}

Alterando o funcionário - erros

Este método mostra falhas na validação ao alterar o funcionário.

Endpoint

PATCH /v1/funcionarios/:uid

Parameters

Name	Description
uid required	(String) UID do funcionário.
funcionario[pis] required	(String) Identificador de PIS.
funcionario[cpf]	(String) Identificador de CPF.
funcionario[data_admissao] required	(Date) Data de admissão.
funcionario[data_demissao]	(Date) Data de demissão.
funcionario[name] required	(String) Nome do funcionário.
funcionario[empresa_id] required	(String) UID da Empresa.
funcionario[departamento_id]	(String) UID do Departamento.
funcionario[registro_folha]	(String) Identificador de Registro de Folha de pagamento.
funcionario[rg]	(String) Identificador de RG.
funcionario[nacionalidade]	(String) Nacionalidade.
funcionario[nome_da_mae]	(String) Nome da mãe.
funcionario[nome_do_pai]	(String) Nome da pai.
funcionario[estado_civil]	(String) Estado civil.
funcionario[conjuge]	(String) Nome do conjuge.
funcionario[nascimento]	(Date) Data de nascimento.
funcionario[ctps]	(String) Identificador de CTPS.
funcionario[cnh]	(String) Identificador de CNH.
funcionario[certidao_militar]	(String) Identificador de Certidão Militar.
funcionario[tipo_sanguineo]	(String) Tipo sanguíneo.
funcionario[escolaridade]	(String) Escolaridade.
funcionario[observacoes]	(String) Observações.
funcionario[biometria]	(String) Hash da biometria cadastrada em um equipamento.
funcionario[funcionario_cargos_attributes]	(Array) Cargos do funcionário.
funcionario_cargos_attributes[data]	(Date) Data de atribuição do cargo.
funcionario_cargos_attributes[funcao]	(String) Nome da função.
funcionario_cargos_attributes[name]	(String) Nome do cargo.
funcionario[funcionario_exames_attributes]	(Array) Exames do funcionário.
funcionario_exames_attributes[data]	(Date) Data de atribuição do cargo.
funcionario_exames_attributes[apto]	(Boolean) Apto?
funcionario[funcionario_dependentes_attributes]	(Array) Dependentes do funcionário.
funcionario_dependentes_attributes[name]	(String) Nome do dependente.
funcionario_dependentes_attributes[birth]	(Date) Data de nascimento.

Request

Route

PATCH /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

funcionario[name]=

cURL

curl "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0" -d 'funcionario[name]=' -X PATCH \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
uid	(String) Funcionário ID.
cpf	(String) Identificador de CPF.
data_admissao	(Date) Data de admissão.
data_demissao	(Date) Data de demissão.
name	(String) Nome do funcionário.
pis	(String) Identificador de PIS.
registro_folha	(String) Identificador de Registro de Folha de pagamento.
rg	(String) Identificador de RG.
nacionalidade	(String) Nacionalidade.
nome_da_mae	(String) Nome da mãe.
nome_do_pai	(String) Nome da pai.
estado_civil	(String) Estado civil.
conjuge	(String) Nome do conjuge.
nascimento	(Date) Data de nascimento.
ctps	(String) Identificador de CTPS.
cnh	(String) Identificador de CNH.
certidao_militar	(String) Identificador de Certidão Militar.
tipo_sanguineo	(String) Tipo sanguíneo.
escolaridade	(String) Escolaridade.
observacoes	(String) Observações.
biometria	(String) Hash da biometria cadastrada em um equipamento.
cargos	(Array) Cargos do funcionário.
cargos[data]	(Date) Data de atribuição do cargo.
cargos[funcao]	(String) Nome da função.
cargos[name]	(String) Nome do cargo.
exames	(Array) Exames do funcionário.
exames[data]	(Date) Data de atribuição do cargo.
exames[apto]	(Boolean) Apto?
dependentes	(Array) Dependentes do funcionário.
dependentes[name]	(String) Nome do dependente.
dependentes[birth]	(Date) Data de nascimento.
errors[name]	(Array) Mensagens de erros para o campo name.
errors[pis]	(Array) Mensagens de erros para o campo PIS.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 051bfcdd-e366-46b6-b56d-ab0257b660a9
X-Runtime: 0.038014
Vary: Origin
Content-Length: 69

Body

{
  "message": "Validation Failed!",
  "errors": {
    "name": [
      "can't be blank"
    ]
  }
}

Criando funcionário

Este método cria um funcionário.

Endpoint

POST /v1/funcionarios

Parameters

Name	Description
funcionario[pis] required	(String) Identificador de PIS.
funcionario[cpf]	(String) Identificador de CPF.
funcionario[data_admissao] required	(Date) Data de admissão.
funcionario[data_demissao]	(Date) Data de demissão.
funcionario[name] required	(String) Nome do funcionário.
funcionario[empresa_id] required	(String) UID da Empresa.
funcionario[departamento_id]	(String) UID do Departamento.
funcionario[registro_folha]	(String) Identificador de Registro de Folha de pagamento.
funcionario[rg]	(String) Identificador de RG.
funcionario[nacionalidade]	(String) Nacionalidade.
funcionario[nome_da_mae]	(String) Nome da mãe.
funcionario[nome_do_pai]	(String) Nome da pai.
funcionario[estado_civil]	(String) Estado civil.
funcionario[conjuge]	(String) Nome do conjuge.
funcionario[nascimento]	(Date) Data de nascimento.
funcionario[ctps]	(String) Identificador de CTPS.
funcionario[cnh]	(String) Identificador de CNH.
funcionario[certidao_militar]	(String) Identificador de Certidão Militar.
funcionario[tipo_sanguineo]	(String) Tipo sanguíneo.
funcionario[escolaridade]	(String) Escolaridade.
funcionario[observacoes]	(String) Observações.
funcionario[biometria]	(String) Hash da biometria cadastrada em um equipamento.
funcionario[funcionario_cargos_attributes]	(Array) Cargos do funcionário.
funcionario_cargos_attributes[data]	(Date) Data de atribuição do cargo.
funcionario_cargos_attributes[funcao]	(String) Nome da função.
funcionario_cargos_attributes[name]	(String) Nome do cargo.
funcionario[funcionario_exames_attributes]	(Array) Exames do funcionário.
funcionario_exames_attributes[data]	(Date) Data de atribuição do cargo.
funcionario_exames_attributes[apto]	(Boolean) Apto?
funcionario[funcionario_dependentes_attributes]	(Array) Dependentes do funcionário.
funcionario_dependentes_attributes[name]	(String) Nome do dependente.
funcionario_dependentes_attributes[birth]	(Date) Data de nascimento.

Request

Route

POST /v1/funcionarios

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

funcionario[name]=John+Doe&funcionario[pis]=0182.21351.32-2&funcionario[empresa_id]=c43becdf-ba77-4062-97c0-58f3335dad92&funcionario[data_admissao]=2018-01-10&funcionario[funcionario_exames_attributes][][data]=2017-01-01&funcionario[funcionario_exames_attributes][][apto]=1

cURL

curl "http://api.lvh.me:3000/v1/funcionarios" -d 'funcionario[name]=John+Doe&funcionario[pis]=0182.21351.32-2&funcionario[empresa_id]=c43becdf-ba77-4062-97c0-58f3335dad92&funcionario[data_admissao]=2018-01-10&funcionario[funcionario_exames_attributes][][data]=2017-01-01&funcionario[funcionario_exames_attributes][][apto]=1' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
uid	(String) Funcionário ID.
cpf	(String) Identificador de CPF.
data_admissao	(Date) Data de admissão.
data_demissao	(Date) Data de demissão.
name	(String) Nome do funcionário.
pis	(String) Identificador de PIS.
registro_folha	(String) Identificador de Registro de Folha de pagamento.
rg	(String) Identificador de RG.
nacionalidade	(String) Nacionalidade.
nome_da_mae	(String) Nome da mãe.
nome_do_pai	(String) Nome da pai.
estado_civil	(String) Estado civil.
conjuge	(String) Nome do conjuge.
nascimento	(Date) Data de nascimento.
ctps	(String) Identificador de CTPS.
cnh	(String) Identificador de CNH.
certidao_militar	(String) Identificador de Certidão Militar.
tipo_sanguineo	(String) Tipo sanguíneo.
escolaridade	(String) Escolaridade.
observacoes	(String) Observações.
biometria	(String) Hash da biometria cadastrada em um equipamento.
cargos	(Array) Cargos do funcionário.
cargos[data]	(Date) Data de atribuição do cargo.
cargos[funcao]	(String) Nome da função.
cargos[name]	(String) Nome do cargo.
exames	(Array) Exames do funcionário.
exames[data]	(Date) Data de atribuição do cargo.
exames[apto]	(Boolean) Apto?
dependentes	(Array) Dependentes do funcionário.
dependentes[name]	(String) Nome do dependente.
dependentes[birth]	(Date) Data de nascimento.
errors[name]	(Array) Mensagens de erros para o campo name.
errors[pis]	(Array) Mensagens de erros para o campo PIS.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"91b1330f0d92ff6ee4b474320674f7fa"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 7aed3d44-d1ae-450f-9bec-cf57885500ee
X-Runtime: 0.054929
Vary: Origin
Content-Length: 830

Body

{
  "cpf": null,
  "cracha": "3247929223",
  "data_admissao": "2018-01-10",
  "data_demissao": null,
  "name": "John Doe",
  "pis": "018221351322",
  "registro_folha": null,
  "rg": null,
  "uid": "f82a6cc8-95ec-4483-afc4-1c247ffb1f30",
  "nacionalidade": null,
  "nome_da_mae": null,
  "nome_do_pai": null,
  "estado_civil": null,
  "conjuge": null,
  "nascimento": null,
  "ctps": null,
  "cnh": null,
  "certidao_militar": null,
  "tipo_sanguineo": null,
  "escolaridade": null,
  "observacoes": null,
  "cargos": [

  ],
  "exames": [
    {
      "data": "2017-01-01",
      "apto": true,
      "tipo_exame": null,
      "observacoes": null,
      "arquivo": {
        "url": null
      }
    }
  ],
  "empresa": {
    "uid": "c43becdf-ba77-4062-97c0-58f3335dad92",
    "name": "Empresa01",
    "nome_fantasia": "EmpFantasia01",
    "cnpj": "00.000.000/0000-01",
    "cei": null,
    "cpf": null,
    "inscricao_estadual": null,
    "address": null,
    "contact": null,
    "codigo_registro_folha": null,
    "ativo": true
  },
  "departamento": null,
  "biometria": null
}

Criando funcionário - erros

Este método mostra falhas na validação do funcionário.

Endpoint

POST /v1/funcionarios

Parameters

Name	Description
funcionario[pis] required	(String) Identificador de PIS.
funcionario[cpf]	(String) Identificador de CPF.
funcionario[data_admissao] required	(Date) Data de admissão.
funcionario[data_demissao]	(Date) Data de demissão.
funcionario[name] required	(String) Nome do funcionário.
funcionario[empresa_id] required	(String) UID da Empresa.
funcionario[departamento_id]	(String) UID do Departamento.
funcionario[registro_folha]	(String) Identificador de Registro de Folha de pagamento.
funcionario[rg]	(String) Identificador de RG.
funcionario[nacionalidade]	(String) Nacionalidade.
funcionario[nome_da_mae]	(String) Nome da mãe.
funcionario[nome_do_pai]	(String) Nome da pai.
funcionario[estado_civil]	(String) Estado civil.
funcionario[conjuge]	(String) Nome do conjuge.
funcionario[nascimento]	(Date) Data de nascimento.
funcionario[ctps]	(String) Identificador de CTPS.
funcionario[cnh]	(String) Identificador de CNH.
funcionario[certidao_militar]	(String) Identificador de Certidão Militar.
funcionario[tipo_sanguineo]	(String) Tipo sanguíneo.
funcionario[escolaridade]	(String) Escolaridade.
funcionario[observacoes]	(String) Observações.
funcionario[biometria]	(String) Hash da biometria cadastrada em um equipamento.
funcionario[funcionario_cargos_attributes]	(Array) Cargos do funcionário.
funcionario_cargos_attributes[data]	(Date) Data de atribuição do cargo.
funcionario_cargos_attributes[funcao]	(String) Nome da função.
funcionario_cargos_attributes[name]	(String) Nome do cargo.
funcionario[funcionario_exames_attributes]	(Array) Exames do funcionário.
funcionario_exames_attributes[data]	(Date) Data de atribuição do cargo.
funcionario_exames_attributes[apto]	(Boolean) Apto?
funcionario[funcionario_dependentes_attributes]	(Array) Dependentes do funcionário.
funcionario_dependentes_attributes[name]	(String) Nome do dependente.
funcionario_dependentes_attributes[birth]	(Date) Data de nascimento.

Request

Route

POST /v1/funcionarios

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

funcionario[name]=

cURL

curl "http://api.lvh.me:3000/v1/funcionarios" -d 'funcionario[name]=' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
uid	(String) Funcionário ID.
cpf	(String) Identificador de CPF.
data_admissao	(Date) Data de admissão.
data_demissao	(Date) Data de demissão.
name	(String) Nome do funcionário.
pis	(String) Identificador de PIS.
registro_folha	(String) Identificador de Registro de Folha de pagamento.
rg	(String) Identificador de RG.
nacionalidade	(String) Nacionalidade.
nome_da_mae	(String) Nome da mãe.
nome_do_pai	(String) Nome da pai.
estado_civil	(String) Estado civil.
conjuge	(String) Nome do conjuge.
nascimento	(Date) Data de nascimento.
ctps	(String) Identificador de CTPS.
cnh	(String) Identificador de CNH.
certidao_militar	(String) Identificador de Certidão Militar.
tipo_sanguineo	(String) Tipo sanguíneo.
escolaridade	(String) Escolaridade.
observacoes	(String) Observações.
biometria	(String) Hash da biometria cadastrada em um equipamento.
cargos	(Array) Cargos do funcionário.
cargos[data]	(Date) Data de atribuição do cargo.
cargos[funcao]	(String) Nome da função.
cargos[name]	(String) Nome do cargo.
exames	(Array) Exames do funcionário.
exames[data]	(Date) Data de atribuição do cargo.
exames[apto]	(Boolean) Apto?
dependentes	(Array) Dependentes do funcionário.
dependentes[name]	(String) Nome do dependente.
dependentes[birth]	(Date) Data de nascimento.
errors[name]	(Array) Mensagens de erros para o campo name.
errors[pis]	(Array) Mensagens de erros para o campo PIS.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: ed80ed89-b756-4c26-89ed-1bc11aa1d02d
X-Runtime: 0.042745
Vary: Origin
Content-Length: 133

Body

{
  "message": "Validation Failed!",
  "errors": {
    "name": [
      "can't be blank"
    ],
    "data_admissao": [
      "can't be blank"
    ],
    "empresa": [
      "can't be blank"
    ]
  }
}

Listando funcionários

Este método retorna um array de funcionarios.

Endpoint

GET /v1/funcionarios

Parameters

Name	Description
per_page	(Int) Número de registros por página. Padrão: 5.
page	(Int) Número da página de referência da paginação. Padrão: 1.
include_last_quadro_de_horas	(Boolean) "true" ou "1" para exibir com o último quadro de horas vinculado.

Request

Route

GET /v1/funcionarios

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
X-Current-Page	(Int) [Header] Página atual da paginação.
X-Per-Page	(Int) [Header] Número máximo de registros da resposta à requisição.
[Objetos<Funcionario>]	(Array) Coleção de Funcionários (Ver artigo objeto Funcionario).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Per-Page: 5
X-Current-Page: 1
Content-Type: application/json; charset=utf-8
ETag: W/"959084f0b3179b52bfb7ceceaf05e3ec"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 53ea7daf-c4af-4bde-aff1-e9fed229f900
X-Runtime: 0.122437
Vary: Origin
Content-Length: 6372

Body

[
  {
    "cpf": null,
    "cracha": "3241423821",
    "data_admissao": "2015-01-01",
    "data_demissao": null,
    "name": "Abraão Diz",
    "pis": "010815431066",
    "registro_folha": null,
    "rg": null,
    "uid": "51ba8bd1-1c65-40fa-8e11-7e2f4f1ff2d2",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [

    ],
    "exames": [

    ],
    "empresa": {
      "uid": null,
      "name": "Abraao",
      "nome_fantasia": "Abraao",
      "cnpj": "00.400.300/0200-11",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": null,
      "contact": null,
      "codigo_registro_folha": null,
      "ativo": true
    },
    "departamento": null,
    "biometria": null
  },
  {
    "cpf": null,
    "cracha": "000128989",
    "data_admissao": "2015-08-01",
    "data_demissao": "2015-12-02",
    "name": "ACIR DIRCEU RIBEIRO PATRICIO ROBERTO GUIMARÃES DA SLVA",
    "pis": null,
    "registro_folha": null,
    "rg": null,
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d6",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [

    ],
    "exames": [

    ],
    "empresa": {
      "uid": null,
      "name": "EMPRESA COM NOME MUITO MUITO MUITO MUITO GRANDE LTDA",
      "nome_fantasia": "EMPRESA COM NOME MUITO MUITO MUITO MUITO GRANDE",
      "cnpj": "00.000.000/0000-11",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "99999-999",
        "city": "São José do Vale do Rio Preto",
        "complement": "Complemento Complemento Complemento Complemento",
        "country": "Brasil",
        "number": "9999",
        "state": "RIO GRANDE DO NORTE",
        "street": "não existe não existe não existe",
        "district": "Jijoca de Jericoacoara"
      },
      "contact": null,
      "codigo_registro_folha": null,
      "ativo": true
    },
    "departamento": {
      "uid": "f43becdf-bb77-4022-97c0-58f3335dad55",
      "name": "dp1 COM NOME MUITO MUITO GRANDE QUE NÃO CABE NO CARTÃO",
      "empresa": {
        "uid": null,
        "name": "EMPRESA COM NOME MUITO MUITO MUITO MUITO GRANDE LTDA",
        "nome_fantasia": "EMPRESA COM NOME MUITO MUITO MUITO MUITO GRANDE",
        "cnpj": "00.000.000/0000-11",
        "cei": null,
        "cpf": null,
        "inscricao_estadual": null,
        "address": {
          "cep": "99999-999",
          "city": "São José do Vale do Rio Preto",
          "complement": "Complemento Complemento Complemento Complemento",
          "country": "Brasil",
          "number": "9999",
          "state": "RIO GRANDE DO NORTE",
          "street": "não existe não existe não existe",
          "district": "Jijoca de Jericoacoara"
        },
        "contact": null,
        "codigo_registro_folha": null,
        "ativo": true
      },
      "ativo": true
    },
    "biometria": null
  },
  {
    "cpf": null,
    "cracha": "022338195fw5",
    "data_admissao": null,
    "data_demissao": null,
    "name": "Claudia",
    "pis": null,
    "registro_folha": null,
    "rg": null,
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d5",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [

    ],
    "exames": [

    ],
    "empresa": {
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "85555-222",
        "city": "Guarapuava",
        "complement": "Apto52",
        "country": "Brasil",
        "number": "101",
        "state": "PR",
        "street": "Rua Armando Ribas",
        "district": "Rua Armando Ribas"
      },
      "contact": null,
      "codigo_registro_folha": "23",
      "ativo": true
    },
    "departamento": {
      "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
      "name": "Departamento01",
      "empresa": {
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "cei": null,
        "cpf": null,
        "inscricao_estadual": null,
        "address": {
          "cep": "85555-222",
          "city": "Guarapuava",
          "complement": "Apto52",
          "country": "Brasil",
          "number": "101",
          "state": "PR",
          "street": "Rua Armando Ribas",
          "district": "Rua Armando Ribas"
        },
        "contact": null,
        "codigo_registro_folha": "23",
        "ativo": true
      },
      "ativo": true
    },
    "biometria": null
  },
  {
    "cpf": null,
    "cracha": "32382329",
    "data_admissao": "2017-01-01",
    "data_demissao": null,
    "name": "Donald T.",
    "pis": "011811243066",
    "registro_folha": null,
    "rg": null,
    "uid": "51ba8bd1-1c65-40fa-8e11-7e2f4e1ff4d1",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [

    ],
    "exames": [

    ],
    "empresa": {
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "85555-222",
        "city": "Guarapuava",
        "complement": "Apto52",
        "country": "Brasil",
        "number": "101",
        "state": "PR",
        "street": "Rua Armando Ribas",
        "district": "Rua Armando Ribas"
      },
      "contact": null,
      "codigo_registro_folha": "23",
      "ativo": true
    },
    "departamento": null,
    "biometria": null
  },
  {
    "cpf": "07155744989",
    "cracha": "1",
    "data_admissao": "2017-01-01",
    "data_demissao": null,
    "name": "Func1",
    "pis": "123929234315",
    "registro_folha": "123",
    "rg": null,
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [
      {
        "data": "2017-01-10",
        "funcao": "test",
        "name": "Auxiliar (123456)"
      },
      {
        "data": "2018-01-01",
        "funcao": "auxiliar",
        "name": null
      }
    ],
    "exames": [
      {
        "data": "2017-01-10",
        "apto": true,
        "tipo_exame": null,
        "observacoes": null,
        "arquivo": {
          "url": null
        }
      }
    ],
    "empresa": {
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "85555-222",
        "city": "Guarapuava",
        "complement": "Apto52",
        "country": "Brasil",
        "number": "101",
        "state": "PR",
        "street": "Rua Armando Ribas",
        "district": "Rua Armando Ribas"
      },
      "contact": null,
      "codigo_registro_folha": "23",
      "ativo": true
    },
    "departamento": {
      "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
      "name": "Departamento01",
      "empresa": {
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "cei": null,
        "cpf": null,
        "inscricao_estadual": null,
        "address": {
          "cep": "85555-222",
          "city": "Guarapuava",
          "complement": "Apto52",
          "country": "Brasil",
          "number": "101",
          "state": "PR",
          "street": "Rua Armando Ribas",
          "district": "Rua Armando Ribas"
        },
        "contact": null,
        "codigo_registro_folha": "23",
        "ativo": true
      },
      "ativo": true
    },
    "biometria": null
  }
]

Procurando funcionário pelo crachá

Este método retorna um array de funcionarios.

Endpoint

GET /v1/funcionarios?cracha=0110

Parameters

Name	Description
per_page	(Int) Número de registros por página. Padrão: 5.
page	(Int) Número da página de referência da paginação. Padrão: 1.
cracha	(String) Crachá do funcionário.

Request

Route

GET /v1/funcionarios?cracha=0110

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

Query Parameters

cracha=0110

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios?cracha=0110" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
X-Current-Page	(Int) [Header] Página atual da paginação.
X-Per-Page	(Int) [Header] Número máximo de registros da resposta à requisição.
[Objetos<Funcionario>]	(Array) Coleção de Funcionários (Ver artigo objeto Funcionario).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Per-Page: 5
X-Current-Page: 1
Content-Type: application/json; charset=utf-8
ETag: W/"1fcafc61b05ffac5c331b2590bd2aff7"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 4fdbcbd9-c829-48a8-89ee-c477eab98afe
X-Runtime: 0.042760
Vary: Origin
Content-Length: 886

Body

[
  {
    "cpf": null,
    "cracha": "0110",
    "data_admissao": null,
    "data_demissao": null,
    "name": "Func4",
    "pis": "123456789012",
    "registro_folha": null,
    "rg": null,
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c3",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [

    ],
    "exames": [

    ],
    "empresa": {
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "85555-222",
        "city": "Guarapuava",
        "complement": "Apto52",
        "country": "Brasil",
        "number": "101",
        "state": "PR",
        "street": "Rua Armando Ribas",
        "district": "Rua Armando Ribas"
      },
      "contact": null,
      "codigo_registro_folha": "23",
      "ativo": true
    },
    "departamento": null,
    "biometria": null
  }
]

Procurando funcionário pelo registro de folha de pagamento

Este método retorna um array de funcionarios.

Endpoint

GET /v1/funcionarios?registro_folha=123

Parameters

Name	Description
per_page	(Int) Número de registros por página. Padrão: 5.
page	(Int) Número da página de referência da paginação. Padrão: 1.
registro_folha	(String) Identificador Registro de folha de pagamento do funcionário.

Request

Route

GET /v1/funcionarios?registro_folha=123

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

Query Parameters

registro_folha=123

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios?registro_folha=123" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
X-Current-Page	(Int) [Header] Página atual da paginação.
X-Per-Page	(Int) [Header] Número máximo de registros da resposta à requisição.
[Objetos<Funcionario>]	(Array) Coleção de Funcionários (Ver artigo objeto Funcionario).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Per-Page: 5
X-Current-Page: 1
Content-Type: application/json; charset=utf-8
ETag: W/"763a9fe5fb5f1d931d98e7428c5294d5"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: aca1619d-137c-4146-ab96-987be7d8f476
X-Runtime: 0.048523
Vary: Origin
Content-Length: 1611

Body

[
  {
    "cpf": "07155744989",
    "cracha": "1",
    "data_admissao": "2017-01-01",
    "data_demissao": null,
    "name": "Func1",
    "pis": "123929234315",
    "registro_folha": "123",
    "rg": null,
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [
      {
        "data": "2017-01-10",
        "funcao": "test",
        "name": "Auxiliar (123456)"
      },
      {
        "data": "2018-01-01",
        "funcao": "auxiliar",
        "name": null
      }
    ],
    "exames": [
      {
        "data": "2017-01-10",
        "apto": true,
        "tipo_exame": null,
        "observacoes": null,
        "arquivo": {
          "url": null
        }
      }
    ],
    "empresa": {
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "85555-222",
        "city": "Guarapuava",
        "complement": "Apto52",
        "country": "Brasil",
        "number": "101",
        "state": "PR",
        "street": "Rua Armando Ribas",
        "district": "Rua Armando Ribas"
      },
      "contact": null,
      "codigo_registro_folha": "23",
      "ativo": true
    },
    "departamento": {
      "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
      "name": "Departamento01",
      "empresa": {
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "cei": null,
        "cpf": null,
        "inscricao_estadual": null,
        "address": {
          "cep": "85555-222",
          "city": "Guarapuava",
          "complement": "Apto52",
          "country": "Brasil",
          "number": "101",
          "state": "PR",
          "street": "Rua Armando Ribas",
          "district": "Rua Armando Ribas"
        },
        "contact": null,
        "codigo_registro_folha": "23",
        "ativo": true
      },
      "ativo": true
    },
    "biometria": null
  }
]

Procurando funcionário pelo status

Este método retorna um array de funcionarios.

Endpoint

GET /v1/funcionarios?status=inativos

Parameters

Name	Description
per_page	(Int) Número de registros por página. Padrão: 5.
page	(Int) Número da página de referência da paginação. Padrão: 1.
status	(String) Status atual do funcionário. Valores: "nao_desativados", "inativos", "sem_empresa", "sem_cadastro" e "experiencia".

Request

Route

GET /v1/funcionarios?status=inativos

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

Query Parameters

status=inativos

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios?status=inativos" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
X-Current-Page	(Int) [Header] Página atual da paginação.
X-Per-Page	(Int) [Header] Número máximo de registros da resposta à requisição.
[]	(Array) Coleção de Funcionários. Ver objeto Funcionario.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Per-Page: 5
X-Current-Page: 1
Content-Type: application/json; charset=utf-8
ETag: W/"2b9f8788c4c439fdfd86e52e65afad66"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: fc168c69-53e0-4d89-a643-4a2bc06d5f51
X-Runtime: 0.048681
Vary: Origin
Content-Length: 2679

Body

[
  {
    "cpf": null,
    "cracha": "000128989",
    "data_admissao": "2015-08-01",
    "data_demissao": "2015-12-02",
    "name": "ACIR DIRCEU RIBEIRO PATRICIO ROBERTO GUIMARÃES DA SLVA",
    "pis": null,
    "registro_folha": null,
    "rg": null,
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d6",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [

    ],
    "exames": [

    ],
    "empresa": {
      "uid": null,
      "name": "EMPRESA COM NOME MUITO MUITO MUITO MUITO GRANDE LTDA",
      "nome_fantasia": "EMPRESA COM NOME MUITO MUITO MUITO MUITO GRANDE",
      "cnpj": "00.000.000/0000-11",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "99999-999",
        "city": "São José do Vale do Rio Preto",
        "complement": "Complemento Complemento Complemento Complemento",
        "country": "Brasil",
        "number": "9999",
        "state": "RIO GRANDE DO NORTE",
        "street": "não existe não existe não existe",
        "district": "Jijoca de Jericoacoara"
      },
      "contact": null,
      "codigo_registro_folha": null,
      "ativo": true
    },
    "departamento": {
      "uid": "f43becdf-bb77-4022-97c0-58f3335dad55",
      "name": "dp1 COM NOME MUITO MUITO GRANDE QUE NÃO CABE NO CARTÃO",
      "empresa": {
        "uid": null,
        "name": "EMPRESA COM NOME MUITO MUITO MUITO MUITO GRANDE LTDA",
        "nome_fantasia": "EMPRESA COM NOME MUITO MUITO MUITO MUITO GRANDE",
        "cnpj": "00.000.000/0000-11",
        "cei": null,
        "cpf": null,
        "inscricao_estadual": null,
        "address": {
          "cep": "99999-999",
          "city": "São José do Vale do Rio Preto",
          "complement": "Complemento Complemento Complemento Complemento",
          "country": "Brasil",
          "number": "9999",
          "state": "RIO GRANDE DO NORTE",
          "street": "não existe não existe não existe",
          "district": "Jijoca de Jericoacoara"
        },
        "contact": null,
        "codigo_registro_folha": null,
        "ativo": true
      },
      "ativo": true
    },
    "biometria": null
  },
  {
    "cpf": null,
    "cracha": "7",
    "data_admissao": null,
    "data_demissao": "2004-01-12",
    "name": "Func desligado",
    "pis": "055811243066",
    "registro_folha": null,
    "rg": null,
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c4",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [

    ],
    "exames": [

    ],
    "empresa": {
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "85555-222",
        "city": "Guarapuava",
        "complement": "Apto52",
        "country": "Brasil",
        "number": "101",
        "state": "PR",
        "street": "Rua Armando Ribas",
        "district": "Rua Armando Ribas"
      },
      "contact": null,
      "codigo_registro_folha": "23",
      "ativo": true
    },
    "departamento": null,
    "biometria": null
  }
]

Visualizar Funcionário

Este método retorna um objeto funcionário.

Endpoint

GET /v1/funcionarios/:uid

Parameters

Name	Description
uid required	(String) UID do funcionário.

Request

Route

GET /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario[uid]	(String) Funcionário UID.
funcionario[cpf]	(String) Identificador de CPF.
funcionario[data_admissao]	(Date) Data de admissão.
funcionario[data_demissao]	(Date) Data de demissão.
funcionario[name]	(String) Nome do funcionário.
funcionario[pis]	(String) Identificador de PIS.
funcionario[registro_folha]	(String) Identificador de Registro de Folha de pagamento.
funcionario[rg]	(String) Identificador de RG.
funcionario[nacionalidade]	(String) Nacionalidade.
funcionario[nome_da_mae]	(String) Nome da mãe.
funcionario[nome_do_pai]	(String) Nome da pai.
funcionario[estado_civil]	(String) Estado civil.
funcionario[conjuge]	(String) Nome do conjuge.
funcionario[nascimento]	(Date) Data de nascimento.
funcionario[ctps]	(String) Identificador de CTPS.
funcionario[cnh]	(String) Identificador de CNH.
funcionario[certidao_militar]	(String) Identificador de Certidão Militar.
funcionario[tipo_sanguineo]	(String) Tipo sanguíneo.
funcionario[escolaridade]	(String) Escolaridade.
funcionario[observacoes]	(String) Observações.
funcionario[biometria]	(String) Hash da biometria cadastrada em um equipamento.
funcionario[cargos]	(Array) Cargos do funcionário.
cargos[data]	(Date) Data de atribuição do cargo.
cargos[funcao]	(String) Nome da função.
cargos[name]	(String) Nome do cargo.
funcionario[exames]	(Array) Exames do funcionário.
exames[data]	(Date) Data de atribuição do cargo.
exames[apto]	(Boolean) Apto?
funcionario[dependentes]	(Array) Dependentes do funcionário.
dependentes[name]	(String) Nome do dependente.
dependentes[birth]	(Date) Data de nascimento.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"9fb610b83a74f91da60ce3dd11f8610b"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 9daab13d-6d5b-4ba7-aed2-79c7e30c1e58
X-Runtime: 0.044342
Vary: Origin
Content-Length: 1609

Body

{
  "cpf": "07155744989",
  "cracha": "1",
  "data_admissao": "2017-01-01",
  "data_demissao": null,
  "name": "Func1",
  "pis": "123929234315",
  "registro_folha": "123",
  "rg": null,
  "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
  "nacionalidade": null,
  "nome_da_mae": null,
  "nome_do_pai": null,
  "estado_civil": null,
  "conjuge": null,
  "nascimento": null,
  "ctps": null,
  "cnh": null,
  "certidao_militar": null,
  "tipo_sanguineo": null,
  "escolaridade": null,
  "observacoes": null,
  "cargos": [
    {
      "data": "2017-01-10",
      "funcao": "test",
      "name": "Auxiliar (123456)"
    },
    {
      "data": "2018-01-01",
      "funcao": "auxiliar",
      "name": null
    }
  ],
  "exames": [
    {
      "data": "2017-01-10",
      "apto": true,
      "tipo_exame": null,
      "observacoes": null,
      "arquivo": {
        "url": null
      }
    }
  ],
  "empresa": {
    "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
    "name": "Empresa03",
    "nome_fantasia": "EmpFantasia03",
    "cnpj": "00.000.000/0000-03",
    "cei": null,
    "cpf": null,
    "inscricao_estadual": null,
    "address": {
      "cep": "85555-222",
      "city": "Guarapuava",
      "complement": "Apto52",
      "country": "Brasil",
      "number": "101",
      "state": "PR",
      "street": "Rua Armando Ribas",
      "district": "Rua Armando Ribas"
    },
    "contact": null,
    "codigo_registro_folha": "23",
    "ativo": true
  },
  "departamento": {
    "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
    "name": "Departamento01",
    "empresa": {
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "85555-222",
        "city": "Guarapuava",
        "complement": "Apto52",
        "country": "Brasil",
        "number": "101",
        "state": "PR",
        "street": "Rua Armando Ribas",
        "district": "Rua Armando Ribas"
      },
      "contact": null,
      "codigo_registro_folha": "23",
      "ativo": true
    },
    "ativo": true
  },
  "biometria": null
}

Visualizar Funcionário - Com último Quadro de horas Vinculado

Este método retorna um objeto funcionário com o último quadro de horas vinculado.

Endpoint

GET /v1/funcionarios/:uid?include_last_quadro_de_horas=1

Parameters

Name	Description
uid required	(String) UID do funcionário.
include_last_quadro_de_horas	(Boolean) "true" ou "1" para exibir o último quadro de horas vinculado.

Request

Route

GET /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0?include_last_quadro_de_horas=1

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

Query Parameters

include_last_quadro_de_horas=1

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0?include_last_quadro_de_horas=1" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
uid	(String) Funcionário ID.
Objeto Funcionario	... (ver artigo Visualizar Funcionário)
last_quadro_de_horas[data_vigencia]	(Date) Data de vigência do quadro de horas.
last_quadro_de_horas[quadro_de_hora]	(Object) Dados do Objeto Quadro de horas (ver artigo Listando Quadro de Horas).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"1b6735c7e27b2a58465a46e3685d91e0"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1cbf364a-718b-4f55-93fb-c9de6dd9fb55
X-Runtime: 0.041811
Vary: Origin
Content-Length: 1923

Body

{
  "cpf": "07155744989",
  "cracha": "1",
  "data_admissao": "2017-01-01",
  "data_demissao": null,
  "name": "Func1",
  "pis": "123929234315",
  "registro_folha": "123",
  "rg": null,
  "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
  "nacionalidade": null,
  "nome_da_mae": null,
  "nome_do_pai": null,
  "estado_civil": null,
  "conjuge": null,
  "nascimento": null,
  "ctps": null,
  "cnh": null,
  "certidao_militar": null,
  "tipo_sanguineo": null,
  "escolaridade": null,
  "observacoes": null,
  "cargos": [
    {
      "data": "2017-01-10",
      "funcao": "test",
      "name": "Auxiliar (123456)"
    },
    {
      "data": "2018-01-01",
      "funcao": "auxiliar",
      "name": null
    }
  ],
  "exames": [
    {
      "data": "2017-01-10",
      "apto": true,
      "tipo_exame": null,
      "observacoes": null,
      "arquivo": {
        "url": null
      }
    }
  ],
  "empresa": {
    "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
    "name": "Empresa03",
    "nome_fantasia": "EmpFantasia03",
    "cnpj": "00.000.000/0000-03",
    "cei": null,
    "cpf": null,
    "inscricao_estadual": null,
    "address": {
      "cep": "85555-222",
      "city": "Guarapuava",
      "complement": "Apto52",
      "country": "Brasil",
      "number": "101",
      "state": "PR",
      "street": "Rua Armando Ribas",
      "district": "Rua Armando Ribas"
    },
    "contact": null,
    "codigo_registro_folha": "23",
    "ativo": true
  },
  "departamento": {
    "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
    "name": "Departamento01",
    "empresa": {
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33",
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "cei": null,
      "cpf": null,
      "inscricao_estadual": null,
      "address": {
        "cep": "85555-222",
        "city": "Guarapuava",
        "complement": "Apto52",
        "country": "Brasil",
        "number": "101",
        "state": "PR",
        "street": "Rua Armando Ribas",
        "district": "Rua Armando Ribas"
      },
      "contact": null,
      "codigo_registro_folha": "23",
      "ativo": true
    },
    "ativo": true
  },
  "biometria": null,
  "last_quadro_de_horas": {
    "id": 980190962,
    "data_vigencia": "2014-03-26",
    "quadro_de_hora": {
      "hora_virada": "2000-01-01T00:00:00.000Z",
      "name": "Quadro Livre",
      "tipo": "livre",
      "use_holiday": true,
      "folgas_especiais": 0,
      "ativo": true,
      "ch": 11,
      "marcacao_automatica_intervalo": null,
      "tolerancia": null,
      "horario": null,
      "intervalo": null
    }
  }
}

Funcionários > Ausentes

Listando erros para requisição com data inválida

Este método retorna a reposta para parametros inválidos.

Endpoint

GET /v1/funcionarios/ausentes/:from/ate/:to

Parameters

Name	Description
from required	(Date) Data inicial do relatório.
to required	(Date) Data final do relatório.

Request

Route

GET /v1/funcionarios/ausentes/2015-01-33/ate/2015-12-31

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios/ausentes/2015-01-33/ate/2015-12-31" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto Funcionário (ver artigo Funcionários).
dias	(Array) Dias de ausência.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 0a4a53e0-f774-4206-9c81-e83615c96b0e
X-Runtime: 0.035907
Vary: Origin
Content-Length: 26

Body

{
  "message": "Invalid Date"
}

Listando os funcionários ausentes entre as datas

Este método retorna uma coleção de funcionários ausentes dado um intervalo de datas.

Endpoint

GET /v1/funcionarios/ausentes/:from/ate/:to

Parameters

Name	Description
from required	(Date) Data inicial do relatório.
to required	(Date) Data final do relatório.

Request

Route

GET /v1/funcionarios/ausentes/2015-12-01/ate/2015-12-31

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios/ausentes/2015-12-01/ate/2015-12-31" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto Funcionário (ver artigo Funcionários).
dias	(Array) Dias de ausência.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"4b12859be6f8f66c4b8faa6c465af0bc"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 0a0a2e40-674c-42cb-ab38-bf8d18b1cb89
X-Runtime: 0.077472
Vary: Origin
Content-Length: 1372

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2015-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "days": [
      "2015-12-01"
    ]
  }
]

Funcionários > Cartão Ponto

Mostrando o cartão ponto do funcionário

Este método retorna um objeto com os dados do cartão ponto do funcionário.

Endpoint

GET /v1/funcionarios/:funcionario_id/cartao_ponto/:year/:month

Parameters

Name	Description
funcionario_id required	(String) UID do funcionário.
year required	(Int) Ano do cartão ponto. Ex: 2018.
month required	(Int) Mês do cartão ponto. Ex: 10.

Request

Route

GET /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2018/1

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2018/1" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto Funcionário (ver artigo Funcionários).
ano	(Int) Ano do cartão ponto.
mes	(Int) Mês do cartão ponto.
mensagem	(String) Notas do cartão do funcionário.
atualizado	(Boolean) Se o cartão está atualmente processado.
total_abonos	(Int) Quantidade de segundos abonados.
total_falta	(Int) Quantidade de segundos de faltas.
total_trabalhado	(Int) Quantidade de segundos de trabalho.
total_extra	(Int) Quantidade de segundos de extra.
adicional_noturno	(Int) Quantidade de segundos de adicional noturno.
total_atrasado	(Int) Quantidade de segundos de atraso.
dias_de_falta	(Int) Quantidade de dias de falta.
extra_noturno	(Int) Quantidade de segundos de extra noturno.
semanal	(Object) Coleção de dados de semana a semana.
semanal[semana_1]	(Object) Dados da primeira semana.
semana_1[trabalhada]	(Int) Quantidade de segundos de trabalho na semana.
semana_1[extra]	(Int) Quantidade de segundos de extra na semana.
semana_1[falta]	(Int) Quantidade de segundos de falta na semana.
semana_1[adicional_noturno]	(Int) Quantidade de segundos de adicional noturno na semana.
semana_1[abonos]	(Int) Quantidade de segundos de abono na semana.
semana_1[in_itinere]	(Int) Quantidade de segundos de In Itinere na semana.
semana_1[dias_de_falta]	(Int) Quantidade de dias de falta na semana.
semana_1[falta_integral]	(Int) Quantidade de segundos de falta integral na semana.
semanal[semana_2]	(Object) Dados da segunda semana.
semanal[semana_N]	(Object) Dados da semana seguinte...
politica_extra	(Object) Detalhes sobre as horas extras do período.
politica_extra[mensal]	(Extra) Dados sobre as horas extras para configuração de horário mensal.
mensal[segunda_a_sexta]	(ExtraPercentual) Objeto composto por chave e valor. Ex: "50": 3600. Onde a chave é a porcentagem de hora extra e o valor é a quantidade de segundos.
mensal[segunda_a_sabado]	(ExtraPercentual) Objeto [ExtraPercentual] para segunda a sábado.
mensal[domingo]	(ExtraPercentual) Objeto [ExtraPercentual] para domingo.
mensal[sabado]	(ExtraPercentual) Objeto [ExtraPercentual] para sábado.
mensal[feriado]	(ExtraPercentual) Objeto [ExtraPercentual] para feriado.
mensal[folga]	(ExtraPercentual) Objeto [ExtraPercentual] para folga.
politica_extra[semanal]	(Extra) Objeto [Extra] para horas extras para configuração de horário semanal.
politica_extra[diaria]	(Extra) Objeto [Extra] para horas extras para configuração de horário diário.
locked	(Boolean) Se o cartão ponto está bloqueado pelo usuário.
acrescimo_noturno	(Int) Quantidade de segundos de acréscimos noturno.
trabalhadas_com_dsr	(Int) Quantidade de segundos da soma de trabalhadas com D.S.R.
trabalhadas_menos_extra	(Int) Quantidade de segundos da subtração de trabalhadas com Extra.
dsr_credit	(Int) Quantidade de segundos de D.S.R. positivo (DSR +).
dsr_debit	(Int) Quantidade de segundos de D.S.R. negativo (DSR -).
quantidade_dsr_positivo	(Int) Quantidade de D.S.R. positivo (DSR +).
bh_credit	(Int) Quantidade de segundos de Banco de Horas positivo (BH +).
bh_debit	(Int) Quantidade de segundos de Banco de Horas negativo (BH -).
bh_total	(Int) Quantidade de segundos de total de Banco de Horas no período.
bh_abonado	(Int) Quantidade de segundos de Banco de Horas abonado no período.
bh_pago	(Int) Quantidade de segundos de Banco de Horas pago no período.
cp_credit	(Int) Quantidade de segundos de Compensação positivo (CP +).
cp_debit	(Int) Quantidade de segundos de Compensação negativo (CP -).
cp_total	(Int) Quantidade de segundos de total de Compensação no período.
in_itinere_total	(Int) Quantidade de segundos de In Itinere.
falta_integral	(Int) Quantidade de segundos de falta integral.
falta_parcial	(Int) Quantidade de segundos de falta parcial.
adicional_noturno_sem_acrescimo	(Int) Quantidade de segundos de adicional noturno sem acréscimo noturno.
intervalo_intrajornada	(Int) Quantidade de segundos de intervalo intrajornada no periodo.
interjornada	(Int) Quantidade de segundos de interjornada no período.
interjornada_faltante	(Int) Quantidade de segundos de interjornada faltante obrigatória no período.
dias_de_trabalho	(Int) Quantidade de dias que contém pontos registrados.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"1f76002208c1c24ecdf3171589af2fb4"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 8af50a63-8fdf-4374-bd55-1c15d51359b6
X-Runtime: 0.067986
Vary: Origin
Content-Length: 2908

Body

{
  "funcionario": {
    "cpf": "07155744989",
    "cracha": "1",
    "data_admissao": null,
    "data_demissao": null,
    "name": "Func1",
    "pis": "123929234315",
    "registro_folha": "123",
    "rg": null,
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [
      {
        "data": "2017-01-10",
        "funcao": "test",
        "name": "Auxiliar (123456)"
      },
      {
        "data": "2018-01-01",
        "funcao": "auxiliar",
        "name": null
      }
    ],
    "exames": [
      {
        "data": "2017-01-10",
        "apto": true,
        "tipo_exame": null,
        "observacoes": null,
        "arquivo": {
          "url": null
        }
      }
    ],
    "empresa": {
      "id": 471928375,
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "inscricao_estadual": null,
      "cpf": null,
      "created_at": "2023-09-27T09:51:27.000-03:00",
      "updated_at": "2023-09-27T09:51:27.000-03:00",
      "cliente_id": 571096427,
      "cei": null,
      "codigo_registro_folha": "23",
      "ativo": true,
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
    },
    "departamento": {
      "id": 980190962,
      "name": "Departamento01 (Empresa03)",
      "empresa_id": 471928375,
      "created_at": "2023-09-27T09:51:27.000-03:00",
      "updated_at": "2023-09-27T09:51:27.000-03:00",
      "ativo": true,
      "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
      "codigo_registro_folha": "1",
      "full_name": "Departamento01 (Empresa03)"
    },
    "biometria": null
  },
  "ano": 2018,
  "mes": 1,
  "mensagem": null,
  "atualizado": true,
  "total_abonos": 0,
  "total_falta": 489600,
  "total_trabalhado": 43200,
  "total_extra": 14400,
  "adicional_noturno": 0,
  "total_atrasado": 0,
  "total_antecipado": 0,
  "dias_de_falta": 17,
  "extra_noturno": 0,
  "semanal": {
    "semana_1": {
      "trabalhada": 0,
      "extra": 0,
      "falta": 0,
      "adicional_noturno": 0,
      "abonos": 0,
      "excecoes": 0,
      "in_itinere": 0,
      "dias_de_falta": 7,
      "falta_integral": 201600
    },
    "semana_2": {
      "trabalhada": 0,
      "extra": 0,
      "falta": 0,
      "adicional_noturno": 0,
      "abonos": 0,
      "excecoes": 0,
      "in_itinere": 0,
      "dias_de_falta": 7,
      "falta_integral": 201600
    },
    "semana_3": {
      "trabalhada": 0,
      "extra": 0,
      "falta": 0,
      "adicional_noturno": 0,
      "abonos": 0,
      "excecoes": 0,
      "in_itinere": 0,
      "dias_de_falta": 3,
      "falta_integral": 86400
    }
  },
  "mensal": null,
  "politica_extra": {
    "semanal": {
      "segunda_a_sexta": {
      },
      "segunda_a_sabado": {
      },
      "domingo": {
      },
      "sabado": {
      },
      "feriado": {
      },
      "folga": {
      },
      "id": {
      }
    },
    "semanal_detail": {
    },
    "mensal": {
      "segunda_a_sexta": {
        "50": 14400
      },
      "segunda_a_sabado": {
      },
      "domingo": {
        "100": 0
      },
      "sabado": {
        "50": 0
      },
      "feriado": {
        "100": 0
      },
      "folga": {
      }
    },
    "diaria": {
      "segunda_a_sexta": {
      },
      "segunda_a_sabado": {
      },
      "domingo": {
      },
      "sabado": {
      },
      "feriado": {
      },
      "folga": {
      }
    }
  },
  "locked": false,
  "acrescimo_noturno": 0,
  "trabalhadas_com_dsr": 0,
  "trabalhadas_menos_extra": 28800,
  "dsr_credit": 0,
  "dsr_debit": 0,
  "quantidade_dsr_positivo": 0,
  "bh_credit": 0,
  "bh_debit": 0,
  "bh_total": 0,
  "bh_pago": 0,
  "bh_abonado": 0,
  "in_itinere_total": 0,
  "falta_integral": 489600,
  "falta_parcial": 0,
  "adicional_noturno_sem_acrescimo": 0,
  "intervalo_intrajornada": null,
  "interjornada": null,
  "interjornada_faltante": null,
  "dias_de_trabalho": null,
  "cp_credit": 3600,
  "cp_debit": 1800,
  "cp_total": 1800
}

Mostrando o cartão ponto do funcionário - não processado

Este método retorna um objeto para cartão ponto do funcionário não processado.

Endpoint

GET /v1/funcionarios/:funcionario_id/cartao_ponto/:year/:month

Parameters

Name	Description
funcionario_id required	(String) UID do funcionário.
year required	(Int) Ano do cartão ponto. Ex: 2018.
month required	(Int) Mês do cartão ponto. Ex: 10.

Request

Route

GET /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2018/2

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/cartao_ponto/2018/2" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
message	(String) Mensagem de erro da requisição.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: c4d578ad-5544-40ab-9ef3-0d6e39041000
X-Runtime: 0.045346
Vary: Origin
Content-Length: 56

Body

{
  "message": "Resource not processed. Unable to view it."
}

Funcionários > Ponto Diário

Filtrando funcionários por departamento

Este método retorna uma coleção de objetos para o dia do cartão ponto.

Endpoint

GET /v1/relatorios/funcionarios/ponto_diario/:date

Parameters

Name	Description
date	(Date) Data do dia do cartão ponto. Ex: "01-01-2019"
departamento_uid	(String) UID do departamento.

Request

Route

GET /v1/relatorios/funcionarios/ponto_diario/2015-04-29?departamento_uid=c43becdf-bb77-4062-97c0-58f3335dad91

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

Query Parameters

departamento_uid=c43becdf-bb77-4062-97c0-58f3335dad91

cURL

curl -g "http://api.lvh.me:3000/v1/relatorios/funcionarios/ponto_diario/2015-04-29?departamento_uid=c43becdf-bb77-4062-97c0-58f3335dad91" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto funcionário (ver artigo funcionarios).
pontos_originais	(Array) Lista de marcações originais do dia.
pontos_processados	(Array) Lista de marcações processadas do dia.
total	(Int) Total trabalhado em segundos.
extra	(Int) Total de extra em segundos.
falta	(Int) Total de falta em segundos.
atraso	(Int) Total de atraso em segundos.
saida_antecipada	(Int) Total de atraso em segundos.
adicional_noturno	(Int) Total de adicional noturno em segundos.
extra_noturno	(Int) Total de extra noturna em segundos.
ch	(Int) Código do horário.
tratamentos[time]	(Time) Hora ou Quantidade de hora total do tratamento.
tratamentos[type]	(String) Tipo da Ocorrência. Ex: I = Inclusão.
tratamentos[tratamento]	(Object) Objeto de Tratamento. Ex: Feriado, DSR, Banco de Horas, Inclusão de Ponto etc.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"49cfe1de933c397593a9a03137c1b8ba"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 520ebcd8-b763-40ea-8df4-34a0ed58a218
X-Runtime: 0.044556
Vary: Origin
Content-Length: 1605

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": null,
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "1",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "pontos_originais": [

    ],
    "pontos_processados": [

    ],
    "total": null,
    "extra": 0,
    "falta": 0,
    "atraso": null,
    "saida_atecipada": null,
    "adicional_noturno": null,
    "extra_noturno": null,
    "ch": "",
    "tratamentos": [
      {
        "time": null,
        "type": "P",
        "tratamento": {
          "name": "Feriado01",
          "date": "2015-04-29"
        }
      }
    ]
  }
]

Filtrando funcionários por empresa

Este método retorna uma coleção de objetos para o dia do cartão ponto.

Endpoint

GET /v1/relatorios/funcionarios/ponto_diario/:date

Parameters

Name	Description
date	(Date) Data do dia do cartão ponto. Ex: "01-01-2019"
empresa_uid	(String) UID da empresa

Request

Route

GET /v1/relatorios/funcionarios/ponto_diario/2015-04-29?empresa_uid=a43bedds-ba77-4062-46c0-58f4444dad33

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

Query Parameters

empresa_uid=a43bedds-ba77-4062-46c0-58f4444dad33

cURL

curl -g "http://api.lvh.me:3000/v1/relatorios/funcionarios/ponto_diario/2015-04-29?empresa_uid=a43bedds-ba77-4062-46c0-58f4444dad33" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto funcionário (ver artigo funcionarios).
pontos_originais	(Array) Lista de marcações originais do dia.
pontos_processados	(Array) Lista de marcações processadas do dia.
total	(Int) Total trabalhado em segundos.
extra	(Int) Total de extra em segundos.
falta	(Int) Total de falta em segundos.
atraso	(Int) Total de atraso em segundos.
saida_antecipada	(Int) Total de atraso em segundos.
adicional_noturno	(Int) Total de adicional noturno em segundos.
extra_noturno	(Int) Total de extra noturna em segundos.
ch	(Int) Código do horário.
tratamentos[time]	(Time) Hora ou Quantidade de hora total do tratamento.
tratamentos[type]	(String) Tipo da Ocorrência. Ex: I = Inclusão.
tratamentos[tratamento]	(Object) Objeto de Tratamento. Ex: Feriado, DSR, Banco de Horas, Inclusão de Ponto etc.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"49cfe1de933c397593a9a03137c1b8ba"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 16024051-361f-474d-8cec-ef7415c1287a
X-Runtime: 0.045380
Vary: Origin
Content-Length: 1605

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": null,
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "1",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "pontos_originais": [

    ],
    "pontos_processados": [

    ],
    "total": null,
    "extra": 0,
    "falta": 0,
    "atraso": null,
    "saida_atecipada": null,
    "adicional_noturno": null,
    "extra_noturno": null,
    "ch": "",
    "tratamentos": [
      {
        "time": null,
        "type": "P",
        "tratamento": {
          "name": "Feriado01",
          "date": "2015-04-29"
        }
      }
    ]
  }
]

Listando cartão ponto por dia com Feriado

Este método retorna uma coleção de objetos para o dia do cartão ponto.

Endpoint

GET /v1/relatorios/funcionarios/ponto_diario/:date

Parameters

Name	Description
date	(Date) Data do dia do cartão ponto. Ex: "01-01-2019"

Request

Route

GET /v1/relatorios/funcionarios/ponto_diario/2015-04-29

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/relatorios/funcionarios/ponto_diario/2015-04-29" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto funcionário (ver artigo funcionarios).
pontos_originais	(Array) Lista de marcações originais do dia.
pontos_processados	(Array) Lista de marcações processadas do dia.
total	(Int) Total trabalhado em segundos.
extra	(Int) Total de extra em segundos.
falta	(Int) Total de falta em segundos.
atraso	(Int) Total de atraso em segundos.
saida_antecipada	(Int) Total de atraso em segundos.
adicional_noturno	(Int) Total de adicional noturno em segundos.
extra_noturno	(Int) Total de extra noturna em segundos.
ch	(Int) Código do horário.
tratamentos[time]	(Time) Hora ou Quantidade de hora total do tratamento.
tratamentos[type]	(String) Tipo da Ocorrência. Ex: I = Inclusão.
tratamentos[tratamento]	(Object) Objeto de Tratamento. Ex: Feriado, DSR, Banco de Horas, Inclusão de Ponto etc.
tratamento[name]	(String) Nome do feriado.
tratamento[date]	(Date) Data do feriado.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"49cfe1de933c397593a9a03137c1b8ba"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: bc604725-b4fc-47c2-a958-d4e13e66b985
X-Runtime: 0.072308
Vary: Origin
Content-Length: 1605

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": null,
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "1",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "pontos_originais": [

    ],
    "pontos_processados": [

    ],
    "total": null,
    "extra": 0,
    "falta": 0,
    "atraso": null,
    "saida_atecipada": null,
    "adicional_noturno": null,
    "extra_noturno": null,
    "ch": "",
    "tratamentos": [
      {
        "time": null,
        "type": "P",
        "tratamento": {
          "name": "Feriado01",
          "date": "2015-04-29"
        }
      }
    ]
  }
]

Listando cartão ponto por dia com Feriado Regional

Este método retorna uma coleção de objetos para o dia do cartão ponto.

Endpoint

GET /v1/relatorios/funcionarios/ponto_diario/:date

Parameters

Name	Description
date	(Date) Data do dia do cartão ponto. Ex: "01-01-2019"

Request

Route

GET /v1/relatorios/funcionarios/ponto_diario/2015-04-29

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/relatorios/funcionarios/ponto_diario/2015-04-29" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto funcionário (ver artigo funcionarios).
pontos_originais	(Array) Lista de marcações originais do dia.
pontos_processados	(Array) Lista de marcações processadas do dia.
total	(Int) Total trabalhado em segundos.
extra	(Int) Total de extra em segundos.
falta	(Int) Total de falta em segundos.
atraso	(Int) Total de atraso em segundos.
saida_antecipada	(Int) Total de atraso em segundos.
adicional_noturno	(Int) Total de adicional noturno em segundos.
extra_noturno	(Int) Total de extra noturna em segundos.
ch	(Int) Código do horário.
tratamentos[time]	(Time) Hora ou Quantidade de hora total do tratamento.
tratamentos[type]	(String) Tipo da Ocorrência. Ex: I = Inclusão.
tratamentos[tratamento]	(Object) Objeto de Tratamento. Ex: Feriado, DSR, Banco de Horas, Inclusão de Ponto etc.
tratamento[name]	(String) Nome do feriado.
tratamento[facultativo]	(Boolean) Se o feriado é facultativo.
tratamento[date]	(Date) Data do feriado.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"f069408f02c12a4c2c5e70a209a522af"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 5db8c132-1414-44ad-b456-1a47fb71dcd7
X-Runtime: 0.063509
Vary: Origin
Content-Length: 1635

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": null,
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "1",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "pontos_originais": [

    ],
    "pontos_processados": [

    ],
    "total": null,
    "extra": 0,
    "falta": 0,
    "atraso": null,
    "saida_atecipada": null,
    "adicional_noturno": null,
    "extra_noturno": null,
    "ch": "",
    "tratamentos": [
      {
        "time": null,
        "type": "P",
        "tratamento": {
          "date": "2015-04-29",
          "facultativo": false,
          "name": "Feriado de Teste 01"
        }
      }
    ]
  }
]

Listando cartão ponto por dia com Ponto incluido manualmente.

Este método retorna uma coleção de objetos para o dia do cartão ponto.

Endpoint

GET /v1/relatorios/funcionarios/ponto_diario/:date

Parameters

Name	Description
date	(Date) Data do dia do cartão ponto. Ex: "01-01-2019"

Request

Route

GET /v1/relatorios/funcionarios/ponto_diario/2015-04-29

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/relatorios/funcionarios/ponto_diario/2015-04-29" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto funcionário (ver artigo funcionarios).
pontos_originais	(Array) Lista de marcações originais do dia.
pontos_processados	(Array) Lista de marcações processadas do dia.
total	(Int) Total trabalhado em segundos.
extra	(Int) Total de extra em segundos.
falta	(Int) Total de falta em segundos.
atraso	(Int) Total de atraso em segundos.
saida_antecipada	(Int) Total de atraso em segundos.
adicional_noturno	(Int) Total de adicional noturno em segundos.
extra_noturno	(Int) Total de extra noturna em segundos.
ch	(Int) Código do horário.
tratamentos[time]	(Time) Hora ou Quantidade de hora total do tratamento.
tratamentos[type]	(String) Tipo da Ocorrência. Ex: I = Inclusão.
tratamentos[tratamento]	(Object) Objeto de Tratamento. Ex: Feriado, DSR, Banco de Horas, Inclusão de Ponto etc.
tratamento[data]	(Date) Data do ponto.
tratamento[hora]	(Time) Hora do ponto.
tratamento[ordem]	(Int) Posição do ponto no dia.
tratamento[tipo]	(String) Tipo do tratamento. Ex: I = Incluído.
tratamento[motivo]	(Motivo) Objeto Motivo (ver artigo Motivos).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"460f6746b743ac700d32daa875a81792"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: a189ff5c-94e7-4de7-9023-7b341fb0ec0d
X-Runtime: 0.044724
Vary: Origin
Content-Length: 1745

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": null,
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "1",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "pontos_originais": [

    ],
    "pontos_processados": [
      "2000-01-01T06:45:00.000Z"
    ],
    "total": null,
    "extra": 0,
    "falta": 0,
    "atraso": null,
    "saida_atecipada": null,
    "adicional_noturno": null,
    "extra_noturno": null,
    "ch": "",
    "tratamentos": [
      {
        "time": "06:45",
        "type": "I",
        "tratamento": {
          "data": "2015-04-29",
          "hora": "2000-01-01T06:45:00.000Z",
          "ordem": 0,
          "tipo": null,
          "motivo": {
            "id": 267869265,
            "name": "Afastado(+de15dias)",
            "e_social_id": null
          }
        }
      }
    ]
  }
]

Listando cartão ponto por dia com banco de horas

Este método retorna uma coleção de objetos para o dia do cartão ponto.

Endpoint

GET /v1/relatorios/funcionarios/ponto_diario/:date

Parameters

Name	Description
date	(Date) Data do dia do cartão ponto. Ex: "01-01-2019"

Request

Route

GET /v1/relatorios/funcionarios/ponto_diario/2015-04-29

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/relatorios/funcionarios/ponto_diario/2015-04-29" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto funcionário (ver artigo funcionarios).
pontos_originais	(Array) Lista de marcações originais do dia.
pontos_processados	(Array) Lista de marcações processadas do dia.
total	(Int) Total trabalhado em segundos.
extra	(Int) Total de extra em segundos.
falta	(Int) Total de falta em segundos.
atraso	(Int) Total de atraso em segundos.
saida_antecipada	(Int) Total de atraso em segundos.
adicional_noturno	(Int) Total de adicional noturno em segundos.
extra_noturno	(Int) Total de extra noturna em segundos.
ch	(Int) Código do horário.
tratamentos[time]	(Time) Hora ou Quantidade de hora total do tratamento.
tratamentos[type]	(String) Tipo da Ocorrência. Ex: I = Inclusão.
tratamentos[tratamento]	(Object) Objeto de Tratamento. Ex: Feriado, DSR, Banco de Horas, Inclusão de Ponto etc.
tratamento[data]	(Date) Data da operação do banco de horas.
tratamento[hora]	(Time) Quantidade de horas da operação.
tratamento[motivo]	(Motivo) Objeto Motivo (ver artigo Motivos).
tratamento[forced]	(Boolean) Se a operação foi incluida ou modificada manualmente.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"98fd549fd7c78801e9566a72e9ef338b"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: fba5b005-7853-4b58-8016-243e502690c0
X-Runtime: 0.047056
Vary: Origin
Content-Length: 1700

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": null,
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "1",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "pontos_originais": [

    ],
    "pontos_processados": [

    ],
    "total": null,
    "extra": 0,
    "falta": 0,
    "atraso": null,
    "saida_atecipada": null,
    "adicional_noturno": null,
    "extra_noturno": null,
    "ch": "",
    "tratamentos": [
      {
        "time": "01:00",
        "type": "I",
        "tratamento": {
          "date": "2015-04-29",
          "hora": "2000-01-01T01:00:32.000Z",
          "motivo": {
            "id": 603690436,
            "name": "B.H.(-)",
            "e_social_id": null
          },
          "forced": false
        }
      }
    ]
  }
]

Listando cartão ponto por dia com compensação

Este método retorna uma coleção de objetos para o dia do cartão ponto.

Endpoint

GET /v1/relatorios/funcionarios/ponto_diario/:date

Parameters

Name	Description
date	(Date) Data do dia do cartão ponto. Ex: "01-01-2019"

Request

Route

GET /v1/relatorios/funcionarios/ponto_diario/2015-04-29

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/relatorios/funcionarios/ponto_diario/2015-04-29" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto funcionário (ver artigo funcionarios).
pontos_originais	(Array) Lista de marcações originais do dia.
pontos_processados	(Array) Lista de marcações processadas do dia.
total	(Int) Total trabalhado em segundos.
extra	(Int) Total de extra em segundos.
falta	(Int) Total de falta em segundos.
atraso	(Int) Total de atraso em segundos.
saida_antecipada	(Int) Total de atraso em segundos.
adicional_noturno	(Int) Total de adicional noturno em segundos.
extra_noturno	(Int) Total de extra noturna em segundos.
ch	(Int) Código do horário.
tratamentos[time]	(Time) Hora ou Quantidade de hora total do tratamento.
tratamentos[type]	(String) Tipo da Ocorrência. Ex: I = Inclusão.
tratamentos[tratamento]	(Object) Objeto de Tratamento. Ex: Feriado, DSR, Banco de Horas, Inclusão de Ponto etc.
tratamento[data]	(Date) Data da compensação.
tratamento[hora]	(Time) Quantidade de horas da compensação.
tratamento[tipo]	(String) Tipo da compensação.
tratamento[forced]	(Boolean) Se a compensação foi incluida manualmente.
tratamento[motivo]	(Motivo) Objeto Motivo (ver artigo Motivos).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"2a1dd61b594b029bbc5db1bcd16dce14"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: d01f5f40-eda2-4d29-bfd5-35af4b256da6
X-Runtime: 0.047028
Vary: Origin
Content-Length: 1708

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": null,
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "1",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "pontos_originais": [

    ],
    "pontos_processados": [

    ],
    "total": 0,
    "extra": 0,
    "falta": 0,
    "atraso": 0,
    "saida_atecipada": 0,
    "adicional_noturno": 0,
    "extra_noturno": null,
    "ch": 11,
    "tratamentos": [
      {
        "time": "03:00",
        "type": "I",
        "tratamento": {
          "date": "2015-04-29",
          "hora": "2000-01-01T03:00:00.000Z",
          "tipo": "A",
          "forced": false,
          "motivo": {
            "id": 144349274,
            "name": "Auxílio Doença",
            "e_social_id": null
          }
        }
      }
    ]
  }
]

Listando cartão ponto por dia com justificativa

Este método retorna uma coleção de objetos para o dia do cartão ponto.

Endpoint

GET /v1/relatorios/funcionarios/ponto_diario/:date

Parameters

Name	Description
date	(Date) Data do dia do cartão ponto. Ex: "01-01-2019"

Request

Route

GET /v1/relatorios/funcionarios/ponto_diario/2015-04-29

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/relatorios/funcionarios/ponto_diario/2015-04-29" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto funcionário (ver artigo funcionarios).
pontos_originais	(Array) Lista de marcações originais do dia.
pontos_processados	(Array) Lista de marcações processadas do dia.
total	(Int) Total trabalhado em segundos.
extra	(Int) Total de extra em segundos.
falta	(Int) Total de falta em segundos.
atraso	(Int) Total de atraso em segundos.
saida_antecipada	(Int) Total de atraso em segundos.
adicional_noturno	(Int) Total de adicional noturno em segundos.
extra_noturno	(Int) Total de extra noturna em segundos.
ch	(Int) Código do horário.
tratamentos[time]	(Time) Hora ou Quantidade de hora total do tratamento.
tratamentos[type]	(String) Tipo da Ocorrência. Ex: I = Inclusão.
tratamentos[tratamento]	(Object) Objeto de Tratamento. Ex: Feriado, DSR, Banco de Horas, Inclusão de Ponto etc.
tratamento[id]	(Int) Id da justificativa.
tratamento[data]	(Date) Data da justificativa.
tratamento[hora]	(Time) Quantidade de horas da justificativa.
tratamento[descontar_dsr]	(Boolean) Descontar D.S.R.?
tratamento[abonar]	(Boolean) Justificar com abono de horas trabalhadas?
tratamento[motivo]	(Motivo) Objeto Motivo (ver artigo Motivos).
tratamento[motivo_personalizado]	(Motivo) Objeto Motivo (ver artigo Motivos).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"6f3118e3bd18a75277b2668d6825cf86"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: ff57e860-10a0-4d9e-8238-c46e59c4d1dc
X-Runtime: 0.046543
Vary: Origin
Content-Length: 1759

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": null,
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "1",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "pontos_originais": [

    ],
    "pontos_processados": [

    ],
    "total": null,
    "extra": 0,
    "falta": 0,
    "atraso": null,
    "saida_atecipada": null,
    "adicional_noturno": null,
    "extra_noturno": null,
    "ch": "",
    "tratamentos": [
      {
        "time": "08:00",
        "type": "I",
        "tratamento": {
          "id": 516301284,
          "data": "2015-04-29",
          "hora": "2000-01-01T08:00:00.000Z",
          "desconta_dsr": false,
          "abonar": true,
          "motivo": {
            "id": 385748469,
            "name": "APS",
            "e_social_id": null
          },
          "motivo_personalizado": null
        }
      }
    ]
  }
]

Listando cartão ponto por dia com mudança de carga horária

Este método retorna uma coleção de objetos para o dia do cartão ponto.

Endpoint

GET /v1/relatorios/funcionarios/ponto_diario/:date

Parameters

Name	Description
date	(Date) Data do dia do cartão ponto. Ex: "01-01-2019"

Request

Route

GET /v1/relatorios/funcionarios/ponto_diario/2015-04-29

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/relatorios/funcionarios/ponto_diario/2015-04-29" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto funcionário (ver artigo funcionarios).
pontos_originais	(Array) Lista de marcações originais do dia.
pontos_processados	(Array) Lista de marcações processadas do dia.
total	(Int) Total trabalhado em segundos.
extra	(Int) Total de extra em segundos.
falta	(Int) Total de falta em segundos.
atraso	(Int) Total de atraso em segundos.
saida_antecipada	(Int) Total de atraso em segundos.
adicional_noturno	(Int) Total de adicional noturno em segundos.
extra_noturno	(Int) Total de extra noturna em segundos.
ch	(Int) Código do horário.
tratamentos[time]	(Time) Hora ou Quantidade de hora total do tratamento.
tratamentos[type]	(String) Tipo da Ocorrência. Ex: I = Inclusão.
tratamentos[tratamento]	(Object) Objeto de Tratamento. Ex: Feriado, DSR, Banco de Horas, Inclusão de Ponto etc.
tratamento[data]	(Date) Data da mudança.
tratamento[carga_horaria]	(Time) Carga horária do dia
tratamento[extra_total]	(Boolean) Aplica carga horária para extra?
tratamento[sem_extra]	(Boolean) Não gerar extra para a nova carga horária.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"cc6fd8a39b98ff9a5202d5ffd1d6e293"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: d4f7fe79-3205-44a4-a154-b9d3c0fe9ccb
X-Runtime: 0.045625
Vary: Origin
Content-Length: 1672

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": null,
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "1",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "pontos_originais": [

    ],
    "pontos_processados": [

    ],
    "total": null,
    "extra": 0,
    "falta": 0,
    "atraso": null,
    "saida_atecipada": null,
    "adicional_noturno": null,
    "extra_noturno": null,
    "ch": "MH",
    "tratamentos": [
      {
        "time": "08:00",
        "type": "P",
        "tratamento": {
          "carga_horaria": "2000-01-01T08:00:00.000Z",
          "data": "2015-04-29",
          "extra_total": false,
          "sem_extra": false
        }
      }
    ]
  }
]

Funcionários > Presentes

Listando erros para requisição com data inválida

Este método retorna a reposta para parametros inválidos.

Endpoint

GET /v1/funcionarios/presentes/:from/ate/:to

Parameters

Name	Description
from required	(Date) Data inicial do relatório.
to required	(Date) Data final do relatório.

Request

Route

GET /v1/funcionarios/presentes/2015-01-33/ate/2015-01-31

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios/presentes/2015-01-33/ate/2015-01-31" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto Funcionário (ver artigo Funcionários).
dias	(Array) Dias de presença.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: edf6742a-dd44-41d4-b4d5-4d01ee6b3b04
X-Runtime: 0.034043
Vary: Origin
Content-Length: 26

Body

{
  "message": "Invalid Date"
}

Listando os funcionários presentes entre as datas

Este método retorna uma coleção de funcionários presentes dado um intervalo de datas.

Endpoint

GET /v1/funcionarios/presentes/:from/ate/:to

Parameters

Name	Description
from required	(Date) Data inicial do relatório.
to required	(Date) Data final do relatório.

Request

Route

GET /v1/funcionarios/presentes/2015-01-01/ate/2015-01-31

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios/presentes/2015-01-01/ate/2015-01-31" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto Funcionário (ver artigo Funcionários).
dias	(Array) Dias de presença.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"6251e5c85102fbe1073bb1613a46b8aa"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 6160a38a-12a4-443f-b324-03fc79fdb57e
X-Runtime: 0.069424
Vary: Origin
Content-Length: 1372

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2015-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "days": [
      "2015-01-01"
    ]
  }
]

Funcionários > Quadros de Horas

Desvinculando um Quadro de Horas

Este método desvincula um Quadro de Horas do funcionário num determinado histórico.

Endpoint

DELETE /v1/funcionarios/:funcionario_uid/quadros_de_horas/:id

Parameters

Name	Description
funcionario_uid required	(String) UID do funcionário.
id required	(Int) ID do histórico do vinculo do Quadro de horas (ver artigo Historico de Quadro de Horas).

Request

Route

DELETE /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/quadros_de_horas/980190962

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0/quadros_de_horas/980190962" -d '' -X DELETE \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache
X-Request-Id: f14cb48c-b9a3-40fa-8f8a-1c9c53d85249
X-Runtime: 0.037022
Vary: Origin

Listando Histórico de Quadros de Horas

Este método retorna um array de quadros de horas vinculados.

Endpoint

GET /v1/funcionarios/:funcionario_uid/quadros_de_horas

Parameters

Name	Description
funcionario_uid required	(String) UID do funcionário.

Request

Route

GET /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d6/quadros_de_horas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d6/quadros_de_horas" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) ID do registro do histórico de vinculo do quadro de horas.
data_vigencia	(Date) Data de vigência do quadro de horas.
quadro_de_hora	(Object) Dados do Objeto Quadro de horas.
quadro_de_hora[hora_virada]	(Time) Hora da virada do quadro de horas.
quadro_de_hora[name]	(String) Nome do quadro de horas.
quadro_de_hora[tipo]	(String) Tipo do quadro de horas.
quadro_de_hora[use_holiday]	(Boolean) Se o quadro de horas utiliza feriados nacionais.
quadro_de_hora[folgas_especiais]	(Int) Número de folgas especiais.
quadro_de_hora[ativo]	(Boolean) Se o quadro de horas está atualmente ativo.
quadro_de_hora[ch]	(Int) Código do Horário.
quadro_de_hora[marcacao_automatica_intervalo]	(Object) Configurações de Marcações Automaticas de Intervalo.
marcacao_automatica_intervalo[hora_inicio]	(Time) Hora de inicio do intervalo.
marcacao_automatica_intervalo[hora_fim]	(Time) Hora de término do intervalo.
marcacao_automatica_intervalo[tolerancia]	(Int) Tolerância em segundos.
marcacao_automatica_intervalo[domingo]	(Boolean) Marcação para válida para domingo.
marcacao_automatica_intervalo[segunda]	(Boolean) Marcação para válida para segunda.
marcacao_automatica_intervalo[terca]	(Boolean) Marcação para válida para terça.
marcacao_automatica_intervalo[quarta]	(Boolean) Marcação para válida para quarta.
marcacao_automatica_intervalo[quinta]	(Boolean) Marcação para válida para quinta.
marcacao_automatica_intervalo[sexta]	(Boolean) Marcação para válida para sexta.
marcacao_automatica_intervalo[sabado]	(Boolean) Marcação para válida para sábado.
marcacao_automatica_intervalo[feriado]	(Boolean) Marcação para válida para feriado.
quadro_de_hora[tolerancia]	(Object) Configurações de Tolerância.
tolerancia[tolerancia_fixa]	(Boolean) Se utiliza tolerância fixa.
tolerancia[tolerancia_fixa_entrada]	(Int) Tolerância fixa para entradas em minutos.
tolerancia[tolerancia_fixa_saida]	(Int) Tolerância fixa para saidas em minutos.
tolerancia[tolerancia_global_extra]	(Int) Tolerância global para extra em minutos.
tolerancia[tolerancia_global_falta]	(Int) Tolerância global para falta em minutos.
quadro_de_hora[horario]	(Mixed) Configurações do quadro de horários de entradas e saídas. O valor pode ser string ou um objeto.
horario[tipo_periodo]	(String) Nome do tipo do período.
horario[carga_horaria]	(Int) Carga horária total em segundos.
horario[carga_horaria_faixa]	(Object) Detalhes da faixa de dias que abrange a carga horária.
carga_horaria_faixa[domingo]	(Time) Carga horária para domingo.
carga_horaria_faixa[segunda]	(Time) Carga horária para segunda.
carga_horaria_faixa[terca]	(Time) Carga horária para terça.
carga_horaria_faixa[quarta]	(Time) Carga horária para quarta.
carga_horaria_faixa[quinta]	(Time) Carga horária para quinta.
carga_horaria_faixa[sexta]	(Time) Carga horária para sexta.
carga_horaria_faixa[sabado]	(Time) Carga horária para sábado.
carga_horaria_faixa[feriado]	(Time) Carga horária para feriado.
horario[carga_horaria_folga]	(Object) Detalhes da faixa de dias para folga.
carga_horaria_folga[domingo]	(Boolean) Se a carga horária é válida para domingo.
carga_horaria_folga[segunda]	(Boolean) Se a carga horária é válida para segunda.
carga_horaria_folga[terca]	(Boolean) Se a carga horária é válida para terça.
carga_horaria_folga[quarta]	(Boolean) Se a carga horária é válida para quarta.
carga_horaria_folga[quinta]	(Boolean) Se a carga horária é válida para quinta.
carga_horaria_folga[sexta]	(Boolean) Se a carga horária é válida para sexta.
carga_horaria_folga[sabado]	(Boolean) Se a carga horária é válida para sábado.
carga_horaria_folga[feriado]	(Boolean) Se a carga horária é válida para feriado.
horario[wdays]	(Array) Array de objetos [Wday]. Quadro de horário dia a dia. Cada objeto representa um par de entrada e saída do dia.
wdays[entrada]	(Time) Hora de entrada.
wdays[retorno]	(Time) Hora de saída.
wdays[total]	(Time) Total de horas do dia.
wdays[wday]	(Int) Dia da semana da configuração. Começando em 0 = domingo, até 6 = sábado. E 7 é feriado.
quadro_de_hora[intervalo]	(Object) Configurações de Intervalos (café).
intervalo[motivo_id]	(Int) ID do Motivo.
intervalo[tolerancia]	(Int) Tolerância do intervalo em segundos.
intervalo[wdays]	(Array) Array de objetos [Wday]. Quadro de intervalos dia a dia. Cada objeto representa um par de intervalo e retorno do dia.
wdays[intervalo]	(Time) Hora de entrada no intervalo.
wdays[retorno]	(Time) Hora de retorno do intervalo.
wdays[total]	(Time) Total de horas do intervalo.
wdays[wday]	(Int) Dia da semana da configuração. Começando em 0 = domingo, até 6 = sábado. E 7 é feriado.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"d68650055b9ca4fcdc2df6c637931106"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 55a756d6-9289-404f-bab0-8160b77ce1e1
X-Runtime: 0.093968
Vary: Origin
Content-Length: 1211

Body

[
  {
    "id": 800153120,
    "data_vigencia": "2016-02-25",
    "quadro_de_hora": {
      "hora_virada": "2000-01-01T00:00:00.000Z",
      "name": "Quadro Carga Faixa",
      "tipo": "carga_horaria",
      "use_holiday": true,
      "folgas_especiais": 0,
      "ativo": true,
      "ch": null,
      "marcacao_automatica_intervalo": null,
      "tolerancia": null,
      "horario": {
        "tipo_periodo": "faixas",
        "carga_horaria": 0,
        "carga_horaria_faixa": {
          "domingo": "2000-01-01T00:00:00.000Z",
          "segunda": "2000-01-01T08:30:00.000Z",
          "terca": "2000-01-01T08:30:00.000Z",
          "quarta": "2000-01-01T08:30:00.000Z",
          "quinta": "2000-01-01T08:30:00.000Z",
          "sexta": "2000-01-01T08:30:00.000Z",
          "sabado": "2000-01-01T03:30:00.000Z",
          "feriado": "2000-01-01T00:00:00.000Z"
        },
        "carga_horaria_folga": null
      },
      "intervalo": null
    }
  },
  {
    "id": 281110143,
    "data_vigencia": "2015-08-01",
    "quadro_de_hora": {
      "hora_virada": "2000-01-01T00:00:00.000Z",
      "name": "Quadro Craga Semanal",
      "tipo": "carga_horaria",
      "use_holiday": true,
      "folgas_especiais": 0,
      "ativo": true,
      "ch": null,
      "marcacao_automatica_intervalo": null,
      "tolerancia": null,
      "horario": {
        "tipo_periodo": "semanal",
        "carga_horaria": 158400,
        "carga_horaria_faixa": null,
        "carga_horaria_folga": {
          "domingo": true,
          "segunda": false,
          "terca": false,
          "quarta": false,
          "quinta": false,
          "sexta": false,
          "sabado": false,
          "feriado": true
        }
      },
      "intervalo": null
    }
  }
]

Vinculando um Quadro de Horas

Este método vincula o quadro de horas (ch) ao funcionário numa data de vigência.

Endpoint

POST /v1/funcionarios/:funcionario_uid/quadros_de_horas

Parameters

Name	Description
funcionario_uid required	(String) UID do funcionário.
funcionario_quadro_de_hora[data_vigencia] required	(Date) Data de vigência.
funcionario_quadro_de_hora[ch] required	(Int) Código do Horário.

Request

Route

POST /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d6/quadros_de_horas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

funcionario_quadro_de_hora[data_vigencia]=2018-01-10&funcionario_quadro_de_hora[ch]=11

cURL

curl "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d6/quadros_de_horas" -d 'funcionario_quadro_de_hora[data_vigencia]=2018-01-10&funcionario_quadro_de_hora[ch]=11' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) ID do histórico criado do vinculo.
data_vigencia	(Date) Data de vigência.
ch	(Int) Código do Horário.
quadro_de_hora	(Object) Objeto Quadro de Horas.
errors[name]	Array of error messages of field name.
errors[apelido]	Array of error messages of field apelido.
errors[data_lancamento]	Array of error messages of field data_lancamento.
errors[descricao]	Array of error messages of field descricao.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"ad392d91a9c125874b5a8c3a994e9702"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 0c034a8c-c396-4d9f-abbf-e9c9a2dbd6e5
X-Runtime: 0.094078
Vary: Origin
Content-Length: 291

Body

{
  "id": 1056999340,
  "data_vigencia": "2018-01-10",
  "quadro_de_hora": {
    "hora_virada": "2000-01-01T00:00:00.000Z",
    "name": "Quadro Livre",
    "tipo": "livre",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": 11,
    "marcacao_automatica_intervalo": null,
    "tolerancia": null,
    "horario": null,
    "intervalo": null
  }
}

Vinculando um Quadro de Horas - erros

Este método mostra falhas na validação do vinculo do quadro de horas ao funcionário.

Endpoint

POST /v1/funcionarios/:funcionario_uid/quadros_de_horas

Parameters

Name	Description
funcionario_uid required	(String) UID do funcionário.
funcionario_quadro_de_hora[data_vigencia] required	(Date) Data de vigência.
funcionario_quadro_de_hora[ch] required	(Int) Código do Horário.

Request

Route

POST /v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d6/quadros_de_horas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

funcionario_quadro_de_hora[data_vigencia]=

cURL

curl "http://api.lvh.me:3000/v1/funcionarios/71ba8bd7-3b65-40fa-8e11-7daf5f0fe2d6/quadros_de_horas" -d 'funcionario_quadro_de_hora[data_vigencia]=' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
message	(String) Mensagem da requisição.
errors[data_vigencia]	(Array) Erros do parâmetro Data Vigência.
errors[ch]	(Array) Erros do parâmetro CH.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: e9a28cca-002b-446a-ae72-261a8f5a1ca5
X-Runtime: 0.071975
Vary: Origin
Content-Length: 117

Body

{
  "message": "Validation Failed!",
  "errors": {
    "data_vigencia": [
      "can't be blank",
      "Invalid Date"
    ],
    "ch": [
      "can't be blank"
    ]
  }
}

Motivos

Listando Motivos E-Social

Este método retorna os motivos previstos na tabela E-Social.

Endpoint

GET /v1/motivos/common

Request

Route

GET /v1/motivos/common

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/motivos/common" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) ID do Motivo.
name	(String) Nome do motivo.
e_social_id	(Int) Código E-social do motivo.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"1e858bb19b96b9a27446f130974dae63"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: baa29722-c748-4fba-86b3-3cf7086339a0
X-Runtime: 0.059252
Vary: Origin
Content-Length: 882

Body

[
  {
    "id": 267869265,
    "name": "Afastado(+de15dias)",
    "e_social_id": null
  },
  {
    "id": 385748469,
    "name": "APS",
    "e_social_id": null
  },
  {
    "id": 569982306,
    "name": "Atestado Médico",
    "e_social_id": null
  },
  {
    "id": 1067296963,
    "name": "Atestado Médico - Acompanhamento",
    "e_social_id": null
  },
  {
    "id": 144349274,
    "name": "Auxílio Doença",
    "e_social_id": null
  },
  {
    "id": 294898158,
    "name": "Aviso Prévio",
    "e_social_id": null
  },
  {
    "id": 603690436,
    "name": "B.H.(-)",
    "e_social_id": null
  },
  {
    "id": 621492253,
    "name": "B.H.(+)",
    "e_social_id": null
  },
  {
    "id": 650723652,
    "name": "Compensado Extra",
    "e_social_id": null
  },
  {
    "id": 522203626,
    "name": "CP.(+)",
    "e_social_id": null
  },
  {
    "id": 138563155,
    "name": "D.S.R.(-)",
    "e_social_id": null
  },
  {
    "id": 367989381,
    "name": "D.S.R.(+)",
    "e_social_id": null
  },
  {
    "id": 270258126,
    "name": "Falta Marcação",
    "e_social_id": null
  },
  {
    "id": 377277181,
    "name": "Folga",
    "e_social_id": null
  },
  {
    "id": 228619110,
    "name": "Intervalo café",
    "e_social_id": null
  }
]

Listando Motivos Personalizados

Este método retorna os motivos personalizados criados pelo usuário.

Endpoint

GET /v1/motivos/personalizados

Request

Route

GET /v1/motivos/personalizados

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/motivos/personalizados" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) ID do Motivo.
name	(String) Nome do motivo.
e_social_id	(Int) Código E-social do motivo.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"d30776f758ef1e8e0abd29b753366eee"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 4ae4df2d-ff19-4113-a6d0-541f43e12a2a
X-Runtime: 0.040255
Vary: Origin
Content-Length: 127

Body

[
  {
    "id": 3656553,
    "name": "Intervalo café",
    "e_social_id": null
  },
  {
    "id": 1067296965,
    "name": "Motivo Personalizado",
    "e_social_id": null
  }
]

Quadros de Horas

Listando quadros de horas

Este método retorna um array de Quadros de Horas.

Endpoint

GET /v1/quadro_de_horas

Request

Route

GET /v1/quadro_de_horas

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/quadro_de_horas" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
hora_virada	(Time) Hora da virada do quadro de horas.
name	(String) Nome do quadro de horas.
tipo	(String) Tipo do quadro de horas.
use_holiday	(Boolean) Se o quadro de horas utiliza feriados nacionais.
folgas_especiais	(Int) Número de folgas especiais.
ativo	(Boolean) Se o quadro de horas está atualmente ativo.
ch	(Int) Código do Horário.
marcacao_automatica_intervalo	(Object) Configurações de Marcações Automaticas de Intervalo.
marcacao_automatica_intervalo[hora_inicio]	(Time) Hora de inicio do intervalo.
marcacao_automatica_intervalo[hora_fim]	(Time) Hora de término do intervalo.
marcacao_automatica_intervalo[tolerancia]	(Int) Tolerância em segundos.
marcacao_automatica_intervalo[domingo]	(Boolean) Marcação para válida para domingo.
marcacao_automatica_intervalo[segunda]	(Boolean) Marcação para válida para segunda.
marcacao_automatica_intervalo[terca]	(Boolean) Marcação para válida para terça.
marcacao_automatica_intervalo[quarta]	(Boolean) Marcação para válida para quarta.
marcacao_automatica_intervalo[quinta]	(Boolean) Marcação para válida para quinta.
marcacao_automatica_intervalo[sexta]	(Boolean) Marcação para válida para sexta.
marcacao_automatica_intervalo[sabado]	(Boolean) Marcação para válida para sábado.
marcacao_automatica_intervalo[feriado]	(Boolean) Marcação para válida para feriado.
tolerancia	(Object) Configurações de Tolerância.
tolerancia[tolerancia_fixa]	(Boolean) Se utiliza tolerância fixa.
tolerancia[tolerancia_fixa_entrada]	(Int) Tolerância fixa para entradas em minutos.
tolerancia[tolerancia_fixa_saida]	(Int) Tolerância fixa para saidas em minutos.
tolerancia[tolerancia_global_extra]	(Int) Tolerância global para extra em minutos.
tolerancia[tolerancia_global_falta]	(Int) Tolerância global para falta em minutos.
horario	(Mixed) Configurações do quadro de horários de entradas e saídas. O valor pode ser string ou um objeto.
horario[tipo_periodo]	(String) Nome do tipo do período.
horario[carga_horaria]	(Int) Carga horária total em segundos.
horario[carga_horaria_faixa]	(Object) Detalhes da faixa de dias que abrange a carga horária.
carga_horaria_faixa[domingo]	(Time) Carga horária para domingo.
carga_horaria_faixa[segunda]	(Time) Carga horária para segunda.
carga_horaria_faixa[terca]	(Time) Carga horária para terça.
carga_horaria_faixa[quarta]	(Time) Carga horária para quarta.
carga_horaria_faixa[quinta]	(Time) Carga horária para quinta.
carga_horaria_faixa[sexta]	(Time) Carga horária para sexta.
carga_horaria_faixa[sabado]	(Time) Carga horária para sábado.
carga_horaria_faixa[feriado]	(Time) Carga horária para feriado.
horario[carga_horaria_folga]	(Object) Detalhes da faixa de dias para folga.
carga_horaria_folga[domingo]	(Boolean) Se a carga horária é válida para domingo.
carga_horaria_folga[segunda]	(Boolean) Se a carga horária é válida para segunda.
carga_horaria_folga[terca]	(Boolean) Se a carga horária é válida para terça.
carga_horaria_folga[quarta]	(Boolean) Se a carga horária é válida para quarta.
carga_horaria_folga[quinta]	(Boolean) Se a carga horária é válida para quinta.
carga_horaria_folga[sexta]	(Boolean) Se a carga horária é válida para sexta.
carga_horaria_folga[sabado]	(Boolean) Se a carga horária é válida para sábado.
carga_horaria_folga[feriado]	(Boolean) Se a carga horária é válida para feriado.
horario[wdays]	(Array) Array de objetos [Wday]. Quadro de horário dia a dia. Cada objeto representa um par de entrada e saída do dia.
wdays[entrada]	(Time) Hora de entrada.
wdays[retorno]	(Time) Hora de saída.
wdays[total]	(Time) Total de horas do dia.
wdays[wday]	(Int) Dia da semana da configuração. Começando em 0 = domingo, até 6 = sábado. E 7 é feriado.
intervalo	(Object) Configurações de Intervalos (café).
intervalo[motivo_id]	(Int) ID do Motivo.
intervalo[tolerancia]	(Int) Tolerância do intervalo em segundos.
intervalo[wdays]	(Array) Array de objetos [Wday]. Quadro de intervalos dia a dia. Cada objeto representa um par de intervalo e retorno do dia.
wdays[intervalo]	(Time) Hora de entrada no intervalo.
wdays[retorno]	(Time) Hora de retorno do intervalo.
wdays[total]	(Time) Total de horas do intervalo.
wdays[wday]	(Int) Dia da semana da configuração. Começando em 0 = domingo, até 6 = sábado. E 7 é feriado.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"e860f2daeff55e0e7d6d5348830a2a3d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 3709cccf-0d7c-47fb-a584-07ebf318e2ed
X-Runtime: 0.137150
Vary: Origin
Content-Length: 7718

Body

[
  {
    "hora_virada": "2000-01-01T00:00:00.000Z",
    "name": "Quadro Livre",
    "tipo": "livre",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": 11,
    "marcacao_automatica_intervalo": null,
    "tolerancia": null,
    "horario": null,
    "intervalo": null
  },
  {
    "hora_virada": "2000-01-01T00:00:00.000Z",
    "name": "Quadro Livre 2",
    "tipo": "livre",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": null,
    "horario": null,
    "intervalo": null
  },
  {
    "hora_virada": "2000-01-01T00:00:00.000Z",
    "name": "Quadro Flexivel",
    "tipo": "flexivel",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": {
      "tolerancia_fixa": false,
      "tolerancia_fixa_entrada": 5,
      "tolerancia_fixa_saida": 5,
      "tolerancia_global_extra": 10,
      "tolerancia_global_falta": 10
    },
    "horario": {
      "tipo_periodo": "mensal",
      "wdays": [
        {
          "entrada": "2000-01-01T08:30:00.000Z",
          "saida": "2000-01-01T11:30:00.000Z",
          "total": "2000-01-01T03:00:00.000Z",
          "wday": 1
        },
        {
          "entrada": "2000-01-01T13:00:00.000Z",
          "saida": "2000-01-01T18:00:00.000Z",
          "total": "2000-01-01T05:00:00.000Z",
          "wday": 1
        }
      ]
    },
    "intervalo": null
  },
  {
    "hora_virada": "2000-01-01T00:00:00.000Z",
    "name": "Quadro Carga Faixa",
    "tipo": "carga_horaria",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": null,
    "horario": {
      "tipo_periodo": "faixas",
      "carga_horaria": 0,
      "carga_horaria_faixa": {
        "domingo": "2000-01-01T00:00:00.000Z",
        "segunda": "2000-01-01T08:30:00.000Z",
        "terca": "2000-01-01T08:30:00.000Z",
        "quarta": "2000-01-01T08:30:00.000Z",
        "quinta": "2000-01-01T08:30:00.000Z",
        "sexta": "2000-01-01T08:30:00.000Z",
        "sabado": "2000-01-01T03:30:00.000Z",
        "feriado": "2000-01-01T00:00:00.000Z"
      },
      "carga_horaria_folga": null
    },
    "intervalo": null
  },
  {
    "hora_virada": "2000-01-01T00:00:00.000Z",
    "name": "Quadro Craga Semanal",
    "tipo": "carga_horaria",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": null,
    "horario": {
      "tipo_periodo": "semanal",
      "carga_horaria": 158400,
      "carga_horaria_faixa": null,
      "carga_horaria_folga": {
        "domingo": true,
        "segunda": false,
        "terca": false,
        "quarta": false,
        "quinta": false,
        "sexta": false,
        "sabado": false,
        "feriado": true
      }
    },
    "intervalo": null
  },
  {
    "hora_virada": "2000-01-01T00:00:00.000Z",
    "name": "Semanal",
    "tipo": "fixo",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": {
      "tolerancia_fixa": true,
      "tolerancia_fixa_entrada": 5,
      "tolerancia_fixa_saida": 5,
      "tolerancia_global_extra": 10,
      "tolerancia_global_falta": 10
    },
    "horario": {
      "tipo_periodo": "semanal",
      "wdays": [
        {
          "entrada": "2000-01-01T08:00:00.000Z",
          "saida": "2000-01-01T12:00:00.000Z",
          "total": "2000-01-01T04:00:00.000Z",
          "wday": 1
        },
        {
          "entrada": "2000-01-01T14:00:00.000Z",
          "saida": "2000-01-01T18:00:00.000Z",
          "total": "2000-01-01T04:00:00.000Z",
          "wday": 1
        }
      ]
    },
    "intervalo": null
  },
  {
    "hora_virada": "2000-01-01T00:00:00.000Z",
    "name": "Mensal fixo almoco",
    "tipo": "fixo_com_almoco_flexivel",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": {
      "tolerancia_fixa": true,
      "tolerancia_fixa_entrada": 5,
      "tolerancia_fixa_saida": 5,
      "tolerancia_global_extra": 10,
      "tolerancia_global_falta": 10
    },
    "horario": {
      "tipo_periodo": "mensal",
      "wdays": [
        {
          "entrada": "2000-01-01T08:30:00.000Z",
          "saida": "2000-01-01T11:30:00.000Z",
          "total": "2000-01-01T03:00:00.000Z",
          "wday": 1
        },
        {
          "entrada": "2000-01-01T13:00:00.000Z",
          "saida": "2000-01-01T18:00:00.000Z",
          "total": "2000-01-01T05:00:00.000Z",
          "wday": 1
        }
      ]
    },
    "intervalo": null
  },
  {
    "hora_virada": null,
    "name": "Revezamento",
    "tipo": "revezamento",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": null,
    "horario": {
      "escalas": [
        {
          "tipo": "folga",
          "hora_virada": "2000-01-01T00:00:00.000Z",
          "ordem": 1
        },
        {
          "tipo": "livre",
          "hora_virada": "2000-01-01T00:00:00.000Z",
          "ordem": 2
        },
        {
          "tipo": "carga_horaria",
          "hora_virada": "2000-01-01T00:00:00.000Z",
          "ordem": 3
        }
      ]
    },
    "intervalo": null
  },
  {
    "hora_virada": null,
    "name": "flexivel_com_almoco_fixo",
    "tipo": "flexivel_com_almoco_fixo",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": null,
    "horario": "livre",
    "intervalo": null
  },
  {
    "hora_virada": null,
    "name": "flexivel tolerancia",
    "tipo": "flexivel",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": {
      "tolerancia_fixa": false,
      "tolerancia_fixa_entrada": 1,
      "tolerancia_fixa_saida": 1,
      "tolerancia_global_extra": 1,
      "tolerancia_global_falta": 1
    },
    "horario": {
      "tipo_periodo": "semanal",
      "wdays": [
        {
          "entrada": "2000-01-01T08:00:00.000Z",
          "saida": "2000-01-01T12:00:00.000Z",
          "total": "2000-01-01T04:00:00.000Z",
          "wday": 1
        },
        {
          "entrada": "2000-01-01T14:00:00.000Z",
          "saida": "2000-01-01T18:00:00.000Z",
          "total": "2000-01-01T04:00:00.000Z",
          "wday": 1
        }
      ]
    },
    "intervalo": null
  },
  {
    "hora_virada": null,
    "name": "Revezamento 12x36",
    "tipo": "revezamento",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": null,
    "horario": {
      "escalas": [
        {
          "tipo": "carga_horaria",
          "hora_virada": "2000-01-01T00:00:00.000Z",
          "ordem": 1
        },
        {
          "tipo": "folga",
          "hora_virada": "2000-01-01T00:00:00.000Z",
          "ordem": 2
        }
      ]
    },
    "intervalo": null
  },
  {
    "hora_virada": "2000-01-01T00:00:00.000Z",
    "name": "Quadro Flexivel com Marcacao Automatica",
    "tipo": "flexivel",
    "use_holiday": true,
    "folgas_especiais": 2,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": {
      "hora_inicio": "2000-01-01T08:15:19.000Z",
      "hora_fim": "2000-01-01T12:15:19.000Z",
      "tolerancia": 900,
      "domingo": true,
      "segunda": true,
      "terca": true,
      "quarta": true,
      "quinta": true,
      "sexta": true,
      "sabado": true,
      "feriado": true
    },
    "tolerancia": null,
    "horario": {
      "tipo_periodo": "mensal",
      "wdays": [
        {
          "entrada": "2000-01-01T08:30:00.000Z",
          "saida": "2000-01-01T11:30:00.000Z",
          "total": "2000-01-01T03:00:00.000Z",
          "wday": 1
        },
        {
          "entrada": "2000-01-01T13:00:00.000Z",
          "saida": "2000-01-01T18:00:00.000Z",
          "total": "2000-01-01T05:00:00.000Z",
          "wday": 1
        }
      ]
    },
    "intervalo": null
  },
  {
    "hora_virada": "2000-01-01T08:00:00.000Z",
    "name": "Quadro Flexivel para Giovana",
    "tipo": "flexivel",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": null,
    "horario": {
      "tipo_periodo": "mensal",
      "wdays": [
        {
          "entrada": "2000-01-01T08:30:00.000Z",
          "saida": "2000-01-01T11:30:00.000Z",
          "total": "2000-01-01T03:00:00.000Z",
          "wday": 1
        },
        {
          "entrada": "2000-01-01T13:00:00.000Z",
          "saida": "2000-01-01T18:00:00.000Z",
          "total": "2000-01-01T05:00:00.000Z",
          "wday": 1
        }
      ]
    },
    "intervalo": null
  },
  {
    "hora_virada": "2000-01-01T00:00:00.000Z",
    "name": "Quadro Carga Horaria Diaria de 8 horas",
    "tipo": "carga_horaria",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": null,
    "horario": {
      "tipo_periodo": "diaria",
      "carga_horaria": 28800,
      "carga_horaria_faixa": null,
      "carga_horaria_folga": {
        "domingo": true,
        "segunda": false,
        "terca": false,
        "quarta": false,
        "quinta": false,
        "sexta": false,
        "sabado": false,
        "feriado": true
      }
    },
    "intervalo": null
  },
  {
    "hora_virada": "2000-01-01T00:00:00.000Z",
    "name": "Quadro Flexivel 8h por dia",
    "tipo": "flexivel",
    "use_holiday": true,
    "folgas_especiais": 0,
    "ativo": true,
    "ch": null,
    "marcacao_automatica_intervalo": null,
    "tolerancia": null,
    "horario": {
      "tipo_periodo": "mensal",
      "wdays": [
        {
          "entrada": "2000-01-01T00:00:00.000Z",
          "saida": "2000-01-01T08:00:00.000Z",
          "total": "2000-01-01T08:00:00.000Z",
          "wday": 3
        },
        {
          "entrada": "2000-01-01T00:00:00.000Z",
          "saida": "2000-01-01T08:00:00.000Z",
          "total": "2000-01-01T08:00:00.000Z",
          "wday": 4
        },
        {
          "entrada": "2000-01-01T00:00:00.000Z",
          "saida": "2000-01-01T08:00:00.000Z",
          "total": "2000-01-01T08:00:00.000Z",
          "wday": 5
        },
        {
          "entrada": "2000-01-01T00:00:00.000Z",
          "saida": "2000-01-01T08:00:00.000Z",
          "total": "2000-01-01T08:00:00.000Z",
          "wday": 1
        },
        {
          "entrada": "2000-01-01T00:00:00.000Z",
          "saida": "2000-01-01T08:00:00.000Z",
          "total": "2000-01-01T08:00:00.000Z",
          "wday": 2
        }
      ]
    },
    "intervalo": null
  }
]

Resumo Cartões Ponto

Mostrando erros de validação da requisição

Este método retorna um objeto com erros da requisição.

Endpoint

GET /v1/cartoes-ponto/resumo/:year/:month

Parameters

Name	Description
year required	(Int) Ano do cartão ponto. Ex: 2018.
month required	(Int) Mês do cartão ponto. Ex: 10.

Request

Route

GET /v1/cartoes-ponto/resumo/2018/22

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/cartoes-ponto/resumo/2018/22" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
message	(String) Mensagem de erro de validação.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 40b8dcea-b795-4073-b45e-ed31d6c58c16
X-Runtime: 0.030217
Vary: Origin
Content-Length: 26

Body

{
  "message": "Invalid Date"
}

Mostrando os cartões ponto

Este método retorna uma coleção de objetos com cartões ponto.

Endpoint

GET /v1/cartoes-ponto/resumo/:year/:month

Parameters

Name	Description
year required	(Int) Ano do cartão ponto. Ex: 2018.
month required	(Int) Mês do cartão ponto. Ex: 10.

Request

Route

GET /v1/cartoes-ponto/resumo/2018/1

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/cartoes-ponto/resumo/2018/1" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
resumo	(Object) Objeto cartão ponto (ver artigo Funcionários > Cartão Ponto).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"65dcc55ca352d580edf9d101792c868d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 523ee270-901d-4d16-adf7-609799555162
X-Runtime: 0.057690
Vary: Origin
Content-Length: 2901

Body

[
  {
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": null,
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": {
        "id": 980190962,
        "name": "Departamento01 (Empresa03)",
        "empresa_id": 471928375,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "ativo": true,
        "uid": "c43becdf-bb77-4062-97c0-58f3335dad91",
        "codigo_registro_folha": "1",
        "full_name": "Departamento01 (Empresa03)"
      },
      "biometria": null
    },
    "ano": 2018,
    "mes": 1,
    "mensagem": null,
    "atualizado": true,
    "total_abonos": 0,
    "total_falta": 489600,
    "total_trabalhado": 43200,
    "total_extra": 14400,
    "adicional_noturno": 0,
    "total_atrasado": 0,
    "total_antecipado": 0,
    "dias_de_falta": 17,
    "extra_noturno": 0,
    "semanal": {
      "semana_1": {
        "trabalhada": 0,
        "extra": 0,
        "falta": 0,
        "adicional_noturno": 0,
        "abonos": 0,
        "excecoes": 0,
        "in_itinere": 0,
        "dias_de_falta": 7,
        "falta_integral": 201600
      },
      "semana_2": {
        "trabalhada": 0,
        "extra": 0,
        "falta": 0,
        "adicional_noturno": 0,
        "abonos": 0,
        "excecoes": 0,
        "in_itinere": 0,
        "dias_de_falta": 7,
        "falta_integral": 201600
      },
      "semana_3": {
        "trabalhada": 0,
        "extra": 0,
        "falta": 0,
        "adicional_noturno": 0,
        "abonos": 0,
        "excecoes": 0,
        "in_itinere": 0,
        "dias_de_falta": 3,
        "falta_integral": 86400
      }
    },
    "mensal": null,
    "politica_extra": {
      "semanal": {
        "segunda_a_sexta": {
        },
        "segunda_a_sabado": {
        },
        "domingo": {
        },
        "sabado": {
        },
        "feriado": {
        },
        "folga": {
        },
        "id": {
        }
      },
      "semanal_detail": {
      },
      "mensal": {
        "segunda_a_sexta": {
          "50": 14400
        },
        "segunda_a_sabado": {
        },
        "domingo": {
          "100": 0
        },
        "sabado": {
          "50": 0
        },
        "feriado": {
          "100": 0
        },
        "folga": {
        }
      },
      "diaria": {
        "segunda_a_sexta": {
        },
        "segunda_a_sabado": {
        },
        "domingo": {
        },
        "sabado": {
        },
        "feriado": {
        },
        "folga": {
        }
      }
    },
    "locked": false,
    "acrescimo_noturno": 0,
    "trabalhadas_com_dsr": 0,
    "trabalhadas_menos_extra": 28800,
    "dsr_credit": 0,
    "dsr_debit": 0,
    "quantidade_dsr_positivo": 0,
    "bh_credit": 0,
    "bh_debit": 0,
    "bh_total": 0,
    "bh_pago": 0,
    "bh_abonado": 0,
    "in_itinere_total": 0,
    "falta_integral": 489600,
    "falta_parcial": 0,
    "adicional_noturno_sem_acrescimo": 0,
    "intervalo_intrajornada": null,
    "interjornada": null,
    "interjornada_faltante": null,
    "dias_de_trabalho": null,
    "cp_credit": 0,
    "cp_debit": 0,
    "cp_total": 0
  }
]

TC > Ponto Diário

Listando ponto diário

Este método retorna uma coleção de objetos para o dia do cartão ponto.

Endpoint

GET /tc/ponto_diario

Parameters

Name	Description
date	(Date) Data do dia do cartão ponto. Ex: "01-01-2019"

Request

Route

GET /tc/ponto_diario?data=2014-01-12

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

Query Parameters

data=2014-01-12

cURL

curl -g "http://api.lvh.me:3000/tc/ponto_diario?data=2014-01-12" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
nome	(String) Nome do funcionário.
hora_entrada_manha	(Time) Hora de entrada de manhã do quadro de horas.
hora_saida_manha	(Time) Hora de saida de manhã do quadro de horas.
hora_entrada_tarde	(Time) Hora de entrada a tarde do quadro de horas.
hora_saida_tarde	(Time) Hora de saida a tarde do quadro de horas.
atraso	(Time) Total de atraso.
saida_antecipada	(Time) Total de atraso.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"4d32874a561ad5ff05f499d1882ced85"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 13c8d703-287d-4319-a48e-3eb345060dec
X-Runtime: 0.381313
Content-Length: 174

Body

[
  {
    "nome": "Func1",
    "hora_entrada_manha": "06:45",
    "hora_saida_manha": "09:53",
    "hora_entrada_tarde": "13:01",
    "hora_saida_tarde": "16:09",
    "atraso": "00:00",
    "saida_antecipada": "00:00"
  }
]

Listando ponto diário de funcionarios de hoje

Este método retorna uma coleção de objetos para o dia do cartão ponto.

Endpoint

GET /tc/ponto_diario

Parameters

Name	Description
date	(Date) Data do dia do cartão ponto. Ex: "01-01-2019"

Request

Route

GET /tc/ponto_diario

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/tc/ponto_diario" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
nome	(String) Nome do funcionário.
hora_entrada_manha	(Time) Hora de entrada de manhã do quadro de horas.
hora_saida_manha	(Time) Hora de saida de manhã do quadro de horas.
hora_entrada_tarde	(Time) Hora de entrada a tarde do quadro de horas.
hora_saida_tarde	(Time) Hora de saida a tarde do quadro de horas.
atraso	(Time) Total de atraso.
saida_antecipada	(Time) Total de atraso.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"4d32874a561ad5ff05f499d1882ced85"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: a64d2e4e-24f7-4f41-8c31-1be260e98961
X-Runtime: 0.043701
Content-Length: 174

Body

[
  {
    "nome": "Func1",
    "hora_entrada_manha": "06:45",
    "hora_saida_manha": "09:53",
    "hora_entrada_tarde": "13:01",
    "hora_saida_tarde": "16:09",
    "atraso": "00:00",
    "saida_antecipada": "00:00"
  }
]

User

Showing User Profile

Show user profile

Endpoint

GET /v1/user/profile

Request

Route

GET /v1/user/profile

Headers

Host: api.lvh.me
X-Auth-Token: oe4dx4vyN3__i4ku-gc_
Content-Type: application/json
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/user/profile" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: oe4dx4vyN3__i4ku-gc_" \
	-H "Content-Type: application/json" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
first_name	(String) Primeiro nome do usuário.
last_name	(String) Sobrenome do usuário.
cpf	(String) CPF do usuário.
username	(String) Nome de acesso do usuário.
station_type	(String) Tipo de usuário.
roles	(Array<String>) Funções do usuário.
created_at	(Date) Data de criação.
updated_at	(Date) Última data de atualização.
auth_token	(String) Token configurável.
funcionario_uid	(String) UID do Funcionário quando station_type for funcionário. (Obsoleto: Utilizar o campo station)
temporary_password	(Bool) Verdadeira se a senha não foi atualizada ainda.
empresa	(Object<Empresa>) Objeto Empresa. Objeto presente quando o usuário pertence a uma empresa. (Obsoleto: Utilizar o campo station)
franquia	(Object) Dados da franquia que o usuário pertence. (Obsoleto: Utilizar o campo station)
station	(Object) Objeto variável de acordo com o campo station_type (Ex: Franquia, Cliente, Empresa e Funcionario)

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"8df49928a32bbc744a885f4b2f8651e7"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 16df74d3-1f25-4886-8c77-b252a17cef99
X-Runtime: 0.043030
Vary: Origin
Content-Length: 1831

Body

{
  "first_name": "User03",
  "last_name": "LastName",
  "cpf": "000.000.000-03",
  "username": "user03",
  "station_type": "Cliente",
  "roles": [
    "cliente"
  ],
  "created_at": "2023-09-27T09:51:27.000-03:00",
  "updated_at": "2023-09-27T09:51:27.000-03:00",
  "funcionario_uid": null,
  "temporary_password": false,
  "empresa": null,
  "franquia": {
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe3f0",
    "name": "Franquia01",
    "nome_fantasia": "FranquiaFantasia01",
    "cnpj": "00.000.000/0000-00",
    "inscricao_estadual": null,
    "cpf": null,
    "logo": "/uploads/franquia/879004013/logo/879004013/logo.png",
    "clausula_aceite": null,
    "address": {
      "cep": "85555-222",
      "city": "Guarapuava",
      "complement": "Apto52",
      "country": "Brasil",
      "number": "101",
      "state": "PR",
      "street": "Rua Armando Ribas",
      "district": "Rua Armando Ribas"
    },
    "condicoes_comerciais": null,
    "contacts": [
      {
        "email": "[email protected]",
        "name": "My Contact",
        "phone": "(42) 05555-4444",
        "cpf": null,
        "whatsapp": null,
        "site": null,
        "instagram": null
      },
      {
        "email": "[email protected]",
        "name": "My Contact Legal",
        "phone": "(42) 05555-4444",
        "cpf": null,
        "whatsapp": null,
        "site": null,
        "instagram": null
      },
      {
        "email": "[email protected]",
        "name": "My Contact Tecnico",
        "phone": "(42) 05555-4444",
        "cpf": null,
        "whatsapp": null,
        "site": null,
        "instagram": null
      }
    ]
  },
  "email": "[email protected]",
  "station": {
    "name": "CLIENTE01",
    "nome_fantasia": "FANTASIACLIENTE01",
    "cnpj": "00.000.000/0000-01",
    "cei": null,
    "cpf": null,
    "inscricao_estadual": null,
    "address": {
      "cep": "85555-222",
      "city": "Guarapuava",
      "complement": "Apto52",
      "country": "Brasil",
      "number": "101",
      "state": "PR",
      "street": "Rua Armando Ribas",
      "district": "Rua Armando Ribas"
    },
    "contact": {
      "email": "[email protected]",
      "name": "Contact2",
      "phone": "(42) 05555-4444",
      "cpf": null,
      "whatsapp": null,
      "site": null,
      "instagram": null
    }
  },
  "blocked": false,
  "avatar": {
    "url": "/assets/default-avatar.svg"
  },
  "accepted_terms": true,
  "uid": null,
  "platform_auth": "all_platform_auth"
}

Usuário > Cartão Ponto > Totais Diário

Obter os totais do dia

Este método retorna um objeto com os totais de um dia do cartão ponto do usuário atual.Somente é possível obter quando o usuário atual for do tipo “Funcionário”.

Endpoint

GET /v1/user/cartao_ponto/diario/:date

Parameters

Name	Description
date	(Date) Data do total do dia. Ex: "2012-01-01".

Request

Route

GET /v1/user/cartao_ponto/diario/2015-12-01

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/user/cartao_ponto/diario/2015-12-01" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
funcionario	(Funcionario) Objeto funcionário (ver artigo funcionarios).
pontos_originais	(Array) Lista de marcações originais do dia.
pontos_processados	(Array) Lista de marcações processadas do dia.
total_trabalhado	(Int) Total trabalhado em segundos.
extra	(Int) Total de extra em segundos.
falta	(Int) Total de falta em segundos.
atraso	(Int) Total de atraso em segundos.
saida_antecipada	(Int) Total de atraso em segundos.
adicional_noturno	(Int) Total de adicional noturno em segundos.
extra_noturno	(Int) Total de extra noturna em segundos.
ch	(Int) Código do horário.
tratamentos[time]	(Time) Hora ou Quantidade de hora total do tratamento.
tratamentos[type]	(String) Tipo da Ocorrência. Ex: I = Inclusão.
tratamentos[tratamento]	(Object) Objeto de Tratamento. Ex: Feriado, DSR, Banco de Horas, Inclusão de Ponto etc.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"21caa1d9539ceb2559042f20a9c5644b"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 0ca2c149-d1b0-46ff-a3d2-0edbad821e1d
X-Runtime: 0.047834
Vary: Origin
Content-Length: 1451

Body

{
  "funcionario": {
    "cpf": "07155744989",
    "cracha": "1",
    "data_admissao": null,
    "data_demissao": null,
    "name": "Func1",
    "pis": "123929234315",
    "registro_folha": "1",
    "rg": null,
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [
      {
        "data": "2017-01-10",
        "funcao": "test",
        "name": "Auxiliar (123456)"
      },
      {
        "data": "2018-01-01",
        "funcao": "auxiliar",
        "name": null
      }
    ],
    "exames": [
      {
        "data": "2017-01-10",
        "apto": true,
        "tipo_exame": null,
        "observacoes": null,
        "arquivo": {
          "url": null
        }
      }
    ],
    "empresa": {
      "id": 471928375,
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "inscricao_estadual": null,
      "cpf": null,
      "created_at": "2023-09-27T09:51:27.000-03:00",
      "updated_at": "2023-09-27T09:51:27.000-03:00",
      "cliente_id": 571096427,
      "cei": null,
      "codigo_registro_folha": "23",
      "ativo": true,
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
    },
    "departamento": null,
    "biometria": null
  },
  "pontos_originais": [
    "2000-01-01T07:45:00.000Z",
    "2000-01-01T08:45:00.000Z"
  ],
  "pontos_processados": [
    "2000-01-01T09:00:00.000Z"
  ],
  "total_trabalhado": 0,
  "extra": 0,
  "falta": 1800,
  "atraso": 0,
  "saida_antecipada": 0,
  "adicional_noturno": 0,
  "extra_noturno": null,
  "ch": 11,
  "tratamentos": [
    {
      "time": "09:00",
      "type": "I",
      "tratamento": {
        "data": "2015-12-01",
        "hora": "2000-01-01T09:00:00.000Z",
        "ordem": 0,
        "tipo": null,
        "motivo": null
      }
    }
  ]
}

Usuário > Justificativas

Excluindo Justificativa não encontrada

Tentativa de exclusão de justificativa não encontrada como pendente.

Endpoint

DELETE /v1/user/justificativas/:id

Parameters

Name	Description
id	(Id) Id da justificativa.

Request

Route

DELETE /v1/user/justificativas/-1

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/user/justificativas/-1" -d '' -X DELETE \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
message	(String) Mensagem de erro em caso de falha.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: d51ce623-9f29-4258-8d53-9fcadfb271f3
X-Runtime: 0.023825
Vary: Origin
Content-Length: 30

Body

{
  "message": "Record not found"
}

Excluindo Justificativa pendente

Este método serve para excluir uma justificativa com status pendente do usuário atual.

Endpoint

DELETE /v1/user/justificativas/:id

Parameters

Name	Description
id	(Id) Id da justificativa.

Request

Route

DELETE /v1/user/justificativas/962157260

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/user/justificativas/962157260" -d '' -X DELETE \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
message	(String) Mensagem de erro em caso de falha.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache
X-Request-Id: 6820b889-4790-4b9b-81a9-af69bc541ee5
X-Runtime: 0.025904
Vary: Origin

Listando as últimas Justificativas

Este método retorna uma coleção das Justificativas registradas.

Endpoint

GET /v1/user/justificativas

Parameters

Name	Description
per_page	(Int) Número de registros por página. Padrão: 5.
page	(Int) Número da página de referência da paginação. Padrão: 1.

Request

Route

GET /v1/user/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/user/justificativas" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) ID da Justificativa.
data	(Date) Data do requerimento.
data_final	(Date) Data final do requerimento.
hora	(DateTime) Quantidade de hora a justificar quando houver.
motivo	(Motivo) Objeto Motivo [ver artigo sobre Motivos].
status	(String) Estado da Justificativa Pendente.
rejection_motivation	(String) Descrição do motivo da rejeição quando o processo é rejeitado.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Per-Page: 5
X-Current-Page: 1
Content-Type: application/json; charset=utf-8
ETag: W/"862ae8e428b9f16f292b93bfdf3b6266"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 72af206e-8db8-47ca-b63d-4deaa852abed
X-Runtime: 0.035794
Vary: Origin
Content-Length: 1204

Body

[
  {
    "id": 962157260,
    "data": "2020-01-01",
    "hora": "2000-01-01T08:20:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": "atestado medico",
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157262,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157263,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157264,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157261,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  }
]

Listando os últimos 10 registros

Este método retorna uma coleção dos últimos 10 registros.

Endpoint

GET /v1/user/justificativas

Parameters

Name	Description
per_page	(Int) Número de registros por página. Padrão: 5.
page	(Int) Número da página de referência da paginação. Padrão: 1.

Request

Route

GET /v1/user/justificativas?per_page=10

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Cookie:

Query Parameters

per_page=10

cURL

curl -g "http://api.lvh.me:3000/v1/user/justificativas?per_page=10" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) ID da Justificativa.
data	(Date) Data do requerimento.
data_final	(Date) Data final do requerimento.
hora	(DateTime) Quantidade de hora a justificar quando houver.
motivo	(Motivo) Objeto Motivo [ver artigo sobre Motivos].
status	(String) Estado da Justificativa Pendente.
rejection_motivation	(String) Descrição do motivo da rejeição quando o processo é rejeitado.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Per-Page: 10
X-Current-Page: 1
Content-Type: application/json; charset=utf-8
ETag: W/"7a40a5fa63d7427578ad7558f345ae0b"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 22da8cbf-481a-4076-838f-c587006a72a0
X-Runtime: 0.038579
Vary: Origin
Content-Length: 2394

Body

[
  {
    "id": 962157260,
    "data": "2020-01-01",
    "hora": "2000-01-01T08:20:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": "atestado medico",
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157271,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157272,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157273,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157274,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157275,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157276,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157277,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157278,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  },
  {
    "id": 962157279,
    "data": "2000-01-01",
    "hora": "2000-01-01T01:00:00.000Z",
    "motivo": {
      "id": 569982306,
      "name": "Atestado Médico",
      "e_social_id": null
    },
    "status": "pending",
    "description": null,
    "file": null,
    "rejection_motivation": null,
    "data_final": null
  }
]

Registrando Justificativa

Este método registra a justificativa para o usuário atual.

Endpoint

POST /v1/user/justificativas

Parameters

Name	Description
justificativa[data] required	(Date) Data da justificativa.
justificativa[data_final]	(Date) A data estabelece um período para inserção de justificativas, sendo a data inicial o campo "data".
justificativa[hora]	(Time) Hora da justificativa.
justificativa[motivo_id] required	(String) Tipo da operação (2 valores possiveis). "atestado" para justificativa de Atestado médico e "falta_marcacao" para marcações de correção.
justificativa[description]	(String) Descrição livre para a justificativa.
justificativa[file]	(String) Nome do arquivo.

Request

Route

POST /v1/user/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

justificativa[data]=2019-1-2&justificativa[motivo_id]=atestado&justificativa[description]=livre

cURL

curl "http://api.lvh.me:3000/v1/user/justificativas" -d 'justificativa[data]=2019-1-2&justificativa[motivo_id]=atestado&justificativa[description]=livre' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) ID da Justificativa.
data	(Date) Data do requerimento.
data_final	(Date) Data final do requerimento.
hora	(DateTime) Quantidade de hora a justificar quando houver.
motivo	(Motivo) Objeto Motivo [ver artigo sobre Motivos].
message	(String) Mensagem de erro da requisição.
file	(String) Caminho do arquivo.
errors	(Object) Objeto de erros de validação.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"fd8a9b67e08e94479ffe7ef1082f76bc"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e08aaf06-fe2d-46c8-9459-e5e0272828b2
X-Runtime: 0.041054
Vary: Origin
Content-Length: 218

Body

{
  "id": 962157291,
  "data": "2019-01-02",
  "hora": null,
  "motivo": {
    "id": 569982306,
    "name": "Atestado Médico",
    "e_social_id": null
  },
  "status": "pending",
  "description": "livre",
  "file": null,
  "rejection_motivation": null,
  "data_final": null
}

Registrando Justificativa - Erro de validação

Este método mostra falha no registro da Justificativa.

Endpoint

POST /v1/user/justificativas

Parameters

Name	Description
justificativa[data] required	(Date) Data da justificativa.
justificativa[data_final]	(Date) A data estabelece um período para inserção de justificativas, sendo a data inicial o campo "data".
justificativa[hora]	(Time) Hora da justificativa.
justificativa[motivo_id] required	(String) Tipo da operação (2 valores possiveis). "atestado" para justificativa de Atestado médico e "falta_marcacao" para marcações de correção.
justificativa[description]	(String) Descrição livre para a justificativa.
justificativa[file]	(String) Nome do arquivo.

Request

Route

POST /v1/user/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/user/justificativas" -d '' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) ID da Justificativa.
data	(Date) Data do requerimento.
data_final	(Date) Data final do requerimento.
hora	(DateTime) Quantidade de hora a justificar quando houver.
motivo	(Motivo) Objeto Motivo [ver artigo sobre Motivos].
message	(String) Mensagem de erro da requisição.
file	(String) Caminho do arquivo.
errors	(Object) Objeto de erros de validação.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: fd6b3357-2fe6-438c-ab7e-42c0c65a222c
X-Runtime: 0.027417
Vary: Origin
Content-Length: 168

Body

{
  "message": "An error occurred while creating Justificativa.",
  "errors": {
    "data": [
      "can't be blank",
      "Invalid Date"
    ],
    "motivo_id": [
      "can't be blank",
      "Resource not allowed."
    ]
  }
}

Registrando Justificativa com foto

Este método registra a justificativa com foto.

Endpoint

POST /v1/user/justificativas

Parameters

Name	Description
justificativa[data] required	(Date) Data da justificativa.
justificativa[data_final]	(Date) A data estabelece um período para inserção de justificativas, sendo a data inicial o campo "data".
justificativa[hora]	(Time) Hora da justificativa.
justificativa[motivo_id] required	(String) Tipo da operação (2 valores possiveis). "atestado" para justificativa de Atestado médico e "falta_marcacao" para marcações de correção.
justificativa[description]	(String) Descrição livre para a justificativa.
justificativa[file]	(String) Nome do arquivo.

Request

Route

POST /v1/user/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Cookie:

Body

------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="justificativa[data]"

2019-1-3
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="justificativa[motivo_id]"

atestado
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="justificativa[file]"; filename="atestado.png"
Content-Type: image/png
Content-Length: 23244

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

cURL

curl "http://api.lvh.me:3000/v1/user/justificativas" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="justificativa[data]"

2019-1-3
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="justificativa[motivo_id]"

atestado
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="justificativa[file]"; filename="atestado.png"
Content-Type: image/png
Content-Length: 23244

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) ID da Justificativa.
data	(Date) Data do requerimento.
data_final	(Date) Data final do requerimento.
hora	(DateTime) Quantidade de hora a justificar quando houver.
motivo	(Motivo) Objeto Motivo [ver artigo sobre Motivos].
message	(String) Mensagem de erro da requisição.
file	(String) Caminho do arquivo.
errors	(Object) Objeto de erros de validação.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"85bf0df508d71a246d6b23d16b191894"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 2c774c97-eb42-41a4-9b49-50ff5d3eb90f
X-Runtime: 0.030422
Vary: Origin
Content-Length: 303

Body

{
  "id": 962157313,
  "data": "2019-01-03",
  "hora": null,
  "motivo": {
    "id": 569982306,
    "name": "Atestado Médico",
    "e_social_id": null
  },
  "status": "pending",
  "description": null,
  "file": "/uploads/cartao_ponto_justificativa_pendente/file/2023/09/600348341/962157313/atestado.png",
  "rejection_motivation": null,
  "data_final": null
}

Registrando Justificativa para várias datas

Este método registra a justificativa para várias datas, entre a data inicial e data final.

Endpoint

POST /v1/user/justificativas

Parameters

Name	Description
justificativa[data] required	(Date) Data da justificativa.
justificativa[data_final]	(Date) A data estabelece um período para inserção de justificativas, sendo a data inicial o campo "data".
justificativa[hora]	(Time) Hora da justificativa.
justificativa[motivo_id] required	(String) Tipo da operação (2 valores possiveis). "atestado" para justificativa de Atestado médico e "falta_marcacao" para marcações de correção.
justificativa[description]	(String) Descrição livre para a justificativa.
justificativa[file]	(String) Nome do arquivo.

Request

Route

POST /v1/user/justificativas

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

justificativa[data]=2019-1-2&justificativa[data_final]=2019-1-3&justificativa[motivo_id]=atestado&justificativa[description]=livre

cURL

curl "http://api.lvh.me:3000/v1/user/justificativas" -d 'justificativa[data]=2019-1-2&justificativa[data_final]=2019-1-3&justificativa[motivo_id]=atestado&justificativa[description]=livre' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	(Int) ID da Justificativa.
data	(Date) Data do requerimento.
data_final	(Date) Data final do requerimento.
hora	(DateTime) Quantidade de hora a justificar quando houver.
motivo	(Motivo) Objeto Motivo [ver artigo sobre Motivos].
message	(String) Mensagem de erro da requisição.
file	(String) Caminho do arquivo.
errors	(Object) Objeto de erros de validação.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"93692e4339312c4a3bbe37f74fd4a879"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c9ff6eab-5b5c-4495-96df-d748a40fe46e
X-Runtime: 0.030050
Vary: Origin
Content-Length: 226

Body

{
  "id": 962157302,
  "data": "2019-01-02",
  "hora": null,
  "motivo": {
    "id": 569982306,
    "name": "Atestado Médico",
    "e_social_id": null
  },
  "status": "pending",
  "description": "livre",
  "file": null,
  "rejection_motivation": null,
  "data_final": "2019-01-03"
}

Usuário > Pontos

Filtrando pontos por data

Este método retorna uma coleção dos Pontos filtrados por data.

Endpoint

GET /v1/user/pontos

Parameters

Name	Description
data	(Date) Filtro por data. Ex: "01/02/2014".
per_page	(Int) Número de registros por página. Padrão: 5.
page	(Int) Número da página de referência da paginação. Padrão: 1.

Request

Route

GET /v1/user/pontos?data=01%2F02%2F2014&per_page=10

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Platform-Auth: mobile
Cookie:

Query Parameters

data=01/02/2014
per_page=10

cURL

curl -g "http://api.lvh.me:3000/v1/user/pontos?data=01%2F02%2F2014&per_page=10" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Platform-Auth: mobile" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Date) Data de registro do ponto.
hora	(DateTime) Hora do registro do ponto.
equipamento_id	(Int) Id do equipamento que foi registrado o ponto.
processado	(Boolean) Se a coleta que pertence o ponto já foi processada.
nsr	(Int) Número sequencial de registro.
registro_inpi	(String) Número do registro INPI.
coletor_id	(Int) Identificação do equipamento de coleta. Valores: 1 - Mobile, 2 - Web.
offline	(Bool) Se o ponto foi registrado offline.
cpf	(Int) CPF do funcionário.
codigo_hash	(String) SHA-256 dos dados registrados.
utc_offset	(String) Deslocamento UTC da marcação.
ponto_geo_locale[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto_geo_locale[longitude]	(Float) Longitude do registro do Ponto (quando disponível).
X-Current-Page	(Int) [Header] Página atual da paginação.
X-Per-Page	(Int) [Header] Número máximo de registros da resposta à requisição.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Per-Page: 10
X-Current-Page: 1
Content-Type: application/json; charset=utf-8
ETag: W/"b64d8a9d5d686780097d23e914cb7cce"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1abbc529-e91a-4705-b842-5dd563b6daf9
X-Runtime: 0.084810
Vary: Origin
Content-Length: 8059

Body

[
  {
    "id": 352529519,
    "data": "2014-02-01",
    "hora": "06:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 202014167,
    "data": "2014-02-01",
    "hora": "09:53",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 990727490,
    "data": "2014-02-01",
    "hora": "13:01",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 627693797,
    "data": "2014-02-01",
    "hora": "16:09",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 309258358,
    "data": "2014-02-01",
    "hora": "19:17",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 191347150,
    "data": "2014-02-01",
    "hora": "22:25",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  }
]

Listando os 10 últimos pontos da segunda página

Este método retorna uma coleção dos últimos 10 Pontos registrados da segunda página.

Endpoint

GET /v1/user/pontos

Parameters

Name	Description
data	(Date) Filtro por data. Ex: "01/02/2014".
per_page	(Int) Número de registros por página. Padrão: 5.
page	(Int) Número da página de referência da paginação. Padrão: 1.

Request

Route

GET /v1/user/pontos?per_page=10&page=2

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Platform-Auth: mobile
Cookie:

Query Parameters

per_page=10
page=2

cURL

curl -g "http://api.lvh.me:3000/v1/user/pontos?per_page=10&page=2" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Platform-Auth: mobile" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Date) Data de registro do ponto.
hora	(DateTime) Hora do registro do ponto.
equipamento_id	(Int) Id do equipamento que foi registrado o ponto.
processado	(Boolean) Se a coleta que pertence o ponto já foi processada.
nsr	(Int) Número sequencial de registro.
registro_inpi	(String) Número do registro INPI.
coletor_id	(Int) Identificação do equipamento de coleta. Valores: 1 - Mobile, 2 - Web.
offline	(Bool) Se o ponto foi registrado offline.
cpf	(Int) CPF do funcionário.
codigo_hash	(String) SHA-256 dos dados registrados.
utc_offset	(String) Deslocamento UTC da marcação.
ponto_geo_locale[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto_geo_locale[longitude]	(Float) Longitude do registro do Ponto (quando disponível).
X-Current-Page	(Int) [Header] Página atual da paginação.
X-Per-Page	(Int) [Header] Número máximo de registros da resposta à requisição.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Per-Page: 10
X-Current-Page: 2
Content-Type: application/json; charset=utf-8
ETag: W/"9033e5c23150e50c4b65db55af83b86f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c5c6ebfd-a986-48a7-aa58-675016dda38a
X-Runtime: 0.114434
Vary: Origin
Content-Length: 13430

Body

[
  {
    "id": 611529108,
    "data": "2014-02-28",
    "hora": "16:09",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 326369541,
    "data": "2014-02-28",
    "hora": "19:17",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 175984833,
    "data": "2014-02-28",
    "hora": "22:25",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 524648993,
    "data": "2014-02-27",
    "hora": "06:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 105698205,
    "data": "2014-02-27",
    "hora": "09:53",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 827056912,
    "data": "2014-02-27",
    "hora": "13:01",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 791639727,
    "data": "2014-02-27",
    "hora": "16:09",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 405292600,
    "data": "2014-02-27",
    "hora": "19:17",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 18945924,
    "data": "2014-02-27",
    "hora": "22:25",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 512223254,
    "data": "2014-02-26",
    "hora": "06:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  }
]

Listando os últimos 10 pontos

Este método retorna uma coleção dos últimos 10 Pontos registrados.

Endpoint

GET /v1/user/pontos

Parameters

Name	Description
data	(Date) Filtro por data. Ex: "01/02/2014".
per_page	(Int) Número de registros por página. Padrão: 5.
page	(Int) Número da página de referência da paginação. Padrão: 1.

Request

Route

GET /v1/user/pontos?per_page=10

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Platform-Auth: mobile
Cookie:

Query Parameters

per_page=10

cURL

curl -g "http://api.lvh.me:3000/v1/user/pontos?per_page=10" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Platform-Auth: mobile" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Date) Data de registro do ponto.
hora	(DateTime) Hora do registro do ponto.
equipamento_id	(Int) Id do equipamento que foi registrado o ponto.
processado	(Boolean) Se a coleta que pertence o ponto já foi processada.
nsr	(Int) Número sequencial de registro.
registro_inpi	(String) Número do registro INPI.
coletor_id	(Int) Identificação do equipamento de coleta. Valores: 1 - Mobile, 2 - Web.
offline	(Bool) Se o ponto foi registrado offline.
cpf	(Int) CPF do funcionário.
codigo_hash	(String) SHA-256 dos dados registrados.
utc_offset	(String) Deslocamento UTC da marcação.
ponto_geo_locale[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto_geo_locale[longitude]	(Float) Longitude do registro do Ponto (quando disponível).
X-Current-Page	(Int) [Header] Página atual da paginação.
X-Per-Page	(Int) [Header] Número máximo de registros da resposta à requisição.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Per-Page: 10
X-Current-Page: 1
Content-Type: application/json; charset=utf-8
ETag: W/"a27c45bc05deabdf93fa46d58044e2a2"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 60b8d92f-74ed-4539-a3cc-052dd7d98314
X-Runtime: 0.132851
Vary: Origin
Content-Length: 13721

Body

[
  {
    "id": 762123699,
    "data": "2022-04-01",
    "hora": "12:00",
    "equipamento_id": 51636476,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": 3,
    "registro_inpi": "BR512022000771-1 e BR512022000798-3",
    "coletor_id": 1,
    "offline": true,
    "created_at": "2022-03-01T12:00:00.000-03:00",
    "cpf": "07155744989",
    "codigo_hash": "eaefbae245c609cf2bdb02a320dfdc30e1d7dbd0b390512b91315a3cdf54c23a",
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 215362412,
    "data": "2022-03-01",
    "hora": "08:00",
    "equipamento_id": 51636476,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": 1,
    "registro_inpi": "BR512022000771-1 e BR512022000798-3",
    "coletor_id": 2,
    "offline": false,
    "created_at": "2022-03-01T08:00:00.000-03:00",
    "cpf": "07155744989",
    "codigo_hash": "faefbae245c609cf2bdb07a320dfdc30e1d7dbd0b390512b95059a3cdf64c25c",
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 192303549,
    "data": "2022-03-01",
    "hora": "12:00",
    "equipamento_id": 51636476,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": 2,
    "registro_inpi": "BR512022000771-1 e BR512022000798-3",
    "coletor_id": 2,
    "offline": false,
    "created_at": "2022-03-01T12:00:00.000-03:00",
    "cpf": "07155744989",
    "codigo_hash": "eaefbae245c609cf2bdb02a320dfdc30e1d7dbd0b390512b91345a3cdf64c23c",
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 729814102,
    "data": "2015-12-01",
    "hora": "07:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 478618823,
    "data": "2015-12-01",
    "hora": "08:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 762265178,
    "data": "2015-11-01",
    "hora": "07:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 443027153,
    "data": "2015-11-01",
    "hora": "10:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 337233180,
    "data": "2014-02-28",
    "hora": "06:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 219190440,
    "data": "2014-02-28",
    "hora": "09:53",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 974627891,
    "data": "2014-02-28",
    "hora": "13:01",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  }
]

Listando os últimos 5 pontos

Este método retorna uma coleção dos últimos 5 Pontos registrados.

Endpoint

GET /v1/user/pontos

Parameters

Name	Description
data	(Date) Filtro por data. Ex: "01/02/2014".
per_page	(Int) Número de registros por página. Padrão: 5.
page	(Int) Número da página de referência da paginação. Padrão: 1.

Request

Route

GET /v1/user/pontos

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Platform-Auth: mobile
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/user/pontos" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Platform-Auth: mobile" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Date) Data de registro do ponto.
hora	(DateTime) Hora do registro do ponto.
equipamento_id	(Int) Id do equipamento que foi registrado o ponto.
processado	(Boolean) Se a coleta que pertence o ponto já foi processada.
nsr	(Int) Número sequencial de registro.
registro_inpi	(String) Número do registro INPI.
coletor_id	(Int) Identificação do equipamento de coleta. Valores: 1 - Mobile, 2 - Web.
offline	(Bool) Se o ponto foi registrado offline.
cpf	(Int) CPF do funcionário.
codigo_hash	(String) SHA-256 dos dados registrados.
utc_offset	(String) Deslocamento UTC da marcação.
ponto_geo_locale[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto_geo_locale[longitude]	(Float) Longitude do registro do Ponto (quando disponível).
X-Current-Page	(Int) [Header] Página atual da paginação.
X-Per-Page	(Int) [Header] Número máximo de registros da resposta à requisição.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Per-Page: 5
X-Current-Page: 1
Content-Type: application/json; charset=utf-8
ETag: W/"726b7d337b5cf3f2be5e0a06b48e0f2c"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 897501a2-04a8-449d-85d9-175d4e11375c
X-Runtime: 0.083531
Vary: Origin
Content-Length: 6716

Body

[
  {
    "id": 729814102,
    "data": "2015-12-01",
    "hora": "07:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 478618823,
    "data": "2015-12-01",
    "hora": "08:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 762265178,
    "data": "2015-11-01",
    "hora": "07:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 443027153,
    "data": "2015-11-01",
    "hora": "10:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  },
  {
    "id": 337233180,
    "data": "2014-02-28",
    "hora": "06:45",
    "equipamento_id": 193764514,
    "processado": false,
    "ponto_geo_locale": null,
    "nsr": null,
    "registro_inpi": null,
    "coletor_id": null,
    "offline": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "cpf": null,
    "codigo_hash": null,
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  }
]

Obtendo o comprovante em formato pdf do ponto

Este método retorna o arquivo do comprovante do ponto em formato pdf.

Endpoint

GET /v1/user/pontos/:id.pdf

Parameters

Name	Description
id	(Int) ID do Ponto.

Request

Route

GET /v1/user/pontos/215362412.pdf

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Platform-Auth: mobile
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/user/pontos/215362412.pdf" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Platform-Auth: mobile" \
	-H "Cookie: "

Response

Simulated Response

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Disposition: attachment; filename="comprovante-1.pdf"
Content-Transfer-Encoding: binary
Content-Type: application/pdf
Cache-Control: private
X-Request-Id: 06214037-89fd-40e9-a67b-de91bbadbb73
X-Runtime: 0.149186
Vary: Origin
Content-Length: 32512

Body

[binary data]

Registrando Ponto

Este método registra o ponto para o usuário atual.

Endpoint

POST /v1/user/pontos

Parameters

Name	Description
platform-auth	(String) [Header] Cabeçalho responsável por identificação da plataforma logada. Valores possíveis: "web" e "mobile". Valor padrão: "web".
ponto[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto[longitude]	(Float) Longitude do registro do Ponto (quando disponível).

Request

Route

POST /v1/user/pontos

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Platform-Auth: mobile
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

ponto[latitude]=10&ponto[longitude]=15

cURL

curl "http://api.lvh.me:3000/v1/user/pontos" -d 'ponto[latitude]=10&ponto[longitude]=15' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Platform-Auth: mobile" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Date) Data de registro do ponto.
hora	(DateTime) Hora do registro do ponto.
equipamento_id	(Int) Id do equipamento que foi registrado o ponto.
processado	(Boolean) Se a coleta que pertence o ponto já foi processada.
nsr	(Int) Número sequencial de registro.
registro_inpi	(String) Número do registro INPI.
coletor_id	(Int) Identificação do equipamento de coleta. Valores: 1 - Mobile, 2 - Web.
offline	(Bool) Se o ponto foi registrado offline.
cpf	(Int) CPF do funcionário.
codigo_hash	(String) SHA-256 dos dados registrados.
utc_offset	(String) Deslocamento UTC da marcação.
ponto_geo_locale[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto_geo_locale[longitude]	(Float) Longitude do registro do Ponto (quando disponível).
message	(String) Mensagem de reposta da requisição.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"873f94e116a9999b7488c1cd63ee1e6a"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c7a67a7d-394e-4b68-88be-f93f69b529e4
X-Runtime: 0.053985
Vary: Origin
Content-Length: 1470

Body

{
  "id": 1071408924,
  "data": "2023-09-27",
  "hora": "09:51",
  "equipamento_id": 51636476,
  "processado": false,
  "ponto_geo_locale": {
    "latitude": 10.0,
    "longitude": 15.0
  },
  "nsr": 1,
  "registro_inpi": "BR512022000771-1 e BR512022000798-3",
  "coletor_id": 1,
  "offline": false,
  "created_at": "2023-09-27T09:51:39.819-03:00",
  "cpf": "07155744989",
  "codigo_hash": "7a71840b21ebee956eadbc53ead0db9ef4ec1c0f9e47e766d11b742a4562dc53",
  "utc_offset": "-0300",
  "funcionario": {
    "cpf": "07155744989",
    "cracha": "1",
    "data_admissao": "2017-01-01",
    "data_demissao": null,
    "name": "Func1",
    "pis": "123929234315",
    "registro_folha": "123",
    "rg": null,
    "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
    "nacionalidade": null,
    "nome_da_mae": null,
    "nome_do_pai": null,
    "estado_civil": null,
    "conjuge": null,
    "nascimento": null,
    "ctps": null,
    "cnh": null,
    "certidao_militar": null,
    "tipo_sanguineo": null,
    "escolaridade": null,
    "observacoes": null,
    "cargos": [
      {
        "data": "2017-01-10",
        "funcao": "test",
        "name": "Auxiliar (123456)"
      },
      {
        "data": "2018-01-01",
        "funcao": "auxiliar",
        "name": null
      }
    ],
    "exames": [
      {
        "data": "2017-01-10",
        "apto": true,
        "tipo_exame": null,
        "observacoes": null,
        "arquivo": {
          "url": null
        }
      }
    ],
    "empresa": {
      "id": 471928375,
      "name": "Empresa03",
      "nome_fantasia": "EmpFantasia03",
      "cnpj": "00.000.000/0000-03",
      "inscricao_estadual": null,
      "cpf": null,
      "created_at": "2023-09-27T09:51:27.000-03:00",
      "updated_at": "2023-09-27T09:51:27.000-03:00",
      "cliente_id": 571096427,
      "cei": null,
      "codigo_registro_folha": "23",
      "ativo": true,
      "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
    },
    "departamento": null,
    "biometria": null
  }
}

Registrando Ponto - Equipamento não permitido

Este método mostra falha no registro quando o equipamento do tipo App não está criado.

Endpoint

POST /v1/user/pontos

Parameters

Name	Description
platform-auth	(String) [Header] Cabeçalho responsável por identificação da plataforma logada. Valores possíveis: "web" e "mobile". Valor padrão: "web".
ponto[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto[longitude]	(Float) Longitude do registro do Ponto (quando disponível).

Request

Route

POST /v1/user/pontos

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Platform-Auth: mobile
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/user/pontos" -d '' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Platform-Auth: mobile" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Date) Data de registro do ponto.
hora	(DateTime) Hora do registro do ponto.
equipamento_id	(Int) Id do equipamento que foi registrado o ponto.
processado	(Boolean) Se a coleta que pertence o ponto já foi processada.
nsr	(Int) Número sequencial de registro.
registro_inpi	(String) Número do registro INPI.
coletor_id	(Int) Identificação do equipamento de coleta. Valores: 1 - Mobile, 2 - Web.
offline	(Bool) Se o ponto foi registrado offline.
cpf	(Int) CPF do funcionário.
codigo_hash	(String) SHA-256 dos dados registrados.
utc_offset	(String) Deslocamento UTC da marcação.
ponto_geo_locale[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto_geo_locale[longitude]	(Float) Longitude do registro do Ponto (quando disponível).
message	(String) Mensagem de reposta da requisição.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 3d483c0c-be0f-4697-8fc6-ac4de7d6ab50
X-Runtime: 0.025118
Vary: Origin
Content-Length: 101

Body

{
  "message": "Something went wrong while creating the Ponto. Equipamento não cadastrado.",
  "errors": {
  }
}

Registrando Ponto offline inválido

Este método tenta registrar uma lista de os pontos offline inválidos.

Endpoint

POST /v1/user/pontos/offline

Parameters

Name	Description
pontos	(Array) Coleção de objetos de ponto a serem inseridos.
ponto[data]	(Date) Data de registro do ponto.
ponto[hora]	(DateTime) Hora do registro do ponto.
ponto[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto[longitude]	(Float) Longitude do registro do Ponto (quando disponível).

Request

Route

POST /v1/user/pontos/offline

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Platform-Auth: mobile
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

pontos[][data]=&pontos[][hora]=10%3A00

cURL

curl "http://api.lvh.me:3000/v1/user/pontos/offline" -d 'pontos[][data]=&pontos[][hora]=10%3A00' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Platform-Auth: mobile" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Date) Data de registro do ponto.
hora	(DateTime) Hora do registro do ponto.
equipamento_id	(Int) Id do equipamento que foi registrado o ponto.
processado	(Boolean) Se a coleta que pertence o ponto já foi processada.
nsr	(Int) Número sequencial de registro.
registro_inpi	(String) Número do registro INPI.
coletor_id	(Int) Identificação do equipamento de coleta. Valores: 1 - Mobile, 2 - Web.
offline	(Bool) Se o ponto foi registrado offline.
cpf	(Int) CPF do funcionário.
codigo_hash	(String) SHA-256 dos dados registrados.
utc_offset	(String) Deslocamento UTC da marcação.
ponto_geo_locale[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto_geo_locale[longitude]	(Float) Longitude do registro do Ponto (quando disponível).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: a42f21fa-924d-4fe6-b29b-5989ea884408
X-Runtime: 0.022493
Vary: Origin
Content-Length: 85

Body

{
  "message": "Something went wrong while creating the Ponto. invalid date",
  "errors": {
  }
}

Registrando Pontos offline

Este método registra uma lista de os pontos offline para o usuário atual.

Endpoint

POST /v1/user/pontos/offline

Parameters

Name	Description
pontos	(Array) Coleção de objetos de ponto a serem inseridos.
ponto[data]	(Date) Data de registro do ponto.
ponto[hora]	(DateTime) Hora do registro do ponto.
ponto[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto[longitude]	(Float) Longitude do registro do Ponto (quando disponível).

Request

Route

POST /v1/user/pontos/offline

Headers

Host: api.lvh.me
X-Auth-Token: te8dx4vyN355i4ku-gm3
Platform-Auth: mobile
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

pontos[][latitude]=10&pontos[][longitude]=15&pontos[][data]=2020-01-01&pontos[][hora]=10%3A00

cURL

curl "http://api.lvh.me:3000/v1/user/pontos/offline" -d 'pontos[][latitude]=10&pontos[][longitude]=15&pontos[][data]=2020-01-01&pontos[][hora]=10%3A00' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: te8dx4vyN355i4ku-gm3" \
	-H "Platform-Auth: mobile" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
data	(Date) Data de registro do ponto.
hora	(DateTime) Hora do registro do ponto.
equipamento_id	(Int) Id do equipamento que foi registrado o ponto.
processado	(Boolean) Se a coleta que pertence o ponto já foi processada.
nsr	(Int) Número sequencial de registro.
registro_inpi	(String) Número do registro INPI.
coletor_id	(Int) Identificação do equipamento de coleta. Valores: 1 - Mobile, 2 - Web.
offline	(Bool) Se o ponto foi registrado offline.
cpf	(Int) CPF do funcionário.
codigo_hash	(String) SHA-256 dos dados registrados.
utc_offset	(String) Deslocamento UTC da marcação.
ponto_geo_locale[latitude]	(Float) Latitude do registro do Ponto (quando disponível).
ponto_geo_locale[longitude]	(Float) Longitude do registro do Ponto (quando disponível).

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"311136f2ef1768f70c9e432f43a80bb1"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 643e0ecf-5c97-404c-953b-051515030df0
X-Runtime: 0.045612
Vary: Origin
Content-Length: 1471

Body

[
  {
    "id": 1071408930,
    "data": "2020-01-01",
    "hora": "10:00",
    "equipamento_id": 51636476,
    "processado": false,
    "ponto_geo_locale": {
      "latitude": 10.0,
      "longitude": 15.0
    },
    "nsr": 1,
    "registro_inpi": "BR512022000771-1 e BR512022000798-3",
    "coletor_id": 1,
    "offline": true,
    "created_at": "2023-09-27T09:51:40.176-03:00",
    "cpf": "07155744989",
    "codigo_hash": "be84ec5fbfab88db1115660aff59f391f7ed53c553d217103b6b71c4f38bf3b4",
    "utc_offset": "-0300",
    "funcionario": {
      "cpf": "07155744989",
      "cracha": "1",
      "data_admissao": "2017-01-01",
      "data_demissao": null,
      "name": "Func1",
      "pis": "123929234315",
      "registro_folha": "123",
      "rg": null,
      "uid": "71ba8bd7-3b65-40fa-8e11-7daf5f0fe2c0",
      "nacionalidade": null,
      "nome_da_mae": null,
      "nome_do_pai": null,
      "estado_civil": null,
      "conjuge": null,
      "nascimento": null,
      "ctps": null,
      "cnh": null,
      "certidao_militar": null,
      "tipo_sanguineo": null,
      "escolaridade": null,
      "observacoes": null,
      "cargos": [
        {
          "data": "2017-01-10",
          "funcao": "test",
          "name": "Auxiliar (123456)"
        },
        {
          "data": "2018-01-01",
          "funcao": "auxiliar",
          "name": null
        }
      ],
      "exames": [
        {
          "data": "2017-01-10",
          "apto": true,
          "tipo_exame": null,
          "observacoes": null,
          "arquivo": {
            "url": null
          }
        }
      ],
      "empresa": {
        "id": 471928375,
        "name": "Empresa03",
        "nome_fantasia": "EmpFantasia03",
        "cnpj": "00.000.000/0000-03",
        "inscricao_estadual": null,
        "cpf": null,
        "created_at": "2023-09-27T09:51:27.000-03:00",
        "updated_at": "2023-09-27T09:51:27.000-03:00",
        "cliente_id": 571096427,
        "cei": null,
        "codigo_registro_folha": "23",
        "ativo": true,
        "uid": "a43bedds-ba77-4062-46c0-58f4444dad33"
      },
      "departamento": null,
      "biometria": null
    }
  }
]

Versions

Creating a version

This method creates a new version.

Endpoint

POST /v1/versions

Parameters

Name	Description
version[name] required	String name.
version[apelido] required	String label.
version[data_lancamento] required	Date of release.
version[descricao] required	String for description.
version[versao_atual]	Boolean indicates if version is in use.
version[branch_url]	String with url of the integration branch. Only for admin user.

Request

Route

POST /v1/versions

Headers

Host: api.lvh.me
X-Auth-Token: ye8dx4vyN3__i4ku-gm_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

version[name]=v1&version[apelido]=v+one&version[data_lancamento]=2017-01-01&version[descricao]=Description

cURL

curl "http://api.lvh.me:3000/v1/versions" -d 'version[name]=v1&version[apelido]=v+one&version[data_lancamento]=2017-01-01&version[descricao]=Description' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: ye8dx4vyN3__i4ku-gm_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	Id of version.
apelido	String label.
data_lancamento	Date of release.
descricao	String for description.
name	String name.
versao_atual	Boolean indicates if version is in use.
created_at	Date of creation.
updated_at	Date of update.
branch_url	String with url of the integration branch. Only for admin user.
message	String alert about response.
errors	Object with field names that contain validation errors.
errors[name]	Array of error messages of field name.
errors[apelido]	Array of error messages of field apelido.
errors[data_lancamento]	Array of error messages of field data_lancamento.
errors[descricao]	Array of error messages of field descricao.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"3147ca762b7d03de5ea6e30e907f45cb"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 235479da-0ddd-4880-b32a-010e662812a0
X-Runtime: 0.037892
Vary: Origin
Content-Length: 231

Body

{
  "id": 980190963,
  "apelido": "v one",
  "data_lancamento": "2017-01-01",
  "descricao": "Description",
  "name": "v1",
  "versao_atual": null,
  "created_at": "2023-09-27T09:51:40.793-03:00",
  "updated_at": "2023-09-27T09:51:40.793-03:00",
  "branch_url": null
}

Creating a version - errors

This method shows validation fails.

Endpoint

POST /v1/versions

Parameters

Name	Description
version[name] required	String name.
version[apelido] required	String label.
version[data_lancamento] required	Date of release.
version[descricao] required	String for description.
version[versao_atual]	Boolean indicates if version is in use.
version[branch_url]	String with url of the integration branch. Only for admin user.

Request

Route

POST /v1/versions

Headers

Host: api.lvh.me
X-Auth-Token: ye8dx4vyN3__i4ku-gm_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

version[name]=

cURL

curl "http://api.lvh.me:3000/v1/versions" -d 'version[name]=' -X POST \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: ye8dx4vyN3__i4ku-gm_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	Id of version.
apelido	String label.
data_lancamento	Date of release.
descricao	String for description.
name	String name.
versao_atual	Boolean indicates if version is in use.
created_at	Date of creation.
updated_at	Date of update.
branch_url	String with url of the integration branch. Only for admin user.
message	String alert about response.
errors	Object with field names that contain validation errors.
errors[name]	Array of error messages of field name.
errors[apelido]	Array of error messages of field apelido.
errors[data_lancamento]	Array of error messages of field data_lancamento.
errors[descricao]	Array of error messages of field descricao.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 8f4537c4-2f43-4295-a115-a947cd536ab1
X-Runtime: 0.033420
Vary: Origin
Content-Length: 166

Body

{
  "message": "Validation Failed!",
  "errors": {
    "name": [
      "can't be blank"
    ],
    "apelido": [
      "can't be blank"
    ],
    "data_lancamento": [
      "can't be blank"
    ],
    "descricao": [
      "can't be blank"
    ]
  }
}

Deleting a version

This method deletes a version.

Endpoint

DELETE /v1/versions/:id

Request

Route

DELETE /v1/versions/980190962

Headers

Host: api.lvh.me
X-Auth-Token: ye8dx4vyN3__i4ku-gm_
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "http://api.lvh.me:3000/v1/versions/980190962" -d '' -X DELETE \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: ye8dx4vyN3__i4ku-gm_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache
X-Request-Id: 40ca4fdd-5aed-48c8-a47a-9259762a1f7a
X-Runtime: 0.027637
Vary: Origin

Get a version

This method returns an object of version.

Endpoint

GET /v1/versions/:id

Request

Route

GET /v1/versions/980190962

Headers

Host: api.lvh.me
X-Auth-Token: ye8dx4vyN3__i4ku-gm_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/versions/980190962" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: ye8dx4vyN3__i4ku-gm_" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	Id of version.
apelido	String label.
data_lancamento	Date of release.
descricao	String for description.
name	String name.
versao_atual	Boolean indicates if version is in use.
created_at	Date of creation.
updated_at	Date of update.
branch_url	String with url of the integration branch. Only for admin user.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"65671117339187c36bf1c2c35b804a36"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 4b301999-7e16-412b-ad16-0d8c5cf1f32a
X-Runtime: 0.030657
Vary: Origin
Content-Length: 242

Body

{
  "id": 980190962,
  "apelido": "MyString",
  "data_lancamento": "2013-06-17",
  "descricao": "MyText",
  "name": "V3.0.2-1",
  "versao_atual": false,
  "created_at": "2023-09-27T09:51:27.000-03:00",
  "updated_at": "2023-09-27T09:51:27.000-03:00",
  "branch_url": "MyString"
}

Listing versions

This method returns an array of versions.

Endpoint

GET /v1/versions

Request

Route

GET /v1/versions

Headers

Host: api.lvh.me
X-Auth-Token: ye8dx4vyN3__i4ku-gm_
Cookie:

cURL

curl -g "http://api.lvh.me:3000/v1/versions" -X GET \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: ye8dx4vyN3__i4ku-gm_" \
	-H "Cookie: "

Response

Simulated Response

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"1f0d4f59fedc02abac4e398afd632fce"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 98027202-19f4-4ec9-b216-0561453881b1
X-Runtime: 0.099080
Vary: Origin
Content-Length: 719

Body

[
  {
    "id": 113629430,
    "apelido": "test",
    "data_lancamento": "2015-11-09",
    "descricao": "test",
    "name": "V3.0.2-3",
    "versao_atual": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "updated_at": "2023-09-27T09:51:27.000-03:00",
    "branch_url": "test"
  },
  {
    "id": 298486374,
    "apelido": "MyString",
    "data_lancamento": "2014-05-09",
    "descricao": "MyText",
    "name": "V3.0.2-2",
    "versao_atual": true,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "updated_at": "2023-09-27T09:51:27.000-03:00",
    "branch_url": "MyString"
  },
  {
    "id": 980190962,
    "apelido": "MyString",
    "data_lancamento": "2013-06-17",
    "descricao": "MyText",
    "name": "V3.0.2-1",
    "versao_atual": false,
    "created_at": "2023-09-27T09:51:27.000-03:00",
    "updated_at": "2023-09-27T09:51:27.000-03:00",
    "branch_url": "MyString"
  }
]

Updating a version

This method updates a version.

Endpoint

PATCH /v1/versions/:id

Parameters

Name	Description
version[name] required	String name.
version[apelido] required	String label.
version[data_lancamento] required	Date of release.
version[descricao] required	String for description.
version[versao_atual]	Boolean indicates if version is in use.
version[branch_url]	String with url of the integration branch. Only for admin user.

Request

Route

PATCH /v1/versions/980190962

Headers

Host: api.lvh.me
X-Auth-Token: ye8dx4vyN3__i4ku-gm_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

version[descricao]=good+version

cURL

curl "http://api.lvh.me:3000/v1/versions/980190962" -d 'version[descricao]=good+version' -X PATCH \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: ye8dx4vyN3__i4ku-gm_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	Id of version.
apelido	String label.
data_lancamento	Date of release.
descricao	String for description.
name	String name.
versao_atual	Boolean indicates if version is in use.
created_at	Date of creation.
updated_at	Date of update.
branch_url	String with url of the integration branch. Only for admin user.
message	String alert about response.
errors	Object with field names that contain validation errors.
errors[name]	Array of error messages of field name.
errors[apelido]	Array of error messages of field apelido.
errors[data_lancamento]	Array of error messages of field data_lancamento.
errors[descricao]	Array of error messages of field descricao.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"d8442ec93ff021f1c04a658329b04588"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 0c27cb8a-302f-429d-abcc-34d209804e8c
X-Runtime: 0.030215
Vary: Origin
Content-Length: 248

Body

{
  "id": 980190962,
  "apelido": "MyString",
  "data_lancamento": "2013-06-17",
  "descricao": "good version",
  "name": "V3.0.2-1",
  "versao_atual": false,
  "created_at": "2023-09-27T09:51:27.000-03:00",
  "updated_at": "2023-09-27T09:51:40.863-03:00",
  "branch_url": "MyString"
}

Updating a version - errors

This method shows validation fails on update.

Endpoint

PATCH /v1/versions/:id

Parameters

Name	Description
version[name] required	String name.
version[apelido] required	String label.
version[data_lancamento] required	Date of release.
version[descricao] required	String for description.
version[versao_atual]	Boolean indicates if version is in use.
version[branch_url]	String with url of the integration branch. Only for admin user.

Request

Route

PATCH /v1/versions/980190962

Headers

Host: api.lvh.me
X-Auth-Token: ye8dx4vyN3__i4ku-gm_
Content-Type: application/x-www-form-urlencoded
Cookie:

Body

version[name]=

cURL

curl "http://api.lvh.me:3000/v1/versions/980190962" -d 'version[name]=' -X PATCH \
	-H "Host: api.lvh.me" \
	-H "X-Auth-Token: ye8dx4vyN3__i4ku-gm_" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Simulated Response

Response Fields

Name	Description
id	Id of version.
apelido	String label.
data_lancamento	Date of release.
descricao	String for description.
name	String name.
versao_atual	Boolean indicates if version is in use.
created_at	Date of creation.
updated_at	Date of update.
branch_url	String with url of the integration branch. Only for admin user.
message	String alert about response.
errors	Object with field names that contain validation errors.
errors[name]	Array of error messages of field name.
errors[apelido]	Array of error messages of field apelido.
errors[data_lancamento]	Array of error messages of field data_lancamento.
errors[descricao]	Array of error messages of field descricao.

Status

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 3cdfc316-7717-4f6e-aa28-26aee0e2d710
X-Runtime: 0.029306
Vary: Origin
Content-Length: 69

Body

{
  "message": "Validation Failed!",
  "errors": {
    "name": [
      "can't be blank"
    ]
  }
}

API PTRP - Documentação

Obter suas chaves de acesso (Token)

Como obter seu token manualmente

Como obter suas chaves de acesso por login

Níveis de Acesso

Documentação

Suporte

Auth

Alterando a senha

Endpoint

Parameters

Request

Route

Headers

Body

cURL

Response

Response Fields

Status

Headers

Body

Encerrando a conta

Endpoint

Request

Route

Headers

cURL

Response

Response Fields

Status

Headers

Body

Login

Endpoint

Parameters

Request

Route

Headers

Body

cURL

Response

Response Fields

Status

Headers

Body

Renovar token

Endpoint

Request

Route

Headers

cURL

Response

Response Fields

Status

Headers

Body

Ações em Massa

Criando Justificativas

Endpoint

Parameters

Request

Route

Headers

Body

cURL

Response

Response Fields

Status

Headers

Body

Criando Justificativas - erros

Endpoint

Parameters

Request

Route

Headers

Body

cURL

Response

Response Fields