2.0info: 2.4.1 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_general 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_general/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_general/queries/listHourBankEntries: post: description: Lançamentos de banco de horas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – hourBankId – competence properties: employeeId: type: string maxLength: 255 description: Identificador do colaborador hourBankId: type: string maxLength: 255 description: Identificador do banco de horas competence: type: string format: date description: Competência responses: 200: description: Ok schema: type: object allOf: – #/definitions/hourBankEntriesResponseDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lançamentos de banco de horas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Identificador do colaborador in: query required: true type: string maxLength: 255 – name: hourBankId description: Identificador do banco de horas in: query required: true type: string maxLength: 255 – name: competence description: Competência in: query required: true type: string format: date responses: 200: description: Ok schema: type: object allOf: – #/definitions/hourBankEntriesResponseDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/getHourBankCompetenceBalance: post: description: Saldo do banco de horas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – competence – page properties: employeeId: type: string maxLength: 255 description: Identificador do colaborador hourBankId: type: string maxLength: 255 description: Identificador do banco de horas competence: type: string format: date description: Competência page: type: object allOf: – #/definitions/pageDTO description: Páginação responses: 200: description: Ok schema: type: object required: – competenceBalances – totalElements – totalPages properties: competenceBalances: type: array items: type: object allOf: – #/definitions/hourBankCompetenceBalanceDTO minimum: 1 description: totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/hourBankMaintenance: post: description: Manutenção do Banco de Horas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competence – page properties: competence: type: string format: date description: Competência page: type: object allOf: – #/definitions/pageDTO description: Páginação filters: type: object allOf: – #/definitions/hourBankMaintenanceFilterDTO description: Filtros orderBy: type: string maxLength: 255 description: Ordenação de campos do objeto de retorno.\nOs campos aceitos são os seguintes:\n- employee.id,\n- employee.name,\n- employee.code,\n- company.id,\n- company.name,\n- company.code,\n- hourBank.id,\n- hourBank.name,\n- hourBank.code.\nA direção de ordenação pode ser definida de modo ascendente ou descendente.\nEx.:\n- Ascendente: employee.name+asc ou apenas employee.name\n- Descendente: employee.name+desc\n responses: 200: description: Ok schema: type: object required: – employeeHourBankSummary – totalElements – totalPages properties: employeeHourBankSummary: type: array items: type: object allOf: – #/definitions/employeeHourBankSummaryDTO minimum: 1 description: Resumo dos saldos de banco de horas por colaborador totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/hourBankPeriodSituationsByPeriod: post: description: Busca as situações do banco de horas válidas em um período separadas por período de configuração do banco de horas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankId – startDate – endDate properties: hourBankId: type: string maxLength: 255 description: Id do banco de horas startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final responses: 200: description: Ok schema: type: object required: – hourBankPeriods properties: hourBankPeriods: type: array items: type: object allOf: – #/definitions/hourBankPeriodSituationsDTO minimum: 1 description: Configurações do banco de horas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as situações do banco de horas válidas em um período separadas por período de configuração do banco de horas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: hourBankId description: Id do banco de horas in: query required: true type: string maxLength: 255 – name: startDate description: Data inicial in: query required: true type: string format: date – name: endDate description: Data final in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – hourBankPeriods properties: hourBankPeriods: type: array items: type: object allOf: – #/definitions/hourBankPeriodSituationsDTO minimum: 1 description: Configurações do banco de horas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/exportHourBank: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/exportHourBankAccount: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/exportHourBankEmployeeBalance: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/exportHourBankCompetenceBalance: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/exportE001pes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/exportEmployeeModule: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/queries/exportEmployeeClockingEvent: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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_general/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_general/actions/saveHourBankPeriod: post: description: Banco de Horas – Salvar períodos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBank – hourBankPeriod properties: hourBank: type: object allOf: – #/definitions/hourBankIdDTO description: Banco de horas hourBankPeriod: type: object allOf: – #/definitions/hourBankPeriodDTO description: Periodos do Banco de horas responses: 200: description: Ok schema: type: object required: – hourBankPeriodId properties: hourBankPeriodId: type: string maxLength: 255 description: id do período do banco de horas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/deleteHourBankPeriod: post: description: Banco de horas – Deletar períodos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankPeriod properties: hourBankPeriod: type: string maxLength: 36 description: Período do banco de horas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/hourBankAccountBatch: post: description: Conta do banco de horas – Inclusão Coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankAccount – filter properties: hourBankAccount: type: object allOf: – #/definitions/hourBankAccountBatchDTO description: DTO das contas do banco de horas filter: type: object allOf: – #/definitions/filterBatchDTO description: Filtro de colaboradores responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/hourBankAccountClosureBatch: post: description: Conta do banco de horas – Fechamento Coletivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankAccountClosure – filter properties: hourBankAccountClosure: type: object allOf: – #/definitions/hourBankAccountClosureDTO description: DTO do fechamento da conta do banco de horas filter: type: object allOf: – #/definitions/filterBatchDTO description: Filtro de colaboradores responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: ID do log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/hourBankAccountBatchDelete: post: description: Contas – Exclusão Coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankAccount – filter properties: hourBankAccount: type: object allOf: – #/definitions/hourBankAccountBatchDTO description: DTO das contas do banco de horas filter: type: object allOf: – #/definitions/filterBatchDTO description: Filtro de colaboradores responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string maxLength: 255 description: ID do log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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_general/actions/importHourBank: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/importHourBankAccount: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/importHourBankEmployeeBalance: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/importHourBankCompetenceBalance: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/importE001pes: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/importEmployeeModule: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/actions/importEmployeeClockingEvent: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/signals/hourBankAccountBatchItem: post: description: Processamento de itens das Contas do banco de horas em lote tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/hourBankAccountBatchDTO description: DTO da conta do banco de horas itens: type: array items: type: object allOf: – #/definitions/employeeIdDTO minimum: 1 description: Colaboradores batchId: type: string maxLength: 36 description: ID do lote summaryId: type: string maxLength: 36 description: ID do log de processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /hour_bank_general/signals/hourBankAccountClosureBatchItem: post: description: Processamento de itens do fechamento das Contas do banco de horas em lote tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/hourBankAccountClosureDTO description: DTO do fechamento da conta do banco de horas itens: type: array items: type: object allOf: – #/definitions/hourBankAccountDTO minimum: 1 description: Contas do banco de horas batchId: type: string maxLength: 255 description: ID do lote summaryId: type: string maxLength: 255 description: ID do log de processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /hour_bank_general/signals/hourBankAccountBatchItemDelete: post: description: Remoção de contas coletivamente tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/hourBankAccountBatchDTO description: DTO das contas do banco de horas itens: type: array items: type: object allOf: – #/definitions/employeeIdDTO minimum: 1 description: Colaboradores batchId: type: string maxLength: 255 description: ID do lote summaryId: type: string maxLength: 255 description: ID do log de processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /hour_bank_general/signals/cancelProcessNotification: post: description: Realiza as ações necessárias ao cancelar um processo. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – processType properties: processId: type: string maxLength: 36 description: Identificador do processo processType: type: string allOf: – #/definitions/processType description: Tipo do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /hour_bank_general/signals/finishedProcessNotification: post: description: Realiza as ações necessárias ao finalizar um processo. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – processType properties: processId: type: string maxLength: 36 description: Identificador do processo processType: type: string allOf: – #/definitions/processType description: Tipo do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /hour_bank_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/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_general/events/importEmployeeModuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hour_bank_general/events/exportEmployeeModuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hour_bank_general/events/importEmployeeClockingEventEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hour_bank_general/events/exportEmployeeClockingEventEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hour_bank_general/apis/hourBankEntry: post: description: Lançamentos de banco de horas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/hourBankEntryFacadeInput responses: 200: description: Ok schema: #/definitions/hourBankEntryFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/apis/hourBankEntry/{id}: put: description: Lançamentos de banco de horas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/hourBankEntryFacadeInput responses: 200: description: Ok schema: #/definitions/hourBankEntryFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Lançamentos de banco de horas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBank: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/hourBank responses: 200: description: The created resource schema: #/definitions/hourBank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/hourBank responses: 200: description: The created resource schema: #/definitions/hourBank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBank/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHourBank responses: 200: description: Ok schema: #/definitions/editHourBank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hourBank responses: 200: description: Ok schema: #/definitions/hourBank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/hourBank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBank/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/hourBank responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankPeriod: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankPeriod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankDeadLinesLimits: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankDeadLinesLimits 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankPeriod/{parentId}/hourBankDeadLinesLimits: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/hourBankDeadLinesLimits responses: 200: description: The created resource schema: #/definitions/hourBankDeadLinesLimits 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/hourBankDeadLinesLimits responses: 200: description: The created resource schema: #/definitions/hourBankDeadLinesLimits 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankDeadLinesLimits 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankPeriod/{parentId}/hourBankDeadLinesLimits/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHourBankDeadLinesLimits responses: 200: description: Ok schema: #/definitions/editHourBankDeadLinesLimits 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hourBankDeadLinesLimits responses: 200: description: Ok schema: #/definitions/hourBankDeadLinesLimits 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/hourBankDeadLinesLimits 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankSituation: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankSituation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankDefinition: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankPeriod/{parentId}/hourBankDefinition: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/hourBankDefinition responses: 200: description: The created resource schema: #/definitions/hourBankDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/hourBankDefinition responses: 200: description: The created resource schema: #/definitions/hourBankDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankPeriod/{parentId}/hourBankDefinition/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHourBankDefinition responses: 200: description: Ok schema: #/definitions/editHourBankDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hourBankDefinition responses: 200: description: Ok schema: #/definitions/hourBankDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/hourBankDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankAccount: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/hourBankAccount responses: 200: description: The created resource schema: #/definitions/hourBankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/hourBankAccount responses: 200: description: The created resource schema: #/definitions/hourBankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankAccount/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHourBankAccount responses: 200: description: Ok schema: #/definitions/editHourBankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hourBankAccount responses: 200: description: Ok schema: #/definitions/hourBankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/hourBankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankAccount/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/hourBankAccount responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankLimitOverflow: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankLimitOverflow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankEntry/{parentId}/limitOverflow: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/hourBankLimitOverflow responses: 200: description: The created resource schema: #/definitions/hourBankLimitOverflow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/hourBankLimitOverflow responses: 200: description: The created resource schema: #/definitions/hourBankLimitOverflow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankLimitOverflow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankEntry/{parentId}/limitOverflow/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHourBankLimitOverflow responses: 200: description: Ok schema: #/definitions/editHourBankLimitOverflow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hourBankLimitOverflow responses: 200: description: Ok schema: #/definitions/hourBankLimitOverflow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/hourBankLimitOverflow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankCompensation: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankCompensation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankEmployeeBalance: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankEmployeeBalance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hour_bank_general/entities/hourBankCompetenceBalance: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hourBankCompetenceBalance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN compensationLimitType: description: Tipo de compensação type: string enum: – DAYS – MONTHS closingType: description: Tipo de fechamento type: string enum: – DAILY – MONTHLY – PERIOD monthlyClosingType: description: Tipo de fechamento mensal type: string enum: – FIXED_DAY – PAYROLL_PERIOD – TIME_EVALUATION_PERIOD entryType: description: Tipo de Lançamento type: string enum: – C – D situationType: description: Tipo da situação 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 hourBankEvaluationType: description: Tipo de Cálculo type: string enum: – WHEN_OCCURS – CLOSING entryOriginType: description: Tipo de origem de lançamento do banco de horas type: string enum: – TIME_EVALUATION – EARLY_ALLOWANCE – TYPED – EVENT_GENERATION – CANCEL_DEBIT – OTHER – RULE – COMPANY_BRANCH_TRANSFER – MIGRATION – EARLY_DISCOUNT processType: description: Tipos de processo type: string enum: – COLLECTIVE_HOUR_BANK_ACCOUNT admissionModuleType: description: Tipo de inscrição do estabelecimento no caso de contratação indireta type: string enum: – HCMHRI – HCMFLX – HCMCEM userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string maxLength: 255 description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status hourBankPeriodDTO: description: DTO do Período do banco de horas type: object required: – startDate – hourBankDeadLinesLimits – hourBankSituation – hourBankDefinition properties: id: type: string maxLength: 255 description: Identificador único startDate: type: string format: date description: Data inicial hourBankDeadLinesLimits: type: object allOf: – #/definitions/hourBankDeadLinesLimitsDTO description: Prazos e Limites hourBankSituation: type: array items: type: object allOf: – #/definitions/hourBankSituationDTO minimum: 1 description: Situações do banco de horas hourBankDefinition: type: object allOf: – #/definitions/hourBankDefinitionDTO description: Definições do Banco de horas hourBankIdDTO: description: DTO do id banco de horas type: object required: – id properties: id: type: string maxLength: 255 description: Identificador único hourBankDTO: description: DTO do Banco de Horas type: object required: – code – name properties: id: type: string maxLength: 255 description: Identificador único code: type: integer format: int64 description: Código name: type: string maxLength: 255 description: Descrição hourBankPeriod: type: object allOf: – #/definitions/hourBankPeriodDTO description: Período do Banco de Hora hourBankDefinition: type: object allOf: – #/definitions/hourBankDefinitionDTO description: Definições do Banco de Horas hourBankSituation: type: object allOf: – #/definitions/hourBankSituationDTO description: Situações do banco de horas hourBankAccountDTO: description: DTO de Contas Banco de Horas type: object required: – createDate – hourBank properties: id: type: string maxLength: 255 description: Identificador único employee: type: object allOf: – #/definitions/employeeIdDTO description: DTO Colaborador createDate: type: string format: date description: Data de Criação extinctionDate: type: string format: date description: Data de Extinção hourBank: type: object allOf: – #/definitions/hourBankDTO description: DTO do Banco de Horas closureDate: type: string format: date description: Data do Fechamento da Conta hourBankDeadLinesLimitsDTO: description: DTO dos prazos e limites do banco de horas type: object required: – hasCreditLimit – hasDebitLimit properties: hourBankPeriod: type: object allOf: – #/definitions/hourBankPeriodDTO description: DTO do período do banco de horas creditLimitType: type: string allOf: – #/definitions/compensationLimitType description: Tipo de limite para crédito hasCreditLimit: type: boolean description: Possui limite para a compensação do 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 minimum: 0 maximum: 999 monthlyClosingType: type: string allOf: – #/definitions/monthlyClosingType description: Tipo de fechamento mensal periodCreditLimit: type: integer format: int64 description: Limite do período para crédito minimum: 0 creditTimeout: type: integer format: int64 description: Tempo limite para crédito minimum: 0 maximum: 999 dailyCreditLimit: type: integer format: int64 description: Limite diário para crédito minimum: 0 dailyCreditLimitWorkOvertime: type: integer format: int64 description: Limite diário para crédito(Trabalho+extra) minimum: 0 dailyCreditLimitOnDayOff: type: integer format: int64 description: Limite diário para crédito(Dias de folga) minimum: 0 monthlyCreditLimit: type: integer format: int64 description: Limite mensal para crédito minimum: 0 dailyDebitLimit: type: integer format: int64 description: Limite diário para débito minimum: 0 monthlyDebitLimit: type: integer format: int64 description: Limite mensal para débito minimum: 0 periodDebitLimit: type: integer format: int64 description: Limite do período para débito minimum: 0 monthlyClosingFixedDay: type: integer format: int64 description: Dia fixo para fechamento minimum: 1 maximum: 31 hourBankSituationDTO: description: DTO da situação do banco de horas type: object required: – situation – entryType – percentageToHourBank – percentageToClosing properties: id: type: string maxLength: 255 description: Identificador único hourBankPeriod: type: object allOf: – #/definitions/hourBankPeriodDTO description: DTO do período do banco de horas situation: type: object allOf: – #/definitions/situationDTO description: Situação wageType: type: object allOf: – #/definitions/wageTypeDTO description: Evento wageTypeTable: type: object allOf: – #/definitions/wageTypeTableDTO description: Tabela de eventos entryType: type: string allOf: – #/definitions/entryType description: Tipo de Lançamento percentageToHourBank: type: number format: double description: Porcentagem para banco de horas percentageToClosing: type: number format: double description: Porcentagem para fechamento de banco de horas hourBankDefinitionDTO: description: DTO da definição do banco de horas type: object required: – overflowEvaluation – monthlyOverflowEvaluation properties: hourBankPeriod: type: object allOf: – #/definitions/hourBankPeriodDTO description: DTO do 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 hourBankAccountBatchDTO: description: Dto para batch da conta do banco de horas type: object required: – hourBank – createDate properties: hourBank: type: string maxLength: 36 description: Banco de horas createDate: type: string format: date description: Data de criação hourBankAccountClosureDTO: description: DTO para batch de fechamento das contas do banco de horas type: object required: – hourBank – extinctionDate properties: hourBank: type: object allOf: – #/definitions/hourBankIdDTO description: DTO do Banco de Horas extinctionDate: type: string format: date description: Data do Fechamento da Conta filterBatchDTO: description: Filtro de batch type: object properties: companies: type: array items: type: string maxLength: 255 description: Empresas employees: type: array items: type: string maxLength: 255 description: Colaboradores employeeIdDTO: description: Identificador do colaborador type: object required: – id – code – companyCode properties: id: type: string maxLength: 255 description: ids do colaborador code: type: integer format: int64 description: Codigo do colaborador companyCode: type: integer format: int64 description: Código da empresa situationDTO: description: Dto da situação type: object required: – id properties: id: type: string maxLength: 36 description: Identificador wageTypeDTO: description: Dto do Evento type: object required: – id properties: id: type: string maxLength: 36 description: Identificador wageTypeTableDTO: description: Dto da Tabela de Evento type: object required: – id properties: id: type: string maxLength: 36 description: Identificador hourBankCompetenceBalanceDTO: description: Saldo de banco de horas do colaborador type: object required: – hourBank – balance properties: hourBank: type: object allOf: – #/definitions/basicDataDTO description: Banco de horas balance: type: object allOf: – #/definitions/competenceBalanceDTO description: Saldos hourBankEntriesResponseDTO: description: Lançamentos de banco de horas do colaborador type: object required: – employee – entries – balance properties: employee: type: object allOf: – #/definitions/genericIdDTO description: Colaborador entries: type: array items: type: object allOf: – #/definitions/hourBankEntryDTO minimum: 1 description: Lista de lançamentos balance: type: array items: type: object allOf: – #/definitions/hourBankCompetenceBalanceDTO minimum: 1 description: Saldos genericIdDTO: description: Identificador de entidades type: object required: – id properties: id: type: string maxLength: 255 description: Identificador employeeBasicDTO: description: Informações básicas do colaborador type: object required: – id – code – company – person properties: id: type: string maxLength: 255 description: Id do Colaborador code: type: integer format: int64 description: Código company: type: object allOf: – #/definitions/basicDataDTO description: Empresa person: type: object allOf: – #/definitions/personDTO description: Pessoa personDTO: description: DTO da pessoa type: object required: – id properties: id: type: string maxLength: 255 description: Identificador único name: type: string maxLength: 255 description: Nome basicDataDTO: description: Dados básicos type: object required: – id – code – name properties: id: type: string maxLength: 255 description: Id code: type: integer format: int64 description: Código name: type: string maxLength: 255 description: Nome balanceDTO: description: DTO do saldo type: object required: – credit – debit – balance properties: credit: type: integer format: int64 description: Total Crédito debit: type: integer format: int64 description: Total Débito balance: type: integer format: int64 description: Saldo competenceBalanceDTO: description: DTO do saldo por competência type: object required: – initialBalance – totalCredit – totalDebit – finalBalance properties: initialBalance: type: integer format: int64 description: Saldo inicial totalCredit: type: integer format: int64 description: Total Crédito totalDebit: type: integer format: int64 description: Total Débito finalBalance: type: integer format: int64 description: Saldo final hourBankEntryDTO: description: DTO dos Lançamentos do banco de horas type: object required: – id – entryDate – situation – entryOrigin – numberHours – entryType – balance properties: id: type: string maxLength: 255 description: Identificador único entryDate: type: string format: date description: Data do lançamento situation: type: object allOf: – #/definitions/basicDataDTO description: Situação do Lançamento entryOrigin: type: string allOf: – #/definitions/entryOriginType description: Origem do Lançamento numberHours: type: integer format: int64 description: Quantidade de horas entryType: type: string allOf: – #/definitions/entryType description: Tipo do Lançamento compensationDeadline: type: string format: date description: Data limite para Compensação balance: type: integer format: int64 description: Saldo hourBankMaintenanceFilterDTO: description: Filtro de busca para a manutenção de banco de horas type: object properties: employeeQuery: type: string maxLength: 255 description: Filtrar pelo código ou nome do colaborador employeeId: type: string maxLength: 255 description: Id do colaborador companyId: type: string maxLength: 255 description: Id da empresa hourBankId: type: string maxLength: 255 description: Id do banco de horas justOpenAccounts: type: boolean description: Apenas contas abertas. Padrão: true default: true employeeHourBankSummaryDTO: description: Resumo dos saldos de banco de horas por colaborador type: object required: – employee – hourBank – balance properties: employee: type: object allOf: – #/definitions/employeeBasicDTO description: Colaborador hourBank: type: object allOf: – #/definitions/basicDataDTO description: Banco de Horas balance: type: object allOf: – #/definitions/balanceDTO description: Saldos pageDTO: description: Paginação type: object required: – offset – size properties: offset: type: integer format: int64 description: Offset minimum: 0 size: type: integer format: int64 description: Size minimum: 1 maximum: 20 hourBankPeriodSituationsDTO: description: Siuações em um período de configuração banco de horas type: object required: – startDate – endDate – creditSituations – debitSituations properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final creditSituations: type: array items: type: object allOf: – #/definitions/basicDataDTO minimum: 1 description: Situações de crédito debitSituations: type: array items: type: object allOf: – #/definitions/basicDataDTO minimum: 1 description: Situações de débito 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 minimum: 1 maximum: 32767 name: type: string maxLength: 255 description: Descrição x-i18n: true createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editHourBank: type: object required: – id allOf: – #/definitions/hourBank 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 maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: hourBankDeadLinesLimits: description: Prazos e limites do banco de horas type: object required: – hasCreditLimit – hasDebitLimit 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 minimum: 0 hasCreditLimit: type: boolean description: Possui limite para a compensação do crédito creditTimeout: type: integer format: int64 description: Tempo limite para crédito minimum: 0 maximum: 999 dailyCreditLimit: type: integer format: int64 description: Limite diário para crédito minimum: 0 dailyCreditLimitWorkOvertime: type: integer format: int64 description: Limite diário para crédito(Trabalho+extra) minimum: 0 dailyCreditLimitOnDayOff: type: integer format: int64 description: Limite diário para crédito(Dias de folga) minimum: 0 monthlyCreditLimit: type: integer format: int64 description: Limite mensal para crédito minimum: 0 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 minimum: 0 maximum: 999 dailyDebitLimit: type: integer format: int64 description: Limite diário para débito minimum: 0 monthlyDebitLimit: type: integer format: int64 description: Limite mensal para débito minimum: 0 periodDebitLimit: type: integer format: int64 description: Limite do período para débito minimum: 0 monthlyClosingFixedDay: type: integer format: int64 description: Dia fixo para fechamento minimum: 1 maximum: 31 createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: editHourBankDeadLinesLimits: type: object required: – id allOf: – #/definitions/hourBankDeadLinesLimits 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 wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Tabela de Eventos 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 maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 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 maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: editHourBankDefinition: type: object required: – id allOf: – #/definitions/hourBankDefinition hourBankEntry: description: Lançamentos do banco de horas type: object required: – employee – hourBank – date – situation – origin – signal – numberHours 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 default: false limitOverflow: type: object allOf: – #/definitions/hourBankLimitOverflow description: Estouro do lançamento createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: 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 maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: editHourBankAccount: type: object required: – id allOf: – #/definitions/hourBankAccount 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 maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: editHourBankLimitOverflow: type: object required: – id allOf: – #/definitions/hourBankLimitOverflow 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 maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: hourBankEmployeeBalance: description: Total do banco de horas por colaborador type: object required: – employee – hourBank – 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 maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: hourBankCompetenceBalance: description: Saldos de Banco de horas por competência type: object required: – employee – hourBank – initialBalance – finalBalance 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 createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: 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 maxLength: 255 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 maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. 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 maxLength: 255 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 maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. 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 maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: 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: – code – person – hireDate properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Cadastro person: type: object allOf: – #/definitions/e001pes description: Pessoa employer: type: object allOf: – #/definitions/e070emp description: Empresa hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de desligamento employeeClockingEvent: type: object allOf: – #/definitions/employeeClockingEvent description: Especialização do colaborador para o ponto deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: e001pes: description: Pessoa type: object required: – nomPes properties: id: type: string format: uuid description: Identificador único nomPes: type: string maxLength: 100 description: Nome numNis: type: string maxLength: 11 description: Número de inscrição do segurado (NIS, NIT e PIS/PASEP) cnpCpf: type: string maxLength: 14 description: CNPJ/CPF excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: 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 maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: employeeModule: description: Modulo do colaborador type: object required: – employee – moduleType properties: id: type: string format: uuid description: Identificador employee: type: object allOf: – #/definitions/employee description: Colaborador moduleType: type: string maxLength: 6 description: Tipo do módulo deleted: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: employeeClockingEvent: description: Especialização do colaborador para o ponto type: object required: – hireCompetence properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador hireCompetence: type: string format: date description: Competência de admissão dismissalCompetence: type: string format: date description: Compentência de demissão createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string maxLength: 255 description: message: type: string maxLength: 255 description: exceptionClass: type: string maxLength: 255 description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string maxLength: 255 description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string maxLength: 255 description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string maxLength: 255 description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string maxLength: 255 description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string maxLength: 255 description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string maxLength: 255 description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string maxLength: 255 description: beanClass: type: string maxLength: 255 description: serviceClass: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string maxLength: 255 description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string maxLength: 255 description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 description: Version of the dependency service hourBankEntryFacadeInput: description: Lançamentos de banco de horas type: object required: – employee – hourBank – date – situation – numberHours properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/genericIdDTO description: Colaborador hourBank: type: object allOf: – #/definitions/genericIdDTO description: Banco de Horas date: type: string format: date description: Data de lançamento situation: type: object allOf: – #/definitions/genericIdDTO description: Situação de lançamento numberHours: type: integer format: int64 description: Quantidade de horas do lançamento minimum: 0 hourBankEntryFacadeOutput: description: Lançamentos de banco de horas type: object required: – id – employee – hourBank – date – situation – signal – numberHours properties: id: type: string maxLength: 255 description: Identificador único employee: type: object allOf: – #/definitions/genericIdDTO description: Colaborador hourBank: type: object allOf: – #/definitions/genericIdDTO description: Banco de Horas date: type: string format: date description: Data de lançamento situation: type: object allOf: – #/definitions/genericIdDTO description: Situação de 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 genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE