2.0info: 7.28.0 HCM – Clocking Event Time Evaluation Engine BFF description: HCM – Clocking Event Time Evaluation Engine BFF x-senior-domain: HCM – Clocking Event Time Evaluation Engine BFF x-senior-domain-path: hcm_clocking_event_time_evaluation x-senior-service-path: engine_bff contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcm_clocking_event_time_evaluationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /engine_bff/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/queries/getTimeEvaluationsByEmployeesAndDates: post: description: Busca uma lista de apurações para os colaboradores nas datas de apuração informadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeesIds – timeEvaluationDate properties: employeesIds: type: array items: type: string minimum: 1 description: Id do colaborador timeEvaluationDate: type: array items: type: string format: date minimum: 1 description: Data da apuração responses: 200: description: Ok schema: type: object required: – timeEvaluation properties: timeEvaluation: type: array items: type: object allOf: – #/definitions/timeEvaluationDTO minimum: 1 description: DTO da apuração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/queries/hasLeaveWithESocialReasonTypeInPeriodBFF: post: description: Verifica se existe um afastamento para o colaborador nos período pesquisado com um dos motivos eSocial pesquisados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – periodStartDate – periodEndDate – eSocialReasonTypes properties: employeeId: type: string maxLength: 36 description: Identificador único do colabroador periodStartDate: type: string format: date description: Data de inicio do periodo consultado periodEndDate: type: string format: date description: Data fim do periodo consultado eSocialReasonTypes: type: array items: type: string allOf: – #/definitions/eSocialReasonType minimum: 1 description: Motivos eSocial pesquisados responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/actions/reevaluateEmployeeDay: post: description: Recalculo de apuração para tela de acerto tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – reevaluateInput properties: reevaluateInput: type: object allOf: – #/definitions/timeEvaluationVersionDTO description: DTO para reapurar o ponto do colaborador responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/actions/getReevaluateEmployeeDayInputRule: post: description: Extrair os dados que são enviados para regra de customização de uma apuração específica tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da apuração responses: 200: description: Ok schema: type: object required: – input – ruleEnabled properties: input: type: string description: Conteúdo do Json enviado para a regra de customização, caso a mesma tiver habilitada ruleEnabled: type: boolean description: Regra esta habilitada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/actions/timeEvaluationChangesBatch: post: description: Endpoint que salva ou exclui marcações para uma data tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – timeEvaluation – clockingEventBatch properties: timeEvaluation: type: object allOf: – #/definitions/timeEvaluationVersionDTO description: Apuração clockingEventBatch: type: object allOf: – #/definitions/clockingEventBatchDTO description: Lote de marcações responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/actions/allowsShiftingClockingEvent: post: description: Endpoint que verifca se permite mover marcação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – timeEvaluation – shiftingClockingEvent – clockingEventBatch – forwards properties: timeEvaluation: type: object allOf: – #/definitions/timeEvaluationDTO description: Id da apuração shiftingClockingEvent: type: object allOf: – #/definitions/clockingEventShiftedDTO description: Marcação à ser movida clockingEventBatch: type: object allOf: – #/definitions/clockingEventBatchDTO description: Lote de marcações forwards: type: boolean description: Sentido da ação de mover marcação responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da chamada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/actions/timeEvaluationSituationChangesBatch: post: description: Endpoint que salva ou exclui situações para uma data tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – timeEvaluation properties: timeEvaluation: type: object allOf: – #/definitions/timeEvaluationVersionDTO description: Apuração situations: type: array items: type: object allOf: – #/definitions/timeEvaluationSituationDTO description: Situações para incluir ou editar responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/actions/verifyEmployeeTimeEvaluation: post: description: Ação para verificação das pendências do dia apurado do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – verified – timeEvaluationId – version properties: verified: type: boolean description: Estado da verificação timeEvaluationId: type: string maxLength: 36 description: Dia apurado type: integer format: int64 description: Versão do dia apurado responses: 200: description: Ok schema: type: object required: – version properties: type: integer format: int64 description: Versão do dia apurado atualizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/actions/verifyEmployeeTimeEvaluationPeriod: post: description: Ação para verificação das pendências do dia apurado do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – days – verified properties: employeeId: type: string maxLength: 36 description: Colaborador days: type: array items: type: string format: date minimum: 1 description: Dias apurados à serem verificados verified: type: boolean description: Estado da verificação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/actions/verifyEmployeeTimeEvaluationByCompetence: post: description: Ação para verificação das pendências de dia apurado para uma lista de colaboradores em uma determinada competência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – competence – verified properties: employeeId: type: string description: Colaboradores competence: type: string format: date description: Competência verified: type: boolean description: Estado da verificação advancedFilterId: type: string description: ID do filtro avançado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/actions/verifyEmployeesTimeEvaluationsByCompetence: post: description: Ação para verificação das pendências de dia apurado para uma lista de colaboradores em uma determinada competência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employees – competence – verified properties: employees: type: array items: type: string minimum: 1 description: Colaboradores competence: type: string format: date description: Competência verified: type: boolean description: Estado da verificação advancedFilterId: type: string description: ID do filtro avançado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/actions/verifyAllEmployeesTimeEvaluationsByCompetenceBatchAsync: post: description: Ação para verificação das pendências do dia apurado do colaborador em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competence – verified – filters properties: competence: type: string format: date description: Competência verified: type: boolean description: Estado da verificação filters: type: object allOf: – #/definitions/findEmployeeByCompetenceFilterDTO description: Filtros advancedFilterId: type: string description: ID do filtro avançado responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Id do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/signals/reevaluateScheduleHistoryAsync: post: description: recálculo de apuração a partir de históricos e programações tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – reevaluateInput properties: reevaluateInput: type: object allOf: – #/definitions/reevaluateEmployeeDTO description: DTO para reapurar o ponto do colaborador responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /engine_bff/signals/reevaluateDaysScheduleHistoryAsync: post: description: recálculo de apuração a partir de históricos e programações tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – reevaluateInput properties: reevaluateInput: type: object allOf: – #/definitions/reevaluateEmployeeDTO description: DTO para reapurar o ponto do colaborador responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /engine_bff/events/reevaluateScheduleHistoryEvent: post: description: Evento para recálculo de apuração a partir de históricos e programações x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – reevaluateInput properties: reevaluateInput: type: object allOf: – #/definitions/reevaluateEmployeeDTO description: DTO para reapurar o ponto do colaborador responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /engine_bff/events/employeeReevaluateFinished: post: description: Evento websocket para avisar que o recálculo do colaborador foi finalizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – reevaluateInput – result properties: reevaluateInput: type: object allOf: – #/definitions/reevaluateEmployeeDTO description: DTO para reapurar o ponto do colaborador result: type: object allOf: – #/definitions/messageStatus description: DTO com o resultado da operação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /engine_bff/apis/workshiftHistoryAdjustment: post: description: Histórico de escala para tela de acerto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/workshiftHistoryAdjustmentFacade responses: 200: description: Ok schema: #/definitions/workshiftHistoryAdjustmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/apis/workshiftHistoryAdjustment/{id}: get: description: Histórico de escala para tela de acerto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workshiftHistoryAdjustmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Histórico de escala para tela de acerto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/workshiftHistoryAdjustmentFacade responses: 200: description: Ok schema: #/definitions/workshiftHistoryAdjustmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Histórico de escala para tela de acerto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/apis/leaveHistoryAdjustment: post: description: Histórico de afastamento para tela de acerto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/leaveHistoryAdjustmentFacade responses: 200: description: Ok schema: #/definitions/leaveHistoryAdjustmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /engine_bff/apis/leaveHistoryAdjustment/{id}: get: description: Histórico de afastamento para tela de acerto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/leaveHistoryAdjustmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Histórico de afastamento para tela de acerto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/leaveHistoryAdjustmentFacade responses: 200: description: Ok schema: #/definitions/leaveHistoryAdjustmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Histórico de afastamento para tela de acerto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim messageStatusType: type: string enum: – SUCCESS – FAIL description: Status da execução do request: * `SUCCESS` – Sucesso * `FAIL` – Falha clockingEventOriginType: type: string enum: – V1 – V2 – V3 description: Origem Marcação: * `V1` – Eletrônica * `V2` – DIGITADA * `V3` – GERADA clockingUseType: type: string enum: – V1 – WAITING – REQUIRED_STOP – DRIVING description: Uso da marcação: * `V1` – Marcação de ponto * `WAITING` – Marcação de espera * `REQUIRED_STOP` – Parada obrigatória * `DRIVING` – Marcação de direção identificationType: type: string enum: – V1 – V2 – V3 – V4 description: Tipo de Identificação: * `V1` – Pis * `V2` – Crachá * `V3` – Colaborador * `V4` – CPF scheduleType: type: string enum: – RIGID – MOBILE – FLEXIBLE – MOBILE_ENTRANCE_EXIT – MOBILE_MEAL – FLEXIBLE_AT_INTERVALS description: Tipo de horário: * `RIGID` – Rígido * `MOBILE` – Móvel * `FLEXIBLE` – Flexível * `MOBILE_ENTRANCE_EXIT` – Misto – Móvel na entrada e saída * `MOBILE_MEAL` – Misto – Móvel na refeição * `FLEXIBLE_AT_INTERVALS` – Flexível nos intervalos workscheduleDefinitionType: type: string enum: – NORMAL – DAYOFF – HOLIDAY – OFFSET – DSR description: Tipo de Horário: * `NORMAL` – Normal * `DAYOFF` – Folga * `HOLIDAY` – Feriado * `OFFSET` – Compensado * `DSR` – DSR eSocialWorkingHoursType: type: string enum: – V1 – V2 – V3 – V4 description: Regime de Jornada do eSocial: * `V1` – 1 – Submetido a horário de trabalho (Capítulo II do Título II da CLT) * `V2` – 2 – Atividade externa especificada no inciso I do art. 62 da CLT * `V3` – 3 – Função especificada no inciso II do art. 62 da CLT * `V4` – 4 – Teletrabalho, previsto no inciso III do art. 62 da CLT periodType: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 description: Tipo de período: * `V1` – Qualquer parte do expediente * `V2` – Início e fim do expediente * `V3` – Durante intervalos de refeição * `V4` – Início do expediente * `V5` – Final do expediente * `V6` – Início do expediente antecipando horário * `V7` – Final do expediente prorrogando horário * `V8` – Dispensar 1ª parte do expediente * `V9` – Dispensar 2ª parte do expediente compensationType: type: string enum: – V1 – V2 – V4 – V5 – V6 description: Tipo de compensação: * `V1` – Extra para compensação * `V2` – Ausência para compensação * `V4` – Dispensar parte expediente * `V5` – Dispensar intervalo horas * `V6` – Programar intervalo fora expediente timeEvaluationType: type: string enum: – V1 – V2 – V5 – V7 description: Tipo de apuração: * `V1` – Normal * `V2` – Dispensado do ponto * `V5` – Sem controle de ponto * `V7` – Ponto por Exceção article62CltType: type: string enum: – V1 – V2 – V3 – V4 description: Artigo 62 da CLT: * `V1` – Não se aplica * `V2` – Atividade externa especificada no inciso I * `V3` – Funções especificadas no inciso II * `V4` – Teletrabalho, previsto no inciso III sourceReasonChange: type: string enum: – V1 – V2 – V3 description: Origem da mudança: * `V1` – Por iniciativa do empregador * `V2` – Revisão administrativa * `V3` – Determinação judicial processType: type: string enum: – V1 – V2 – V3 description: Tipo do Processo: * `V1` – Administrativo * `V2` – Judicial * `V3` – Número de Benefício – NB do INSS onusRemuneration: type: string enum: – V1 – V2 – V3 description: Ônus pela remuneração: * `V1` – Apenas do empregador * `V2` – Apenas do sindicato * `V3` – Parte do empregador, sendo a diferença e/ou complementação salarial paga pelo sindicato workAccidentType: type: string enum: – V1 – V2 – V3 description: Tipo de acidente de trabalho: * `V1` – Atropelamento * `V2` – Colisão * `V3` – Outros eSocialReasonType: type: string enum: – V0 – V1 – V3 – V5 – V6 – V7 – V8 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 – V21 – V22 – V23 – V24 – V25 – V26 – V27 – V28 – V29 – V30 – V31 – V33 – V34 – V35 – V36 – V37 – V38 description: Motivo afastamento e-social: * `V0` – Não enviar * `V1` – Acidente/Doença do trabalho * `V3` – Acidente/Doença não relacionada ao trabalho * `V5` – Afastamento/licença prevista em regime próprio (estatuto), sem remuneração * `V6` – Aposentadoria por invalidez * `V7` – Acompanhamento – Licença para acompanhamento de membro da família enfermo * `V8` – Afastamento do empregado para participar de atividade do Conselho Curador do FGTS – art. 65, §6º, Dec. 99.684/90 (Regulamento do FGTS) * `V10` – Afastamento/licença prevista em regime próprio (estatuto), com remuneração * `V11` – Cárcere * `V12` – Cargo Eletivo – Candidato a cargo eletivo – Art. 25, parágrafo único, da Lei 7.664/1988 – Celetistas em geral * `V13` – Cargo Eletivo – Candidato a cargo eletivo – Art. 1°, inciso II, alínea “l” da Lei Complementar 64/1990 – Servidor público, estatutário ou não, dos órgãos ou entidades da Administração Direta ou Indireta da União, dos Estados, do Distrito Federal, dos Municípios e dos Territórios, inclusive das fundações mantidas pelo Poder Público. * `V14` – Cessão / Requisição * `V15` – Gozo de férias ou recesso – Afastamento temporário para o gozo de férias ou recesso * `V16` – Licença remunerada – Lei, liberalidade da empresa ou Acordo/Convenção Coletiva de Trabalho * `V17` – Licença Maternidade * `V18` – Licença maternidade – Prorrogação por 60 dias, Lei 11.770/2008 (Empresa Cidadã), inclusive para o cônjuge sobrevivente * `V19` – Licença Maternidade – Afastamento temporário por motivo de aborto não criminoso * `V20` – Licença maternidade – Afastamento temporário por motivo de licença-maternidade para o cônjuge sobrevivente ou decorrente de adoção ou de guarda judicial de criança * `V21` – Licença não remunerada ou Sem Vencimento * `V22` – Mandato eleitoral – Afastamento temporário para o exercício de mandato eleitoral * `V23` – Mandato Eleitoral – Afastamento temporário para o exercício de mandato eleitoral, com remuneração * `V24` – Mandato Sindical – Afastamento temporário para exercício de mandato sindical * `V25` – Mulher vítima de violência – Art. 9º, § 2º, inciso II, da Lei 11.340/2006 – Lei Maria da Penha * `V26` – Participação de empregado no Conselho Nacional de Previdência Social – CNPS – Art. 3º da Lei 8.213/1991 * `V27` – Qualificação – Afastamento por suspensão do contrato de acordo com o art 476-A da CLT * `V28` – Representante Sindical – Afastamento pelo tempo que se fizer necessário, quando, na qualidade de representante de entidade sindical, estiver participando de reunião oficial de organismo internacional do qual o Brasil seja membro * `V29` – Serviço Militar – Afastamento temporário para prestar serviço militar obrigatório * `V30` – Suspensão disciplinar – Art. 474 da CLT * `V31` – Servidor público em disponibilidade * `V33` – Licença maternidade – 180 dias, Lei 13.301/2016 * `V34` – Inatividade do trabalhador avulso (portuário ou não portuário) por período superior a 90 dias * `V35` – Licença maternidade – Antecipação e/ou prorrogação mediante atestado médico * `V36` – Afastamento temporário de exercente de mandato eletivo para cargo em comissão * `V37` – Suspensão temporária do contrato de trabalho nos termos da Lei 14.020/2020 (conversão da MP 936/2020) * `V38` – Impedimento de concorrência à escala para trabalho avulso contractType: type: string enum: – EMPLOYEE – DIRECTOR – TRAINEE – APRENTICE – THIRD_PARTY description: Tipo de contrato: * `EMPLOYEE` – Empregado * `DIRECTOR` – Diretor * `TRAINEE` – Estagiário * `APRENTICE` – Aprendiz * `THIRD_PARTY` – Terceiro situationType: type: string enum: – WORKING – VACATION – ILLNESSAID – LABORACCIDENT – MILITARYSERVICE – MATERNITYLEAVE – MATERNITYLEAVENONCRIMINALABORTION – MATERNITYLEAVEANTICIPATIONEXTENSION – CITIZENCOMPANYMATERNITY – INSSMATERNITYLEAVE – LEAVEWITHOUTCOMPENSATION – PAIDLEAVE – PATERNITYLEAVE – CITIZENCOMPANYPATERNITY – COLLECTIVEVACATION – MEDICALLEAVE – MEDICALLEAVEWITHOUTINSS – ABSENCES – OVERTIME – TIMEEVALUATIONSITUATION – PRECAUTIONREADINESS – TRADEUNIONMANDATE – WORKACCIDENTLEAVE – WORKACCIDENTLEAVEWITHOUTINSS – RETIREMENTDUETODISABILITY – OTHERS description: Tipo da situação: * `WORKING` – Trabalhando * `VACATION` – Férias * `ILLNESSAID` – Auxílio doença * `LABORACCIDENT` – Acidente de trabalho * `MILITARYSERVICE` – Serviço militar * `MATERNITYLEAVE` – Licença maternidade * `MATERNITYLEAVENONCRIMINALABORTION` – Licença maternidade – Aborto não criminoso * `MATERNITYLEAVEANTICIPATIONEXTENSION` – Licença maternidade – Prorrogação mediante atestado médico * `CITIZENCOMPANYMATERNITY` – Licença maternidade – Empresa cidadã * `INSSMATERNITYLEAVE` – Licença maternidade INSS * `LEAVEWITHOUTCOMPENSATION` – Licença sem remuneração * `PAIDLEAVE` – Licença remunerada * `PATERNITYLEAVE` – Licença paternidade * `CITIZENCOMPANYPATERNITY` – Licença paternidade – Empresa cidadã * `COLLECTIVEVACATION` – Férias coletivas * `MEDICALLEAVE` – Licença médica (pgto Empresa) * `MEDICALLEAVEWITHOUTINSS` – Licença médica sem incidência INSS * `ABSENCES` – Faltas * `OVERTIME` – Horas extras * `TIMEEVALUATIONSITUATION` – Situação de apuração ponto * `PRECAUTIONREADINESS` – Sobreaviso/Prontidão * `TRADEUNIONMANDATE` – Mandato sindical * `WORKACCIDENTLEAVE` – Licença acidente de trabalho (pgto empresa) * `WORKACCIDENTLEAVEWITHOUTINSS` – Licença acidente de trabalho sem incidência INSS * `RETIREMENTDUETODISABILITY` – Apostentadoria por invalidez * `OTHERS` – Outros workshiftType: type: string enum: – PERMANENT – AUTOMATIC_SEARCH description: Tipo de escala: * `PERMANENT` – Permanente * `AUTOMATIC_SEARCH` – Busca automática managerFilterType: type: string enum: – ALL – PENDING – EXCEPTION description: Filtro do gestor: * `ALL` – Todos * `PENDING` – Pendências * `EXCEPTION` – Exceções userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status messageStatus: description: DTO com o resultado da operação type: object required: – domain – service – status – errorMessage properties: domain: type: string description: Domínio service: type: string description: Serviço status: type: string allOf: – #/definitions/messageStatusType description: Status errorMessage: type: string description: Mensagem de erro reevaluateEmployeeDTO: description: DTO para reapurar o ponto do colaborador type: object required: – employee properties: employee: type: array items: type: string minimum: 1 description: Id do colaborador startDate: type: string format: date description: Data início endDate: type: string format: date description: Data final days: type: array items: type: string format: date description: Dias de recálculo isManager: type: boolean description: Indica se é gestor isOriginScreenTimeEvaluation: type: boolean description: Indica se é origem da tela de acerto reevaluateEmployeeDayDTO: description: DTO para reapurar um dia de ponto do colaborador type: object required: – employee – date properties: employee: type: string description: Id do colaborador date: type: string format: date description: Data do cálculo registerJustificationDTO: description: DTO da justificativa de acerto type: object properties: id: type: string description: Identificador clockingEventDTO: description: DTO da marcação type: object required: – clockingEventDate – clockingEventTime properties: id: type: string description: Identificador clockingEventDate: type: string format: date description: Data da Marcação clockingEventTime: type: string description: Hora da Marcação clockingUseType: type: string allOf: – #/definitions/clockingUseType description: Uso da marcação justification: type: object allOf: – #/definitions/registerJustificationDTO description: Justificativa da marcação zoneOffset: type: string description: Fuso horário clockingEventDeleteDTO: description: DTO para a exclusão da marcação type: object properties: id: type: string description: Identificador justification: type: object allOf: – #/definitions/registerJustificationDTO description: Justificativa da marcação timeEvaluationDTO: description: DTO da apuração type: object required: – id properties: id: type: string description: Identificador único workSchedule: type: string description: Horário timeEvaluationDate: type: string format: date description: Data da apuração timeEvaluationSituationDTO: description: DTO da situação da apuração type: object required: – situation – numberOfHours properties: id: type: string description: Situação da apuração situation: type: object allOf: – #/definitions/situationDTO description: Situação numberOfHours: type: integer format: int64 description: Quantidade de horas da situação em minutos minimum: 1 adjustmentReason: type: object allOf: – #/definitions/adjustmentReasonDTO description: Motivo de acerto situationDTO: description: DTO da situatção com o id type: object required: – id properties: id: type: string description: Identificador único name: type: string description: Descrição code: type: integer format: int64 description: Código situationType: type: string allOf: – #/definitions/situationType description: Tipo da situação adjustmentReasonDTO: description: DTO do motivo de acerto com o id type: object required: – id properties: id: type: string description: Identificador único clockingEventBatchDTO: description: Lote de marcações type: object properties: clockingEvents: type: array items: type: object allOf: – #/definitions/clockingEventDTO description: Marcações para incluir ou editar clockingEventsDelete: type: array items: type: object allOf: – #/definitions/clockingEventDeleteDTO description: Marcações para excluir clockingEventsShiftedForwards: type: array items: type: object allOf: – #/definitions/clockingEventShiftedDTO description: Marcações para mover para frente clockingEventsShiftedBackwards: type: array items: type: object allOf: – #/definitions/clockingEventShiftedDTO description: Marcações para mover para trás clockingEventShiftedDTO: description: DTO da marcação à ser movida type: object required: – dateTime properties: id: type: string description: Identificação dateTime: type: string format: date-time description: Data da Marcação justification: type: object allOf: – #/definitions/registerJustificationDTO description: Justificativa zoneOffset: type: string description: Fuso horário genericIdDTO: description: DTO para representar identiticador de entidades type: object required: – id properties: id: type: string description: Identificador timeEvaluationVersionDTO: description: DTO da apuração type: object required: – id – version properties: id: type: string description: Identificador único type: integer format: int64 description: Versão isManager: type: boolean description: Indica se é gestor leaveHistoryAttachmentDTO: description: Anexos do histórico de afastamento type: object required: – name – locationURI properties: id: type: string description: Identificador único leaveHistory: type: object allOf: – #/definitions/genericIdDTO description: Histórico de afastamento name: type: string maxLength: 255 description: Nome do arquivo locationURI: type: string maxLength: 2048 description: URI do local documentId: type: string description: Id do documento employeeDTO: description: Anexos do histórico de afastamento type: object properties: id: type: string description: Identificador único person: type: object allOf: – #/definitions/personDTO description: Pessoa code: type: integer format: int64 description: Cadastro employer: type: object allOf: – #/definitions/companyDTO description: Empresa que o contratou employmentRelationship: type: object allOf: – #/definitions/employmentRelationshipDTO description: Vínculo empregatício personDTO: description: Pessoa type: object properties: id: type: string description: Identificador único nomPes: type: string description: Nome companyDTO: description: Empresa type: object properties: id: type: string description: Identificador único codEmp: type: integer format: int64 description: Código da empresa employmentRelationshipDTO: description: Vínculo empregatício type: object properties: id: type: string description: Identificador único contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato workshiftGroupDTO: description: DTO para Turma de escala type: object required: – id properties: id: type: string description: Identificador único code: type: integer format: int64 description: Código baseDate: type: string format: date description: Data base da turma workshiftDTO: description: DTO para escala type: object required: – id properties: id: type: string description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Nome workshiftType: type: string allOf: – #/definitions/workshiftType description: Tipo de escala findEmployeeByCompetenceFilterDTO: description: Filtro para busca de colaboradores por competência type: object required: – type properties: employeeQuery: type: string description: Filtrar pelo código ou nome do colaborador situationId: type: string description: Id da Situação employeeId: type: string description: Id do colaborador companyId: type: string description: Id da empresa type: type: string allOf: – #/definitions/managerFilterType description: Tipo de filtro do gestor diseaseDTO: description: DTO para representar Doença da Classificação Internacional de Doenças type: object properties: id: type: string description: Identificador único code: type: string description: Código name: type: string description: Nome diseaseSubgroup: type: object allOf: – #/definitions/diseaseSubgroupDTO description: Subgrupo de doenças deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string description: Indica status da replicação extIntMsg: type: string description: Indica a mensagem da replicação externalId: type: string description: Identificador externo diseaseSubgroupDTO: description: DTO para representar Subgrupo da Classificação Internacional de Doenças type: object required: – id properties: id: type: string description: Identificador único code: type: string description: Código name: type: string description: Nome deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string description: Indica status da replicação extIntMsg: type: string description: Indica a mensagem da replicação externalId: type: string description: Identificador externo notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service workshiftHistoryAdjustmentFacade: description: Histórico de escala para tela de acerto type: object required: – employee – startDate – workshift – workshiftGroup properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employeeDTO description: Colaborador startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data de término workshift: type: object allOf: – #/definitions/workshiftDTO description: Escala eSocialWorkingHoursType: type: string allOf: – #/definitions/eSocialWorkingHoursType description: Regime de Jornada do eSocial workshiftGroup: type: object allOf: – #/definitions/workshiftGroupDTO description: Turma da escala isManager: type: boolean description: Indica se é gestor default: false createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Última modificação por lastModifiedDate: type: string format: date-time description: Data da última modificação custom: type: string format: byte description: Custom leaveHistoryAdjustmentFacade: description: Histórico de afastamento para tela de acerto type: object required: – employee – startDate – situation properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employeeDTO description: Colaborador employeeEmployer: type: object allOf: – #/definitions/genericIdDTO description: Empresa do colaborador startDate: type: string format: date description: Data de início startTime: type: integer format: int64 description: Hora de início minimum: 0 maximum: 1439 default: 0 endDate: type: string format: date description: Data de término endTime: type: integer format: int64 description: Hora final (Caso uma data final seja definida, o valor padrão desse campo passa a ser 1439) minimum: 0 maximum: 1439 situation: type: object allOf: – #/definitions/situationDTO description: Situação numberHoursLeft: type: integer format: int64 description: Quantidade de horas faltas sourceReasonChange: type: string allOf: – #/definitions/sourceReasonChange description: Origem da mudança processType: type: string allOf: – #/definitions/processType description: Tipo do processo processNumber: type: string maxLength: 21 description: Número do processo birthDate: type: string format: date description: Data do parto diseaseCid: type: object allOf: – #/definitions/diseaseDTO description: CID da doença subgroupCid: type: object allOf: – #/definitions/diseaseSubgroupDTO description: CID do subgrupo cnpjUnion: type: integer format: int64 description: CNPJ onusRemuneration: type: string allOf: – #/definitions/onusRemuneration description: Ônus pela remuneração workAccidentType: type: string allOf: – #/definitions/workAccidentType description: Tipo de acidente de trabalho justifiedDays: type: integer format: int64 description: Dias justificados observation: type: string maxLength: 255 description: Observação sameReasonEsocial: type: boolean description: Mesma razão e-social resultedSicknessAssistance: type: boolean description: Resultou em assistência médica estimatedEndDate: type: string format: date description: Data final estimada estimatedDayEnd: type: integer format: int64 description: Dia final estimado maximum: 9999 leaveHistoryAttachments: type: array items: type: object allOf: – #/definitions/leaveHistoryAttachmentDTO description: Anexos isManager: type: boolean description: Indica se é gestor default: false createdBy: type: string description: Criado por createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Última modificação por lastModifiedDate: type: string format: date-time description: Data da última modificação custom: type: string format: byte description: Custom genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage