2.0info: 2.6.1 HCM – Clocking Event Time Evaluation Process Manager description: HCM – Clocking Event Time Evaluation Process Manager x-senior-domain: HCM – Clocking Event Time Evaluation x-senior-domain-path: hcm_clocking_event_time_evaluation x-senior-service-path: process_manager 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: /process_manager/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 /process_manager/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 maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 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 maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportCompanyClockingEventIndications: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportTimeEvaluationDefinition: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportCalculationDefinition: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportCalculationDefinitionException: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportProcess: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportHourBank: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportHourBankAccount: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportE001pes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportEmployeeSnapshot: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportHourBankEmployeeBalance: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportHourBankCompetenceBalance: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportEmployeeClockingEvent: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/queries/exportEmployeeModule: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/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 /process_manager/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/evaluate: post: description: Cálculo de apuração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters – considerDismissed – reconsiderDeletedClockingEventsAdjustment properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o cálculo de apuração considerDismissed: type: boolean description: Considerar demitidos reconsiderDeletedClockingEventsAdjustment: type: boolean description: Reconsiderar marcações excluídas no acerto responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/evaluateAsync: post: description: Cálculo de apuração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters – considerDismissed – reconsiderDeletedClockingEventsAdjustment properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o cálculo de apuração considerDismissed: type: boolean description: Considerar demitidos reconsiderDeletedClockingEventsAdjustment: type: boolean description: Reconsiderar marcações excluídas no acerto responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/reevaluate: post: description: Cálculo de apuração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters – considerDismissed – onlyModifiedDaysAfterEvaluation – realocateClockingEvents – undoAdjustments – verifiedDays properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o cálculo de apuração considerDismissed: type: boolean description: Considerar demitidos onlyModifiedDaysAfterEvaluation: type: boolean description: Somente dias alterados após a apuração realocateClockingEvents: type: boolean description: Realocar marcações undoAdjustments: type: boolean description: Desfazer acertos verifiedDays: type: string allOf: – #/definitions/verifiedDaysType description: Dias verificados responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/reevaluateAsync: post: description: Cálculo de apuração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters – considerDismissed – onlyModifiedDaysAfterEvaluation – realocateClockingEvents – undoAdjustments – verifiedDays properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o cálculo de apuração considerDismissed: type: boolean description: Considerar demitidos onlyModifiedDaysAfterEvaluation: type: boolean description: Somente dias alterados após a apuração realocateClockingEvents: type: boolean description: Realocar marcações undoAdjustments: type: boolean description: Desfazer acertos verifiedDays: type: string allOf: – #/definitions/verifiedDaysType description: Dias verificados responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/hourBankMonthlyClosureAsync: post: description: Fechamento mensal do Banco de Horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankId – filters properties: hourBankId: type: string maxLength: 36 description: Id do Banco de Horas competence: type: string format: date description: Competência filters: type: object allOf: – #/definitions/filterEvaluate description: Filtro de colaboradores responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/hourBankReevaluateAsync: post: description: Recálculo do banco de horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankId – startDate – filters properties: hourBankId: type: string maxLength: 36 description: Id do banco de horas startDate: type: string format: date description: Data de inicio do recálculo filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o recálculo do banco de horas considerDismissed: type: boolean description: Considerar demitidos default: true isDeleteIntegrationEntries: type: boolean description: É para excluir os lançamentos de integração default: false isCreateEvaluationEntries: type: boolean description: É para recriar os lançamentos da apuração default: false responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/hourBankAnticipateAllowanceAsync: post: description: Antecipar pagamento para o banco de horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankPaymentDTO – filters properties: hourBankPaymentDTO: type: object allOf: – #/definitions/hourBankPaymentDTO description: DTO com os dados de pagamento filters: type: object allOf: – #/definitions/filterEvaluate description: Filtro de colaboradores responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/hourBankCancelDebitAsync: post: description: Anular debito para o banco de horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankPaymentDTO – filters properties: hourBankPaymentDTO: type: object allOf: – #/definitions/hourBankPaymentDTO description: DTO com os dados de pagamento filters: type: object allOf: – #/definitions/filterEvaluate description: Filtro de colaboradores responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/hourBankAnticipateDiscountAsync: post: description: Anular debito para o banco de horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankPaymentDTO – filters properties: hourBankPaymentDTO: type: object allOf: – #/definitions/hourBankPaymentDTO description: DTO com os dados de pagamento filters: type: object allOf: – #/definitions/filterEvaluate description: Filtro de colaboradores responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/clockingEventGenerateEvents: post: description: Calculo de geração de eventos do Ponto tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competence – filters – doubleEvents properties: competence: type: string format: date description: Competência filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o calculo da geração dos eventos calculateTermination: type: boolean description: Calcular para rescisão default: false doubleEvents: type: string allOf: – #/definitions/doubleType description: Eventos duplos responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/resetTimeEvaluationAsync: post: description: Zerar apuração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – filters properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final deleteClockingEventTyped: type: boolean description: Deletar marcações digitadas default: true filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para zerar apuração responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importCompanyClockingEventIndications: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importTimeEvaluationDefinition: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importCalculationDefinition: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importCalculationDefinitionException: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importProcess: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importHourBank: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importHourBankAccount: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importE001pes: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importEmployeeSnapshot: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importHourBankEmployeeBalance: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importHourBankCompetenceBalance: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importEmployeeClockingEvent: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/importEmployeeModule: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/signals/reevaluateScheduleHistoryBatchAsync: post: description: Recálculo de apuração histórico e programações tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – employees properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo employees: type: array items: type: string maxLength: 255 minimum: 1 description: Colaboradores responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process_manager/signals/finishedProcessNotification: post: description: Realiza as ações necessárias ao finalizar um processo. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – processType properties: processId: type: string maxLength: 36 description: Identificador do processo processType: type: string allOf: – #/definitions/processType description: Tipo do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process_manager/signals/cancelProcessNotification: post: description: Realiza as ações necessárias ao cancelar um processo. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – processType properties: processId: type: string maxLength: 36 description: Identificador do processo processType: type: string allOf: – #/definitions/processType description: Tipo do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process_manager/events/hourBankClosureLoad: post: description: Evento para carregamento das informações do fechamento do banco de horas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – payloadParams – employeeIds properties: processId: type: string maxLength: 255 description: Id do processo. batchId: type: string maxLength: 255 description: Id do lote de colaboradores payloadParams: type: string maxLength: 255 description: payload dos parâmetros employeeIds: type: array items: type: string maxLength: 255 minimum: 1 description: Lista de colaboradores por lote responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/employeeTimeEvaluationLoad: post: description: Evento para carregamento das informações do cálculo de apuração, Quando alterar verificar que o employee-contract-processor tem dependência x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – employees – payloadParams properties: processId: type: string maxLength: 255 description: Id do processo. batchId: type: string maxLength: 255 description: Id do lote de colaboradores employees: type: array items: type: object allOf: – #/definitions/employeesPeriodDTO minimum: 1 description: payload payloadParams: type: string maxLength: 255 description: payload dos parâmetros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importCompanyClockingEventIndicationsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportCompanyClockingEventIndicationsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importTimeEvaluationDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportTimeEvaluationDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importCalculationDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportCalculationDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importCalculationDefinitionExceptionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportCalculationDefinitionExceptionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importProcessEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportProcessEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importHourBankEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportHourBankEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importHourBankAccountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportHourBankAccountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportE001pesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importEmployeeSnapshotEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportEmployeeSnapshotEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importHourBankEmployeeBalanceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportHourBankEmployeeBalanceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importHourBankCompetenceBalanceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportHourBankCompetenceBalanceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importEmployeeClockingEventEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportEmployeeClockingEventEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/importEmployeeModuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/exportEmployeeModuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN verifiedDaysType: description: Dias verificados type: string enum: – ALL_DAYS – ONLY_VERIFIED_DAYS – ONLY_UNVERIFIED_DAYS hourBankClosureType: description: Tipo de fechamento de banco de horas type: string enum: – MONTHLY_CLOSE – ANTICIPATE_ALLOWANCE – CANCEL_DEBIT – ANTICIPATE_DISCOUNT calculationType: description: Tipo de cálculo type: string enum: – MONTHLY_PAYROLL – ADVANCE_SALARY – THIRTEENTH_SALARY – ADVANCE_THIRTEENTH_SALARY exceptionType: description: Tipo de exceção type: string enum: – V1 – V2 – V3 processType: description: Tipos de processo type: string enum: – TIME_EVALUATION – TIME_EVALUATION_RECALCULATION – HOUR_BANK_CLOSURE – HOUR_BANK_REEVALUATE – GENERATE_EVENT – TIME_EVALUATION_VERIFICATION – RESET_TIME_EVALUATION contractType: description: Tipo de contrato type: string enum: – EMPLOYEE – DIRECTOR – TRAINEE – APRENTICE – THIRD_PARTY salaryType: description: Tipo do salário type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 timeShiftType: description: Turno da escala type: string enum: – FIRSTSHIFT – SECONDSHIFT – THIRDSHIFT – FOURTHSHIFT – MIXEDDAYTIME – MIXEDNIGHTTIME – GENERAL doubleType: description: Eventos duplos type: string enum: – DESPISE – KEEP admissionModuleType: description: Tipo de inscrição do estabelecimento no caso de contratação indireta type: string enum: – HCMHRI – HCMFLX – HCMCEM userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string maxLength: 255 description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status filterEvaluate: description: Filtro para o cálculo de apuração type: object properties: employees: type: array items: type: string maxLength: 255 description: Lista de colaboradores companies: type: array items: type: string maxLength: 255 description: Lista de empresas employeesPeriodDTO: description: Colaboradores com período type: object required: – employee – startDate – endDate properties: employee: type: string maxLength: 255 description: Colaborador startDate: type: string format: date description: Data Inicial endDate: type: string format: date description: Data Final hourBankPaymentDTO: description: DTO com os dados de pagamento type: object required: – hourBankId – closureDate – percentage properties: hourBankId: type: string maxLength: 255 description: ID do banco de horas closureDate: type: string format: date description: Data de fechamento percentage: type: number format: double description: Percentual (%) minimum: 1 maximum: 100 hoursLimit: type: string maxLength: 255 description: Limite de horas, formato em quantidade de horas: hhh:mm isCloseBankAccount: type: boolean description: Fechar contas do banco default: false e070emp: description: Empresa – entidade incompleta type: object required: – codEmp – nomEmp properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa companyClockingEventIndications: type: object allOf: – #/definitions/companyClockingEventIndications description: Assinalamentos do ponto para a empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: companyClockingEventIndications: description: Assinalamentos do ponto para a empresa – entidade incompleta type: object properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa timeEvaluationDefinition: type: object allOf: – #/definitions/timeEvaluationDefinition description: Definição de apuração deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: timeEvaluationDefinition: description: Definição de apuração – entidade incompleta type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string maxLength: 255 description: Descrição x-i18n: true daysResume: type: integer format: int64 description: Dias para retomar deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. calculationDefinition: description: Código de cálculo type: object required: – code – calculationType – competence – timeTrackingStartDate – timeTrackingEndDate – paymentDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa code: type: integer format: int64 description: Código do cálculo calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo competence: type: string format: date description: Competência timeTrackingStartDate: type: string format: date description: Período apuração ponto inicial timeTrackingEndDate: type: string format: date description: Período apuração ponto final paymentDate: type: string format: date description: Data pagamento deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: calculationDefinitionException: description: Exceção do código de cálculo type: object required: – exceptionType – filter – timeTrackingStartDate – timeTrackingEndDate – paymentDate properties: id: type: string format: uuid description: Identificador único calculationDefinition: type: object allOf: – #/definitions/calculationDefinition description: Código de cálculo exceptionType: type: string allOf: – #/definitions/exceptionType description: Tipo de exceção filter: type: string maxLength: 255 description: Abrangência timeTrackingStartDate: type: string format: date description: Período apuração ponto inicial timeTrackingEndDate: type: string format: date description: Período apuração ponto final paymentDate: type: string format: date description: Data pagamento deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: process: description: Responsável pelo controle da coreografia de pré-requisitos do processo de apuração de horas dos colaboradores. type: object required: – processId – batchId – total properties: id: type: string format: uuid description: Identificador único processId: type: string format: uuid description: Identificador do processo batchId: type: string format: uuid description: Identificador do lote total: type: integer format: int64 description: Total de pré-requisitos finalizados minimum: 0 createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: hourBank: description: Banco de horas type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string maxLength: 255 description: Descrição x-i18n: true createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. hourBankAccount: description: Conta do banco de horas type: object required: – employee – hourBank – creationDateAccount properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador hourBank: type: object allOf: – #/definitions/hourBank description: Banco de Horas creationDateAccount: type: string format: date description: Data de criação da conta extinctionDateAccount: type: string format: date description: Data de extinção da conta initialCompetence: type: string format: date description: Compentencia inicial finalCompetence: type: string format: date description: Compentencia final createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: employee: description: Colaborador type: object required: – person – code properties: id: type: string format: uuid description: Identificador único person: type: object allOf: – #/definitions/e001pes description: Pessoa hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de desligamento employer: type: object allOf: – #/definitions/e070emp description: Empresa que o contratou code: type: integer format: int64 description: Cadastro employeeSnapshot: type: object allOf: – #/definitions/employeeSnapshot description: Históricos correntes do colaborador deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: e001pes: description: Pessoa type: object required: – nomPes properties: id: type: string format: uuid description: Identificador único nomPes: type: string maxLength: 100 description: Nome numNis: type: string maxLength: 11 description: Número de inscrição do segurado (NIS, NIT e PIS/PASEP) cnpCpf: type: string maxLength: 14 description: CNPJ/CPF excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: employeeSnapshot: description: Históricos correntes do colaborador type: object properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador company: type: string format: uuid description: Empresa corrente do colaborador companyCode: type: integer format: int64 description: Código da empresa corrente do colaborador companyBranch: type: string format: uuid description: Filial corrente do colaborador companyBranchCode: type: integer format: int64 description: Código da filial corrente do colaborador companyBranchName: type: string maxLength: 255 description: Nome da filial employmentRelationship: type: string format: uuid description: Vínculo empregatício corrente do colaborador employmentRelationshipCode: type: integer format: int64 description: Código do vínculo empregatício corrente do colaborador employmentRelationshipContractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato vínculo empregatício corrente do colaborador jobPosition: type: string format: uuid description: Cargo corrente do colaborador jobPositionCode: type: integer format: int64 description: Código do cargo corrente do colaborador position: type: string format: uuid description: Posição corrente do colaborador positionCode: type: integer format: int64 description: Código da posição corrente do colaborador salaryHistorySalaryType: type: string allOf: – #/definitions/salaryType description: Tipo de salário corrente do colaborador syndicate: type: string format: uuid description: Sindicato corrente do colaborador syndicateCode: type: integer format: int64 description: Código do sindicato corrente do colaborador workshift: type: string format: uuid description: Escala corrente do colaborador workshiftCode: type: integer format: int64 description: Código da escala corrente do colaborador workshiftTimeShiftType: type: string allOf: – #/definitions/timeShiftType description: Turno do horário corrente do colaborador workshiftGroup: type: string format: uuid description: Turma da escala corrente do colaborador workshiftGroupCode: type: integer format: int64 description: Código da turma da escala corrente do colaborador costCenter: type: string format: uuid description: Centro de custo corrente do colaborador costCenterCode: type: string maxLength: 9 description: Código do centro de custo corrente do colaborador location: type: string format: uuid description: Local corrente do colaborador locationCode: type: integer format: int64 description: Código do local corrente do colaborador deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: hourBankEmployeeBalance: description: Total do banco de horas por colaborador type: object required: – employee – hourBank properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador hourBank: type: object allOf: – #/definitions/hourBank description: Banco de horas compensationDeadline: type: string format: date description: Data de vencimento createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: hourBankCompetenceBalance: description: Saldos de Banco de horas por competência type: object required: – employee – hourBank properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador hourBank: type: object allOf: – #/definitions/hourBank description: Banco de horas competenceBalance: type: string format: date description: Competência do saldo createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: employeeClockingEvent: description: Especialização do colaborador para o ponto type: object required: – hireCompetence properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador hireCompetence: type: string format: date description: Competência de admissão dismissalCompetence: type: string format: date description: Compentência de demissão createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: employeeModule: description: Modulo do colaborador type: object required: – employee – moduleType properties: id: type: string format: uuid description: Identificador employee: type: object allOf: – #/definitions/employee description: Colaborador moduleType: type: string maxLength: 6 description: Tipo do módulo deleted: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: 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 maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 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 maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 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 maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string maxLength: 255 description: message: type: string maxLength: 255 description: exceptionClass: type: string maxLength: 255 description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string maxLength: 255 description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string maxLength: 255 description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string maxLength: 255 description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string maxLength: 255 description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string maxLength: 255 description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string maxLength: 255 description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string maxLength: 255 description: beanClass: type: string maxLength: 255 description: serviceClass: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string maxLength: 255 description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string maxLength: 255 description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE