HCM – Clocking Event Time Evaluation Hour Bank General (hour_bank_engine)

2.0info: 8.1.0 HCM – Clocking Event Time Evaluation Hour Bank General description: HCM – Clocking Event Time Evaluation Hour Bank General x-senior-domain: HCM – Clocking Event Time Evaluation Hour Bank General x-senior-domain-path: hcm_clocking_event_time_evaluation x-senior-service-path: hour_bank_engine 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: /hour_bank_engine/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 /hour_bank_engine/queries/evaluateHourBankEvents: post: description: Calcula os eventos gerados pelo banco de horas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employees – competence properties: employees: type: array items: type: string minimum: 1 description: Ids dos colaboradores competence: type: string format: date description: Competência responses: 200: description: Ok schema: type: object required: – events properties: events: type: array items: type: object allOf: – #/definitions/evaluatedEventDTO minimum: 1 description: Eventos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 /hour_bank_engine/queries/exportIntegrationDefinition: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportIntegrationDefinitionGeneral: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportIntegrationDefinitionCompetence: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportHourBankPeriod: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportHourBankDeadLinesLimits: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportHourBankSituation: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportHourBankDefinition: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportHourBankEntry: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportHourBankLimitOverflow: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportHourBankCompensation: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportSituation: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportWageTypeTable: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportWageType: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportTimeEvaluation: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportWorkschedule: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportWorkscheduleClockingRegister: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportTimeEvaluationSituation: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportEmployeeModuleHB: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/queries/exportHourBankNoTransferredEntry: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/actions/reevaluateHourBankMaintenance: post: description: Recalcula o banco de horas com uma operação de um lançamento do banco de horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankEntryChange – startDate properties: hourBankEntryChange: type: object allOf: – #/definitions/hourBankEntryChangeMaintenanceDTO description: Lançamento do banco de horas com sua operação startDate: type: string format: date description: Data inicial responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/startEmployeeCompanyTransfer: post: description: Inicia a transferencia de filial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/employeeCompanyTransferHourBankData responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/undoEmployeeCompanyTransfer: post: description: Desfaz a transferencia de filial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/undoEmployeeCompanyTransferHourBankData responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/resetHourBankBetweenDates: post: description: Exclui os lançamentos do banco de horas de um período e recálcula o banco (zerar apuração) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – resetHourBank properties: resetHourBank: type: object allOf: – #/definitions/resetHourBankAccountDTO description: Parâmetros para resetar o banco de horas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 /hour_bank_engine/actions/importIntegrationDefinition: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importIntegrationDefinitionGeneral: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importIntegrationDefinitionCompetence: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importHourBankPeriod: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importHourBankDeadLinesLimits: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importHourBankSituation: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importHourBankDefinition: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importHourBankEntry: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importHourBankLimitOverflow: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importHourBankCompensation: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importSituation: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importWageTypeTable: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importWageType: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importTimeEvaluation: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importWorkschedule: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importWorkscheduleClockingRegister: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importTimeEvaluationSituation: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importEmployeeModuleHB: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/actions/importHourBankNoTransferredEntry: 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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_engine/events/importIntegrationDefinitionEvent: 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 /hour_bank_engine/events/exportIntegrationDefinitionEvent: 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 /hour_bank_engine/events/importIntegrationDefinitionGeneralEvent: 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 /hour_bank_engine/events/exportIntegrationDefinitionGeneralEvent: 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 /hour_bank_engine/events/importIntegrationDefinitionCompetenceEvent: 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 /hour_bank_engine/events/exportIntegrationDefinitionCompetenceEvent: 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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/events/importHourBankPeriodEvent: 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 /hour_bank_engine/events/exportHourBankPeriodEvent: 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 /hour_bank_engine/events/importHourBankDeadLinesLimitsEvent: 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 /hour_bank_engine/events/exportHourBankDeadLinesLimitsEvent: 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 /hour_bank_engine/events/importHourBankSituationEvent: 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 /hour_bank_engine/events/exportHourBankSituationEvent: 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 /hour_bank_engine/events/importHourBankDefinitionEvent: 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 /hour_bank_engine/events/exportHourBankDefinitionEvent: 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 /hour_bank_engine/events/importHourBankEntryEvent: 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 /hour_bank_engine/events/exportHourBankEntryEvent: 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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/events/importHourBankLimitOverflowEvent: 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 /hour_bank_engine/events/exportHourBankLimitOverflowEvent: 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 /hour_bank_engine/events/importHourBankCompensationEvent: 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 /hour_bank_engine/events/exportHourBankCompensationEvent: 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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/events/importSituationEvent: 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 /hour_bank_engine/events/exportSituationEvent: 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 /hour_bank_engine/events/importWageTypeTableEvent: 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 /hour_bank_engine/events/exportWageTypeTableEvent: 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 /hour_bank_engine/events/importWageTypeEvent: 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 /hour_bank_engine/events/exportWageTypeEvent: 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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/events/importTimeEvaluationEvent: 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 /hour_bank_engine/events/exportTimeEvaluationEvent: 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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/events/importWorkscheduleEvent: 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 /hour_bank_engine/events/exportWorkscheduleEvent: 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 /hour_bank_engine/events/importWorkscheduleClockingRegisterEvent: 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 /hour_bank_engine/events/exportWorkscheduleClockingRegisterEvent: 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 /hour_bank_engine/events/importTimeEvaluationSituationEvent: 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 /hour_bank_engine/events/exportTimeEvaluationSituationEvent: 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 /hour_bank_engine/events/importEmployeeModuleHBEvent: 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 /hour_bank_engine/events/exportEmployeeModuleHBEvent: 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 /hour_bank_engine/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 /hour_bank_engine/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 /hour_bank_engine/events/importHourBankNoTransferredEntryEvent: 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 /hour_bank_engine/events/exportHourBankNoTransferredEntryEvent: 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: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim compensationLimitType: type: string enum: – DAYS – MONTHS description: Tipo de compensação: * `DAYS` – Dias * `MONTHS` – Meses companyBranchTransferHandleHourBankType: type: string enum: – PAY – DISCOUNT – CANCEL_DEBIT – NOTHING_TO_DO description: Tipo de tratamento para o banco de horas: * `PAY` – Pagar * `DISCOUNT` – Descontar * `CANCEL_DEBIT` – Perdoar * `NOTHING_TO_DO` – Nada a fazer closingType: type: string enum: – DAILY – MONTHLY – PERIOD description: Tipo de fechamento: * `DAILY` – Diário * `MONTHLY` – Mensal * `PERIOD` – Período monthlyClosingType: type: string enum: – FIXED_DAY – PAYROLL_PERIOD – TIME_EVALUATION_PERIOD description: Tipo de fechamento mensal: * `FIXED_DAY` – Dia Fixo * `PAYROLL_PERIOD` – Período da folha de pagamento * `TIME_EVALUATION_PERIOD` – Período do ponto entryType: type: string enum: – C – D description: Tipo de Lançamento: * `C` – Crédito * `D` – Débito 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 databaseOperationType: type: string enum: – INSERT – UPDATE – DELETE description: Operações a serem feitas no banco de dados: * `INSERT` – Inserir * `UPDATE` – Atualizar * `DELETE` – Excluir hourBankEvaluationType: type: string enum: – WHEN_OCCURS – CLOSING description: Tipo de Cálculo: * `WHEN_OCCURS` – Quando ocorrer * `CLOSING` – No Fechamento entryOriginType: type: string enum: – TIME_EVALUATION – EARLY_ALLOWANCE – TYPED – EVENT_GENERATION – CANCEL_DEBIT – OTHER – RULE – COMPANY_BRANCH_TRANSFER – MIGRATION – EARLY_DISCOUNT description: Tipo de origem de lançamento do banco de horas: * `TIME_EVALUATION` – Apuração * `EARLY_ALLOWANCE` – Abono Antecipado * `TYPED` – Digitado * `EVENT_GENERATION` – Geração de eventos * `CANCEL_DEBIT` – Anular débito * `OTHER` – Outros * `RULE` – Regra * `COMPANY_BRANCH_TRANSFER` – Transferência de filial * `MIGRATION` – Migração * `EARLY_DISCOUNT` – Desconto Antecipado changeType: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 description: Indicador de alteração do dia por programação/histórico: * `V1` – Programação de troca de horário * `V2` – Programação de troca de escala * `V3` – Programação de pontes * `V4` – Programação de compensação * `V5` – Programação de autorização de horas extras * `V6` – Programação de autorização de saídas * `V7` – Programação de projeção de horário * `V8` – Histórico de afastamentos * `V9` – Histórico de escala * `V10` – Histórico de filial * `V11` – Programação de troca de rateio * `V12` – Sobreaviso/Prontidão workscheduleDefinitionType: type: string enum: – NORMAL – DAYOFF – HOLIDAY – OFFSET – DSR description: Tipo de Horário: * `NORMAL` – Normal * `DAYOFF` – Folga * `HOLIDAY` – Feriado * `OFFSET` – Compensado * `DSR` – DSR usingType: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V9 – V12 – V13 – V14 description: Uso da marcação: * `V1` – Entrada ou saída obrigatória * `V2` – Entrada ou saída não obrigatória * `V3` – Entrada ou saída gerada * `V4` – Refeição obrigatória * `V5` – Refeição pré-assinalada não obrigatória * `V6` – Refeição obrigatória, extra * `V9` – Refeição pré-assinalada gerada * `V12` – Lanche obrigatório * `V13` – Lanche não obrigatório * `V14` – Lanche obrigatório, extra 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 groupingType: type: string enum: – WORK – ABSENCES – OVERTIME – LEAVE – HOUR_BANK_CREDIT – HOUR_BANK_DEBIT – OTHERS description: Tipo de agrupamento: * `WORK` – Trabalho * `ABSENCES` – Faltas * `OVERTIME` – Horas extras * `LEAVE` – Afastamento * `HOUR_BANK_CREDIT` – Crédito banco de horas * `HOUR_BANK_DEBIT` – Débito banco de horas * `OTHERS` – Outros timeSourceCalculatedType: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 description: Origem do horário apurado: * `V1` – Horário base conforme escala * `V2` – Horário conforme busca automática * `V3` – Programação de ponte * `V4` – Programação de troca de horário * `V5` – Programação de troca de escala * `V6` – Definido pela regra calculationType: type: string enum: – MONTHLY_PAYROLL – ADVANCE_SALARY – THIRTEENTH_SALARY – ADVANCE_THIRTEENTH_SALARY – SUPPLEMENTARY_PAYROLL – SUPPLEMENTARY_LABOR_AGREEMENT – SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL – SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION – SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS – SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL description: Tipo de cálculo: * `MONTHLY_PAYROLL` – Folha mensal * `ADVANCE_SALARY` – Adiantamento salarial * `THIRTEENTH_SALARY` – 13º salário integral * `ADVANCE_THIRTEENTH_SALARY` – Adiantamento 13º salário * `SUPPLEMENTARY_PAYROLL` – Folha complementar * `SUPPLEMENTARY_LABOR_AGREEMENT` – Dissídio complementar * `SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL` – Folha de pagamento de dissídio * `SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION` – Rescisão complementar – Erro ou omissão * `SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS` – Rescisão complementar – Comissões pendentes * `SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL` – Rescisão complementar – Dissídio exceptionType: type: string enum: – V1 – V2 – V3 description: Tipo de exceção: * `V1` – Filial * `V2` – Cargo * `V3` – Vínculo 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 fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error evaluatedEventDTO: description: Evento gerado pelo banco de horas type: object required: – quantity – employeeId – eventId properties: quantity: type: number format: double description: Quantidade employeeId: type: string description: Id do colaborador eventId: type: string description: Id do event employeeCompanyTransferHourBankData: description: Dto da transference de empresa type: object required: – processId – previousEmployee – newEmployee – transferDate properties: processId: type: string maxLength: 36 description: Log da transferência previousEmployee: type: object allOf: – #/definitions/employeeCompanyDTO description: Colaborador origem newEmployee: type: object allOf: – #/definitions/employeeCompanyDTO description: Colaborador destino transferDate: type: string format: date description: Data de transferência handleHourBank: type: string allOf: – #/definitions/companyBranchTransferHandleHourBankType description: Tipo de tratamento para o banco de horas undoEmployeeCompanyTransferHourBankData: description: Dto da transference de empresa type: object required: – processId – previousEmployee – newEmployee – transferDate properties: processId: type: string maxLength: 36 description: Log da transferência previousEmployee: type: object allOf: – #/definitions/employeeCompanyDTO description: Colaborador origem newEmployee: type: object allOf: – #/definitions/employeeCompanyDTO description: Colaborador destino transferDate: type: string format: date description: Data de transferência employeeCompanyDTO: description: Colaborador com empresa type: object required: – employeeId – companyId properties: employeeId: type: string maxLength: 36 description: Id do colaborador companyId: type: string maxLength: 36 description: Id da empresa 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 processBatchInfoDTO: description: DTO com as informações do processo assincrono type: object required: – processId – batchId properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do bloco preFetch: type: boolean description: Pré carregado default: false reevaluateParams: description: Parâmetros do recálculo do banco de horas type: object required: – hourBankId – isDeleteIntegrationEntries – isCreateEvaluationEntries properties: hourBankId: type: string maxLength: 36 description: Id do banco de horas isDeleteIntegrationEntries: type: boolean description: É para excluir os lançamentos de integração isCreateEvaluationEntries: type: boolean description: É para recriar os lançamentos da apuração considerDismissed: type: boolean description: Considerar demitidos default: true employeeIdDTO: description: Colaborador type: object required: – id – company properties: id: type: string maxLength: 36 description: Id do colaborador company: type: object allOf: – #/definitions/companyIdDTO description: Empresa do colaborador companyIdDTO: description: Empresa type: object required: – id properties: id: type: string maxLength: 36 description: Id da empresa hourBankEntryChangeMaintenanceDTO: description: DTO com o lançamento e a operação dele para o recálculo do banco de horas type: object required: – hourBankEntry – operation properties: hourBankEntry: type: object allOf: – #/definitions/hourBankEntryMaintenanceDTO description: Lançamento do banco de horas operation: type: string allOf: – #/definitions/databaseOperationType description: Operação hourBankEntryMaintenanceDTO: description: DTO do lançamento do banco de horas type: object required: – employee – hourBank – origin – date – situation – numberHours – numberHoursToCompensate properties: id: type: string description: Identificador único employee: type: object allOf: – #/definitions/employeeDTO description: Colaborador hourBank: type: object allOf: – #/definitions/hourBankDTO description: Banco de Horas origin: type: string allOf: – #/definitions/entryOriginType description: Origem do lançamento signal: type: string allOf: – #/definitions/entryType description: Sinal do lançamento date: type: string format: date description: Data do lançamento situation: type: object allOf: – #/definitions/situationDTO description: Situação do lançamento numberHours: type: integer format: int64 description: Número de horas em minutos numberHoursToCompensate: type: integer format: int64 description: Número de horas para compensar em minutos generationCompetence: type: string format: date description: Competência da geração resetHourBankAccountDTO: description: DTO com as configurações para resetar o banco de horas de um período type: object required: – employeeId – startDate – endDate – hourBankId – processId – batchId properties: employeeId: type: string description: Identificador único do colaborador startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final hourBankId: type: string description: Identificador único do banco de horas processId: type: string description: Identificador único do processo batchId: type: string description: Identificador único do bloco hourBankDTO: description: DTO do banco de horas type: object required: – id properties: id: type: string description: Identificador único employeeDTO: description: DTO do colaborador type: object required: – id properties: id: type: string description: Identificador único situationDTO: description: DTO da situação type: object required: – id – code properties: id: type: string description: Identificador único code: type: integer format: int64 description: Código integrationDefinition: description: Definição de integração type: object required: – company properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: integrationDefinitionGeneral: description: Definição da geração de eventos geral type: object required: – integrationDefinitionCompetence – generateAdmittedPeriod – generateDismissedPeriod – integratePendingAdjustment – integratePendingUnverifiedDays – separateMonthlyDSR properties: id: type: string format: uuid description: Identificador único integrationDefinitionCompetence: type: object allOf: – #/definitions/integrationDefinitionCompetence description: Competência da definição de integração generateAdmittedPeriod: type: boolean description: Gerar admitidos no período generateDismissedPeriod: type: boolean description: Gerar demitidos no período integratePendingAdjustment: type: boolean description: Integrar com pendências de acerto integratePendingUnverifiedDays: type: boolean description: Integrar com dias não verificados separateMonthlyDSR: type: boolean description: Separar DSR mensalistas overtimeHourBankEvent: type: object allOf: – #/definitions/wageType description: Evento horas extras banco de horas compensatedHourBankEvent: type: object allOf: – #/definitions/wageType description: Evento horas compensadas banco de horas createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: integrationDefinitionCompetence: description: Competência da definição de integração type: object required: – integrationDefinition – initialCompetenceDefinition properties: id: type: string format: uuid description: Identificador único integrationDefinition: type: object allOf: – #/definitions/integrationDefinition description: Definição de integração initialCompetenceDefinition: type: string format: date description: Competência inicial da definição endCompetenceDefinition: type: string format: date description: Competência final da definição (Campo controlado internamente) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string 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 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string 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. hourBankPeriod: description: Período do banco de horas type: object required: – hourBank – startDate properties: id: type: string format: uuid description: Identificador único hourBank: type: object allOf: – #/definitions/hourBank description: Banco de horas startDate: type: string format: date description: Data inicio endDate: type: string format: date description: Data fim hourBankDeadLinesLimits: type: object allOf: – #/definitions/hourBankDeadLinesLimits description: Prazos e limites do banco de horas hourBankDefinition: type: object allOf: – #/definitions/hourBankDefinition description: Definição do banco de horas createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hourBankDeadLinesLimits: description: Prazos e limites do banco de horas type: object required: – creditLimitType – hasCreditLimit – creditClosingType – debitClosingType – debitLimitType – hasDebitLimit – debitTimeout properties: id: type: string format: uuid description: Identificador único hourBankPeriod: type: object allOf: – #/definitions/hourBankPeriod description: Período do banco de horas monthlyClosingType: type: string allOf: – #/definitions/monthlyClosingType description: Tipo de fechamento mensal creditLimitType: type: string allOf: – #/definitions/compensationLimitType description: Tipo de limite para crédito periodCreditLimit: type: integer format: int64 description: Limite do período para crédito hasCreditLimit: type: boolean description: Possui limite para a compensação do crédito creditTimeout: type: integer format: int64 description: Tempo limite para crédito dailyCreditLimit: type: integer format: int64 description: Limite diário para crédito dailyCreditLimitWorkOvertime: type: integer format: int64 description: Limite diário para crédito(Trabalho+extra) dailyCreditLimitOnDayOff: type: integer format: int64 description: Limite diário para crédito(Dias de folga) monthlyCreditLimit: type: integer format: int64 description: Limite mensal para crédito creditClosingType: type: string allOf: – #/definitions/closingType description: Tipo de fechamento para crédito debitClosingType: type: string allOf: – #/definitions/closingType description: Tipo de fechamento para débito debitLimitType: type: string allOf: – #/definitions/compensationLimitType description: Tipo de limite para débito hasDebitLimit: type: boolean description: Possui limite para a compensação do débito debitTimeout: type: integer format: int64 description: Tempo limite para débito dailyDebitLimit: type: integer format: int64 description: Limite diário para débito monthlyDebitLimit: type: integer format: int64 description: Limite mensal para débito periodDebitLimit: type: integer format: int64 description: Limite do período para débito monthlyClosingFixedDay: type: integer format: int64 description: Dia fixo para fechamento minimum: 1 maximum: 31 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hourBankSituation: description: Situações de banco de horas type: object required: – situation – hourBankPeriod – entryType – percentageToHourBank – percentageToClosing properties: id: type: string format: uuid description: Identificador único situation: type: object allOf: – #/definitions/situation description: Situação hourBankPeriod: type: object allOf: – #/definitions/hourBankPeriod description: Período do banco de horas wageType: type: object allOf: – #/definitions/wageType description: Evento entryType: type: string allOf: – #/definitions/entryType description: Tipo de Lançamento percentageToHourBank: type: number format: double description: Porcentagem para banco de horas minimum: 0 percentageToClosing: type: number format: double description: Porcentagem para fechamento de banco de horas minimum: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hourBankDefinition: description: Definição do banco de horas type: object required: – overflowEvaluation – monthlyOverflowEvaluation properties: id: type: string format: uuid description: Identificador único hourBankPeriod: type: object allOf: – #/definitions/hourBankPeriod description: Período do banco de horas overflowEvaluation: type: string allOf: – #/definitions/hourBankEvaluationType description: Cálculo de estouro monthlyOverflowEvaluation: type: string allOf: – #/definitions/hourBankEvaluationType description: Cálculo de estouro mensal createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hourBankEntry: description: Lançamentos do banco de horas type: object required: – employee – hourBank – date – situation – origin – signal – numberHours – estimatedDue 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 date: type: string format: date description: Data de lançamento situation: type: object allOf: – #/definitions/situation description: Situação de lançamento origin: type: string allOf: – #/definitions/entryOriginType description: Origem do lançamento signal: type: string allOf: – #/definitions/entryType description: Sinal do lançamento numberHours: type: integer format: int64 description: Quantidade de horas do lançamento numberHoursToCompensate: type: integer format: int64 description: Quantidade de horas para compensar generationCompetence: type: string format: date description: Competência da geração dueCompetence: type: string format: date description: Competência do vencimento compensationDeadline: type: string format: date description: Data limite para compensar estimatedDue: type: boolean description: Vencimento estimado limitOverflow: type: object allOf: – #/definitions/hourBankLimitOverflow description: Estouro do lançamento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 initialCompetenceEstimated: type: boolean description: Competencia Inicial Estimada default: false finalCompetence: type: string format: date description: Compentencia final finalCompetenceEstimated: type: boolean description: Competencia Final Estimada default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hourBankLimitOverflow: description: Estouro de limite de banco de horas type: object properties: id: type: string format: uuid description: Identificador único entry: type: object allOf: – #/definitions/hourBankEntry description: Lançamento de origem dailyOverflow: type: integer format: int64 description: Quantidade de Horas do estouro diário monthlyOverflow: type: integer format: int64 description: Quantidade de horas do estouro mensal periodOverflow: type: integer format: int64 description: Quantidade de horas do estouro no período do banco createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hourBankCompensation: description: Compensação de banco de horas type: object required: – employee – hourBank – creditEntry – debitEntry 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 creditEntry: type: object allOf: – #/definitions/hourBankEntry description: Lançamentos do banco de horas de crédito debitEntry: type: object allOf: – #/definitions/hourBankEntry description: Lançamentos do banco de horas de débito numberHour: type: integer format: int64 description: Quantidade de horas associadas createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hourBankEmployeeBalance: description: Total do banco de horas por colaborador type: object required: – employee – hourBank – totalBalance 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 totalBalance: type: integer format: int64 description: Saldo total compensationDeadline: type: string format: date description: Data de vencimento dueCompetence: type: string format: date description: Competência de vencimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hourBankCompetenceBalance: description: Saldos de Banco de horas por competência type: object required: – employee – hourBank – initialBalance – finalBalance – minutesToReceive – minutesToDiscount 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 initialBalance: type: integer format: int64 description: Saldo inicial totalBalanceCredit: type: integer format: int64 description: Saldo Total de crédito default: 0 totalBalanceDebit: type: integer format: int64 description: Saldo Total de débito default: 0 finalBalance: type: integer format: int64 description: Saldo final competenceBalance: type: string format: date description: Competência do saldo periodStartDate: type: string format: date description: Data inicial do período periodEndDate: type: string format: date description: Data final do período minutesToReceive: type: integer format: int64 description: Total de minutos a receber no mês minutesToDiscount: type: integer format: int64 description: Total de minutos serem descontados no mês createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: situation: description: Situação type: object required: – code – name – situationType properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Nome x-i18n: true situationType: type: string allOf: – #/definitions/situationType description: Tipo da situaçã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 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. wageTypeTable: description: Tabela de eventos 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 description: Descrição x-i18n: true 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 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. wageType: description: Evento type: object properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código shortName: type: string maxLength: 30 description: Descrição reduzida x-i18n: true wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Tabela de eventos deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: shortName: type: string maxLength: 30 example: pt-BR: shortName: Exemplo de texto usando locale pt-BR. en-US: shortName: Text example using en-US locale. 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 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 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string 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 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: timeEvaluation: description: Apuração type: object required: – employee – timeEvaluationDate properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador timeEvaluationDate: type: string format: date description: Data da apuração workschedule: type: object allOf: – #/definitions/workschedule description: Horário na data lastTimeEvaluationUser: type: string maxLength: 255 description: Usuário da última apuração verifierUser: type: string maxLength: 255 description: Usuário verificador changeType: type: string allOf: – #/definitions/changeType description: Indicador de alteração do dia por programação/histórico hasException: type: boolean description: Tem exceção no dia default: false missingClockingEvent: type: boolean description: Falta marcação no dia default: false timeSourceCalculated: type: string allOf: – #/definitions/timeSourceCalculatedType description: Origem do horário apurado incompleteJourney: type: boolean description: Apurado jornada incompleta default: false timeEvaluationPeriod: type: string format: date description: Competência do cálculo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: type: integer format: int64 description: Entity version for optimistic concurrency control. calculationDefinition: description: Código de cálculo type: object required: – code – calculationType – competence – 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 startDatePayroll: type: string format: date description: Período da folha inicial endDatePayroll: type: string format: date description: Período da folha final 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 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string 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 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 startDatePayroll: type: string format: date description: Período da folha inicial endDatePayroll: type: string format: date description: Período da folha final 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 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: workschedule: description: Horário type: object required: – code – name – workscheduleDefinitionType properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Descrição horário x-i18n: true scheduleType: type: string allOf: – #/definitions/scheduleType description: Tipo de horário workscheduleDefinitionType: type: string allOf: – #/definitions/workscheduleDefinitionType description: Tipo de Horário workload: type: integer format: int64 description: Carga horária\n(Campo gerenciado internamente) 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 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. workscheduleClockingRegister: description: Marcação horário type: object required: – sequenceEvent – usingType – clockingEvent properties: id: type: string format: uuid description: Identificador único workschedule: type: object allOf: – #/definitions/workschedule description: Horário sequenceEvent: type: integer format: int64 description: Sequência da marcação usingType: type: string allOf: – #/definitions/usingType description: Uso da marcação clockingEvent: type: integer format: int64 description: Hora da marcação minimum: 0 maximum: 99999 toleranceBefore: type: integer format: int64 description: Tolerância antes toleranceAfter: type: integer format: int64 description: Tolerância depois clockingEventMobility: type: integer format: int64 description: Mobilidade da marcaçã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 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: timeEvaluationSituation: description: Situação apurada type: object required: – employee – timeEvaluationDate – situation properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador timeEvaluationDate: type: string format: date description: Data apuração situation: type: object allOf: – #/definitions/situation description: Situação numberOfHours: type: integer format: int64 description: Quantidade de horas timeEvaluationPeriod: type: string format: date description: Competência groupingType: type: string allOf: – #/definitions/groupingType description: Tipo de agrupamento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeModuleHB: 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 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070emp: description: Empresa 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 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 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hourBankNoTransferredEntry: description: Lançamento do banco de horas não transferido com a transferência de filial type: object required: – id – employee – hourBank – minutes – situation – entryDate – origin 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 minutes: type: integer format: int64 description: Horas do lançamento em minutos situation: type: object allOf: – #/definitions/situation description: Situação entryDate: type: string format: date description: Data do lançamento origin: type: string allOf: – #/definitions/entryOriginType description: Origem do lançamento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string 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 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. 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 description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string 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 description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string 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 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 description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string 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 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string 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 description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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