2.0info: 2.2.0 HCM – Contract Employment Contract Processor description: HCM – Contract Employment Contract Processor x-senior-domain: HCM – Contract Employment Contract Processor x-senior-domain-path: hcm_contract x-senior-service-path: employment_contract_processor 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_contractsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /employment_contract_processor/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 /employment_contract_processor/queries/getCurrentWorkShiftByEmployeeId: post: description: Busca o id da escala atual do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string maxLength: 36 description: Id do colaborador responses: 200: description: Ok schema: type: object required: – workShiftId properties: workShiftId: type: string maxLength: 36 description: Id da escala atual do do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o id da escala atual do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Id do colaborador in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – workShiftId properties: workShiftId: type: string maxLength: 36 description: Id da escala atual do do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/employeeHistoryByPeriod: post: description: Recupera os histórico do colaborador no periodo informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – startDate – endDate properties: employee: type: string maxLength: 36 description: Colaborador startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final responses: 200: description: Ok schema: type: object required: – badgeHistories – companyBranchHistories – syndicateHistories – employmentRelationshipHistories – workshiftHistories – jobPositionHistories properties: badgeHistories: type: array items: type: object allOf: – #/definitions/badgeHistoryDTO minimum: 1 description: Histórico de cracha companyBranchHistories: type: array items: type: object allOf: – #/definitions/companyBranchHistoryDTO minimum: 1 description: Histórico de filial syndicateHistories: type: array items: type: object allOf: – #/definitions/syndicateHistoryDTO minimum: 1 description: Histórico de sindicato employmentRelationshipHistories: type: array items: type: object allOf: – #/definitions/employmentRelationshipHistoryDTO minimum: 1 description: Histórico de vinculo workshiftHistories: type: array items: type: object allOf: – #/definitions/workshiftHistoryDTO minimum: 1 description: Histórico de escala jobPositionHistories: type: array items: type: object allOf: – #/definitions/jobPositionHistoryDTO minimum: 1 description: Histórico de posto de trabalho 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera os histórico do colaborador no periodo informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Colaborador in: query required: true type: string maxLength: 36 – 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: – badgeHistories – companyBranchHistories – syndicateHistories – employmentRelationshipHistories – workshiftHistories – jobPositionHistories properties: badgeHistories: type: array items: type: object allOf: – #/definitions/badgeHistoryDTO minimum: 1 description: Histórico de cracha companyBranchHistories: type: array items: type: object allOf: – #/definitions/companyBranchHistoryDTO minimum: 1 description: Histórico de filial syndicateHistories: type: array items: type: object allOf: – #/definitions/syndicateHistoryDTO minimum: 1 description: Histórico de sindicato employmentRelationshipHistories: type: array items: type: object allOf: – #/definitions/employmentRelationshipHistoryDTO minimum: 1 description: Histórico de vinculo workshiftHistories: type: array items: type: object allOf: – #/definitions/workshiftHistoryDTO minimum: 1 description: Histórico de escala jobPositionHistories: type: array items: type: object allOf: – #/definitions/jobPositionHistoryDTO minimum: 1 description: Histórico de posto de trabalho 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/employeesHistoriesByPeriod: post: description: Recupera os histórico da lista decolaboradores no periodo informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employees properties: employees: type: array items: type: object allOf: – #/definitions/employeesPeriodDTO minimum: 1 description: Colaboradores responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/employeeHistoriesDTO minimum: 1 description: Históricos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/employeesTimeEvaluation: post: description: Busca os colaborador admitidos no período, paginado e ordenado por ids tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters – offset – size properties: startDate: type: string format: date description: Data de início do cálculo endDate: type: string format: date description: Data final do cálculo considerDismissed: type: boolean description: Considera ou descartar os demitidos nesta data. default: false filters: type: object allOf: – #/definitions/filterEmployeesTimeEvaluation description: Filtro de colaboradores para a apuração do ponto offset: type: integer format: int64 description: início da paginação size: type: integer format: int64 description: Final da paginação responses: 200: description: Ok schema: type: object required: – employees properties: employees: type: array items: type: object allOf: – #/definitions/employeeIdDTO minimum: 1 description: Lista de contratos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/employeesTimeEvaluationTrusted: post: description: Busca os colaborador admitidos no período, paginado e ordenado por ids sem usuário logado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters – offset – size properties: startDate: type: string format: date description: Data de início do cálculo endDate: type: string format: date description: Data final do cálculo considerDismissed: type: boolean description: Considera ou descartar os demitidos nesta data. default: false filters: type: object allOf: – #/definitions/filterEmployeesTimeEvaluation description: Filtro de colaboradores para a apuração do ponto offset: type: integer format: int64 description: início da paginação size: type: integer format: int64 description: Final da paginação responses: 200: description: Ok schema: type: object required: – employees properties: employees: type: array items: type: object allOf: – #/definitions/employeeIdDTO minimum: 1 description: Lista de contratos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/employeesTimeEvaluationCount: post: description: Busca os colaborador admitidos no período, paginado e ordenado por ids tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters properties: startDate: type: string format: date description: Data de início do cálculo endDate: type: string format: date description: Data final do cálculo considerDismissed: type: boolean description: Considera ou descartar os demitidos nesta data. default: false filters: type: object allOf: – #/definitions/filterEmployeesTimeEvaluation description: Filtro de colaboradores para a apuração do ponto responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Quantidade de colaboradores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/findActiveEmployeesByPeriod: post: description: Busca os colaboradores ativos no período, paginado e ordenado por ids tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – filters – offset – size properties: startDate: type: string format: date description: Data de início do cálculo endDate: type: string format: date description: Data final do cálculo considerDismissed: type: boolean description: Considera ou descartar os demitidos nesta data. default: false filters: type: object allOf: – #/definitions/employeeFilterBatchProcess description: Filtro de colaboradores para processo coletivo offset: type: integer format: int64 description: início da paginação size: type: integer format: int64 description: Final da paginação responses: 200: description: Ok schema: type: object required: – employees properties: employees: type: array items: type: object allOf: – #/definitions/employeeIdDTO minimum: 1 description: Lista de contratos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/countActiveEmployeesByPeriod: post: description: Conta a quantidade de colaboradores ativos no período, paginado e ordenado por ids tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – filters properties: startDate: type: string format: date description: Data de início do cálculo endDate: type: string format: date description: Data final do cálculo considerDismissed: type: boolean description: Considera ou descartar os demitidos nesta data. default: false filters: type: object allOf: – #/definitions/employeeFilterBatchProcess description: Filtro de colaboradores para processo coletivo responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Quantidade de colaboradores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/findEmployeeByEmployerCodeContractTypeCodeBatch: post: description: Endpoint de teste para buscar os colaboradores pelo número da empresa, tipo do contrato e código do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – antiqueEmployeeIds properties: antiqueEmployeeIds: type: array items: type: object allOf: – #/definitions/employeeTestDTO minimum: 1 description: Lista de DTOs com o número da empresa, tipo do contrato e código do colaborador responses: 200: description: Ok schema: type: object required: – employees properties: employees: type: array items: type: object allOf: – #/definitions/employeeIdTestDTO minimum: 1 description: ID dos colaboradores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/findBadgeHistoryByEmployeeIds: post: description: Endpoint de teste para buscar os históricos de crachá pelos IDs dos colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeIds properties: employeeIds: type: array items: type: string minimum: 1 description: Ids do colaboradores responses: 200: description: Ok schema: type: object required: – badges properties: badges: type: array items: type: object allOf: – #/definitions/badgeHistoryDTO minimum: 1 description: Crachás 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoint de teste para buscar os históricos de crachá pelos IDs dos colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeIds description: Ids do colaboradores in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – badges properties: badges: type: array items: type: object allOf: – #/definitions/badgeHistoryDTO minimum: 1 description: Crachás 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/findEmployeesOrEmployersByFilters: post: description: Endpoint para encontrar códigos de colaboradores ou empresas pelos filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: companies: type: array items: type: string description: Ids das empresas employees: type: array items: type: string description: Ids dos colaboradores advancedFilterId: type: string description: Identificação do filtro avançado responses: 200: description: Ok schema: type: object properties: companies: type: array items: type: integer format: int64 description: Códigos das empresas employees: type: array items: type: object allOf: – #/definitions/employeeSummaryDTO description: Códigos dos colaboradores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoint para encontrar códigos de colaboradores ou empresas pelos filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: companies description: Ids das empresas in: query type: array items: type: string – name: employees description: Ids dos colaboradores in: query type: array items: type: string – name: advancedFilterId description: Identificação do filtro avançado in: query type: string responses: 200: description: Ok schema: type: object properties: companies: type: array items: type: integer format: int64 description: Códigos das empresas employees: type: array items: type: object allOf: – #/definitions/employeeSummaryDTO description: Códigos dos colaboradores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/findCompanyDataByEmployeesOrCompaniesIds: post: description: Endpoint para encontrar empresas à partir de uma lista de colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: employees: type: array items: type: string description: Ids dos colaboradores companies: type: array items: type: string description: Ids das empresas modulesTypes: type: array items: type: string allOf: – #/definitions/admissionModuleType description: Filtra os módulos pelo tipo responses: 200: description: Ok schema: type: object properties: companies: type: array items: type: object allOf: – #/definitions/companyData description: Lista de dtos com os dados das empresas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/countEmployeeForMobilidade: post: description: Contar a quantidade de colaboradores que tiveram os dados alterados no período informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filterEmployeeForMobile properties: filterEmployeeForMobile: type: object allOf: – #/definitions/filterEmployeeForMobileDTO description: Filtro de informações serão gerado via OR entre os filtros, NÃO SÃO RESTRITIVOS responses: 200: description: Ok schema: type: object required: – total properties: total: type: integer format: int64 description: Total records 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/findEmployeeForMobilidade: post: description: Buscar a lista de colaboradores que tiveram os dados alterados no período informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page properties: summaryId: type: string maxLength: 36 description: Identificador do processo. filterEmployeeForMobile: type: object allOf: – #/definitions/filterEmployeeForMobileDTO description: Filtro de informações serão gerado via OR entre os filtros, NÃO SÃO RESTRITIVOS page: type: object allOf: – #/definitions/pageDTO description: Páginação responses: 200: description: Ok schema: type: object required: – employees – employeesIdsWithErrors properties: employees: type: array items: type: object allOf: – #/definitions/employeeForMobilidadeDTO minimum: 1 description: Colaboradores employeesIdsWithErrors: type: array items: type: string minimum: 1 description: Colaboradores com erros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/countEmployeesByAEJ: post: description: Conta a quantidade de colaboradores filtrando histórico no período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final filters: type: object allOf: – #/definitions/filterEmployeeForAEJReportDTO description: Filtro responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Quantidade de colaboradores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/getEmployeesByAEJ: post: description: Recupera dados de colaboradores filtrando histórico no período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters – page properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final filters: type: object allOf: – #/definitions/filterEmployeeForAEJReportDTO description: Filtro page: type: object allOf: – #/definitions/pageAEJDTO description: Páginação responses: 200: description: Ok schema: type: object required: – employees properties: employees: type: array items: type: object allOf: – #/definitions/employeeDataForAEJReportDTO minimum: 1 description: Colaboradores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/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 /employment_contract_processor/actions/employeeHistoriesByPeriodToCache: post: description: Carrega os históricos dos colaboradores para a cache da apuração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employees – startDate – endDate – processBatchInfo properties: employees: type: array items: type: object allOf: – #/definitions/genericId minimum: 1 description: Lista de Id dos Colaboradores startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final processBatchInfo: type: object allOf: – #/definitions/processBatchInfoDTO description: Informações do processo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_contract_processor/signals/selectEmployee: post: description: Seleciona os colaboradores pertencentes aos filtros. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Id do processo calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo company: type: object allOf: – #/definitions/companyData description: Informações referentes à empresa calculationDefinitionData: type: object allOf: – #/definitions/calculationDefinitionData description: Informações referentes ao código cálculo logDebugEnabled: type: boolean description: Log de depuração habilitado default: false employmentRelationshipId: type: array items: type: string description: Identificador único do vínculo employees: type: array items: type: string description: Lista de colaboradores monitorEnabled: type: boolean description: Monitor habilitado default: false startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final disregardedDays: type: array items: type: string format: date description: Dias a desconsiderar hiredInTheYearWithBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano com saldo de férias hiredInTheYearWithoutBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano sem saldo de férias filters: type: object allOf: – #/definitions/filtersDTO description: Filtros responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_contract_processor/signals/consolidateEmployee: post: description: Inicia o cálculo da Folha de um lote de colaboradores tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – batchDescription properties: processId: type: string description: Id do processo batchId: type: string description: Id do lote de colaboradores company: type: object allOf: – #/definitions/companyData description: Informações referentes à empresa calculationDefinitionData: type: object allOf: – #/definitions/calculationDefinitionData description: Informações referentes ao código de cálculo batchDescription: type: string description: Descrição logDebugEnabled: type: boolean description: Log de depuração habilitado default: false monitorEnabled: type: boolean description: Monitor habilitado default: false calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final disregardedDays: type: array items: type: string format: date description: Dias a desconsiderar hiredInTheYearWithBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano com saldo de férias hiredInTheYearWithoutBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano sem saldo de férias responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_contract_processor/signals/consolidateLayout: post: description: Solicitar informações tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – layout – layoutReference properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote de colaboradores layout: type: integer format: int64 description: Leiaute layoutReference: type: array items: type: object allOf: – #/definitions/layoutReference minimum: 1 description: Referência para o leiaute responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_contract_processor/signals/employeeHistoriesLoadHourBankReevaluate: post: description: Carrega os histórico dos colaboradores para o recálculo do banco de horas tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – hourBankReevaluateDTO properties: hourBankReevaluateDTO: type: object allOf: – #/definitions/hourBankReevaluateDTO description: Dados para o recálculo do banco de horas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_contract_processor/signals/employeeHistoriesLoadHourBankClosure: post: description: Carrega os histórico dos colaboradores para o fechamento do banco de horas tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – hourBankClosureDTO properties: hourBankClosureDTO: type: object allOf: – #/definitions/hourBankClosureDTO description: Dados para o fechamento do banco de horas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_contract_processor/events/employeeConsolidationFinished: post: description: Finaliza a consolidação de informações do colaborador x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – batchDescription properties: processId: type: string description: Id do processo. batchId: type: string description: Id do lote de colaboradores company: type: object allOf: – #/definitions/companyData description: Informações referentes à empresa calculationDefinitionData: type: object allOf: – #/definitions/calculationDefinitionData description: Informações referentes ao código de cálculo batchDescription: type: string description: Descrição logDebugEnabled: type: boolean description: Log de depuração habilitado default: false collectiveNegotiationIdList: type: array items: type: string description: Lista de identificador único dos históricos de cadastro de sindicato positionIdList: type: array items: type: string description: Lista de identificador único das posições jobPositionList: type: array items: type: string description: Lista de identificado único dos cargos monitorEnabled: type: boolean description: Monitor habilitado default: false calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final disregardedDays: type: array items: type: string format: date description: Dias a desconsiderar hiredInTheYearWithBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano com saldo de férias hiredInTheYearWithoutBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano sem saldo de férias responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_contract_processor/events/layoutConsolidationFinished: post: description: Evento de comunicação que a consolidação do leiaute foi finalizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId properties: processId: type: string description: Id do processo batchId: type: string description: Id do lote de colaboradores errorMessage: type: string description: Mensagem de erro urlData: type: string description: Link dos dados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_contract_processor/events/selectEmployeeFinished: post: description: Finaliza seleção participantes. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – company – calculationDefinitionData properties: processId: type: string maxLength: 36 description: Id do processo company: type: object allOf: – #/definitions/companyData description: Informações referentes à empresa calculationDefinitionData: type: object allOf: – #/definitions/calculationDefinitionData description: Informações referentes ao código de cálculo logDebugEnabled: type: boolean description: Log de depuração habilitado default: false monitorEnabled: type: boolean description: Monitor habilitado default: false responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_contract_processor/events/selectEmployeeVacationFinished: post: description: Finaliza seleção participantes para cálculo de férias. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Id do processo calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo logDebugEnabled: type: boolean description: Log de depuração habilitado default: false monitorEnabled: type: boolean description: Monitor habilitado default: false startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final disregardedDays: type: array items: type: string format: date description: Dias a desconsiderar hiredInTheYearWithBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano com saldo de férias hiredInTheYearWithoutBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano sem saldo de férias filters: type: object allOf: – #/definitions/filtersDTO description: Filtros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_contract_processor/events/employeeTimeEvaluationContractFinished: post: description: Finalizado carregamento do colaborador para apuração x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – employees – payloadParams properties: processId: type: string description: Id do processo. batchId: type: string description: Id do lote de colaboradores employees: type: array items: type: object allOf: – #/definitions/employeesPeriodDTO minimum: 1 description: Payload payloadParams: type: string description: Payload dos parâmetros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_contract_processor/events/employeeHistoriesLoadHourBankReevaluateFinished: post: description: Finaliza o carregamento dos histórico dos colaboradores para o recálculo do banco de horas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – hourBankReevaluateDTO properties: hourBankReevaluateDTO: type: object allOf: – #/definitions/hourBankReevaluateDTO description: Dados para o recálculo do banco de horas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_contract_processor/events/employeeHistoriesLoadHourBankClosureFinished: post: description: Finaliza o carregamento dos histórico dos colaboradores para o fechamento do banco de horas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – hourBankClosureDTO properties: hourBankClosureDTO: type: object allOf: – #/definitions/hourBankClosureDTO description: Dados para o fechamento do banco de horas responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN calculationType: description: Tipo de cálculo type: string enum: – MONTHLY_PAYROLL – ADVANCE_SALARY – THIRTEENTH_SALARY – ADVANCE_THIRTEENTH_SALARY – INDIVIDUAL_VACATION – COLLECTIVE_VACATION – DISMISSAL – SUPPLEMENTARY_PAYROLL badgeType: description: Tipo de Crachá type: string enum: – HOLDER – PROVISIONAL contractType: description: Tipo de contrato type: string enum: – EMPLOYEE – DIRECTOR – TRAINEE – APRENTICE – THIRD_PARTY verifiedDaysType: description: Tipo de dias verificados type: string enum: – ALL_DAYS – ONLY_VERIFIED_DAYS – ONLY_UNVERIFIED_DAYS generateNegativeType: description: Tipo de geração negativa type: string enum: – YES – NO – VACATION_PREMIUM hiredInTheYearType: description: Tipo de admitidos no ano type: string enum: – NEGATIVE_BALANCE_PERIOD – PAID_LEAVE – PAY_ENTITLEMENT_VACATION_DAYS – ENDS_PERIOD_REGARDLESS_BALANCE hourBankClosureType: description: Tipo de fechamento de banco de horas type: string enum: – MONTHLY_CLOSE – ANTICIPATE_ALLOWANCE – CANCEL_DEBIT – ANTICIPATE_DISCOUNT admissionModuleType: description: Tipo de inscrição do estabelecimento no caso de contratação indireta type: string enum: – HCMHRI – HCMFLX – HCMCEM – HCMSF – HCMGRS – HCMAMP timeShiftType: description: Turno do horário type: string enum: – FIRSTSHIFT – SECONDSHIFT – THIRDSHIFT – FOURTHSHIFT – MIXEDDAYTIME – MIXEDNIGHTTIME – GENERAL hiredInCurrentYearType: description: Admitidos no ano type: string enum: – CURRENT_ACQUISITIVE_PERIOD_REMAINS_OPEN – OPEN_NEW_ACQUISITIVE_PERIOD 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 employeeSummaryDTO: description: DTO de resumo do colaborador type: object required: – companyCode – employeeCode properties: companyCode: type: integer format: int64 description: Código da empresa employeeCode: type: integer format: int64 description: Código do colaborador checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status companyData: description: Dados da empresa type: object required: – id – code – description properties: id: type: string maxLength: 36 description: Id code: type: integer format: int64 description: Código description: type: string description: Nome companyBranchData: description: Dados da filial type: object required: – id – code – description properties: id: type: string maxLength: 36 description: Id code: type: integer format: int64 description: Código description: type: string description: Nome calculationDefinitionData: description: Dados do código de cálculo type: object required: – id – code – competence – calculationType – paymentDate properties: id: type: string maxLength: 36 description: Id code: type: integer format: int64 description: Código competence: type: string format: date description: Competência calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo paymentDate: type: string format: date description: Data de pagamento startDatePayroll: type: string format: date description: Período da folha inicial endDatePayroll: type: string format: date description: Período da folha final advanceThirteenthSalaryPercentage: type: number format: double description: % adiantamento 13º badgeHistoryDTO: description: Histórico de cracha type: object required: – id – employeeId – badgeType – badge – startDate properties: id: type: string maxLength: 36 description: Identificador único employeeId: type: string maxLength: 36 description: Identificador do colaborador badgeType: type: string allOf: – #/definitions/badgeType description: Tipo de Crachá badge: type: integer format: int64 description: Crachá startDate: type: string format: date description: Data inicial startTime: type: integer format: int64 description: Hora inicial minimum: 0 maximum: 1439 default: 0 endDate: type: string format: date description: Data final endTime: type: integer format: int64 description: Hora final (Caso uma data final seja definida, o valor padrão desse campo passa a ser 1439) minimum: 0 maximum: 1439 companyBranchHistoryDTO: description: Histórico de filial type: object required: – id – employeeId – startDate – endDate – companyBranch – company – employee properties: id: type: string maxLength: 36 description: Identificador único employeeId: type: string maxLength: 36 description: Identificador do colaborador startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final companyBranch: type: integer format: int64 description: Filial company: type: integer format: int64 description: Empresa employee: type: integer format: int64 description: Colaborador syndicateHistoryDTO: description: Histórico de sindicato DTO type: object required: – id – employeeId – syndicateCode – collectiveNegotiationId – collectiveNegotiationCode – startDate – endDate properties: id: type: string maxLength: 36 description: Identificador único employeeId: type: string maxLength: 36 description: Identificador do colaborador syndicateCode: type: integer format: int64 description: Código do sindicato collectiveNegotiationId: type: string maxLength: 36 description: ID da Negociação coletiva collectiveNegotiationCode: type: integer format: int64 description: Código da Negociação coletiva startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final employmentRelationshipHistoryDTO: description: Histórico de vinculo DTO type: object required: – id – employeeId – startDate – endDate – employmentRelationship properties: id: type: string maxLength: 36 description: Identificador único employeeId: type: string maxLength: 36 description: Identificador do colaborador startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final employmentRelationship: type: string description: Vínculo empregatício workshiftHistoryDTO: description: Histórico de escala DTO type: object required: – id – employeeId – startDate – endDate – workshift – workshiftGroup properties: id: type: string maxLength: 36 description: Identificador único employeeId: type: string maxLength: 36 description: Identificador do colaborador startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data de término workshift: type: integer format: int64 description: Escala workshiftGroup: type: integer format: int64 description: Turma da escala jobPositionHistoryDTO: description: DTO para a busca de históricos do colaborador type: object required: – id – employeeId – startDate – endDate – jobPositionCode – jobPositionStructureCode properties: id: type: string maxLength: 36 description: Identificador único employeeId: type: string maxLength: 36 description: Identificador do colaborador startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data de término jobPositionCode: type: integer format: int64 description: Código do cargo jobPositionStructureCode: type: integer format: int64 description: Código da estrutura de cargo filterEmployeesTimeEvaluation: description: Filtro de colaboradores para a apuração do ponto type: object properties: companies: type: array items: type: string description: ids da empresa employees: type: array items: type: string description: ids dos colaboradores modulesTypes: type: array items: type: string allOf: – #/definitions/admissionModuleType description: Filtra os módulos pelo tipo advancedFilterId: type: string description: Identificado do filtro avançado employeeFilterBatchProcess: description: Filtro de colaborador para processo em lote type: object properties: companies: type: array items: type: string description: ids da empresa employees: type: array items: type: string description: ids dos colaboradores advancedFilterId: type: string description: Identificador do filtro avançado employeeIdDTO: description: Identificado do colaborador type: object required: – id – code – companyId – companyCode properties: id: type: string description: ids do colaborador code: type: integer format: int64 description: Código do colaborador companyId: type: string description: Id da empresa companyCode: type: integer format: int64 description: Código da empresa employeeTestDTO: description: DTO do colaborador para os testes parametrizados type: object required: – code – contractType – companyCode properties: code: type: integer format: int64 description: Código do colaborador contractType: type: string allOf: – #/definitions/contractType description: Tipo do contrato companyCode: type: integer format: int64 description: Código da empresa employeeIdTestDTO: description: DTO do colaborador para os testes parametrizados com id do colaborador type: object required: – id – code – contractType – companyCode properties: id: type: string description: Id do colaborador code: type: integer format: int64 description: Código do colaborador contractType: type: string allOf: – #/definitions/contractType description: Tipo do contrato companyCode: type: integer format: int64 description: Código da empresa employeesPeriodDTO: description: Colaboradores com período type: object required: – employee – startDate – endDate properties: employee: type: string description: Colaborador startDate: type: string format: date description: Data Inicial endDate: type: string format: date description: Data Final employeeHistoriesDTO: description: Históricos do colaborador type: object required: – employee – startDate – endDate – histories properties: employee: type: string description: Colaborador startDate: type: string format: date description: Data Inicial endDate: type: string format: date description: Data Final histories: type: object allOf: – #/definitions/historiesDTO description: Históricos historiesDTO: description: Históricos type: object required: – badgeHistories – companyBranchHistories – syndicateHistories – employmentRelationshipHistories – workshiftHistories – jobPositionHistories properties: badgeHistories: type: array items: type: object allOf: – #/definitions/badgeHistoryDTO minimum: 1 description: Histórico de cracha companyBranchHistories: type: array items: type: object allOf: – #/definitions/companyBranchHistoryDTO minimum: 1 description: Histórico de filial syndicateHistories: type: array items: type: object allOf: – #/definitions/syndicateHistoryDTO minimum: 1 description: Histórico de sindicato employmentRelationshipHistories: type: array items: type: object allOf: – #/definitions/employmentRelationshipHistoryDTO minimum: 1 description: Histórico de vinculo workshiftHistories: type: array items: type: object allOf: – #/definitions/workshiftHistoryDTO minimum: 1 description: Histórico de escala jobPositionHistories: type: array items: type: object allOf: – #/definitions/jobPositionHistoryDTO minimum: 1 description: Histórico de posto de trabalho hourBankReevaluateDTO: description: Dados para o recálculo do banco de horas type: object required: – params – employeeIdCompanyId – startDate – processBatchInfo properties: params: type: object allOf: – #/definitions/reevaluateParams description: Parâmetros do recálculo do banco employeeIdCompanyId: type: array items: type: object allOf: – #/definitions/employeeIdCompanyIdDTO minimum: 1 description: Colaboradores a serem processados startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final processBatchInfo: type: object allOf: – #/definitions/processBatchInfoDTO description: Informações do processo processBatchInfoDTO: description: DTO com as informações do processo assincrono type: object required: – processId – batchId properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do bloco reevaluateParams: description: Parâmetros do recálculo do banco de horas type: object required: – hourBankId – isDeleteIntegrationEntries – isCreateEvaluationEntries properties: hourBankId: type: string maxLength: 36 description: Id do banco de horas isDeleteIntegrationEntries: type: boolean description: É para excluir os lançamentos de integração isCreateEvaluationEntries: type: boolean description: É para recriar os lançamentos da apuração considerDismissed: type: boolean description: Considerar demitidos default: true employeeIdCompanyIdDTO: description: Identificado do colaborador type: object required: – id – companyId properties: id: type: string description: ids do colaborador companyId: type: string description: Id da empresa filtersDTO: description: Filtros type: object properties: companies: type: array items: type: string description: Empresas employees: type: array items: type: string description: Colaboradores hourBankClosureDTO: description: Dados para o fechamento do banco de horas type: object required: – params – employeeIds – startDate – processBatchInfo properties: params: type: object allOf: – #/definitions/hourBankClosureParams description: Parâmetros do fechamento do banco employeeIds: type: array items: type: string minimum: 1 description: Colaboradores a serem processados startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final processBatchInfo: type: object allOf: – #/definitions/processBatchInfoDTO description: Informações do processo hourBankClosureParams: description: Parâmetros do fechamento do banco de horas type: object required: – closureType – hourBank properties: closureDate: type: string format: date description: Data de fechamento competence: type: string format: date description: Competência considerDismissed: type: boolean description: Considerar demitidos default: false closureType: type: string allOf: – #/definitions/hourBankClosureType description: Tipo de fechamento hourBank: type: string maxLength: 36 description: Identificador do banco de horas percentage: type: number format: double description: Porcentagem para fechamento de banco de horas minimum: 0 hoursLimit: type: integer format: int64 description: Limite Horas minimum: 0 closeAccounts: type: boolean description: Encerrar conta do banco de horas default: false genericId: description: DTO genérico com identificador único type: object required: – id properties: id: type: string maxLength: 36 description: Identificador único layoutReference: description: Referência do leiaute type: object required: – reference – dateReference properties: reference: type: string description: Referência para encontrar o leiaute dateReference: type: string format: date description: Data de referência employeeDTO: description: Colaborador type: object required: – id – code – userName – email – employmentRelationship properties: id: type: string description: Identificador code: type: integer format: int64 description: Código userName: type: string description: Nome do usuário email: type: string description: E-mail employmentRelationship: type: object allOf: – #/definitions/employmentRelationshipDTO description: Vínculo empregatício managers: type: array items: type: object allOf: – #/definitions/managerDTO description: Gestores managerDTO: description: Gestor type: object required: – id – userName – email properties: id: type: string description: Identificador userName: type: string description: Nome email: type: string description: E-mail personDTO: description: Pessoa type: object required: – id – name – cnpCpf – numnis properties: id: type: string description: Identificador name: type: string description: Nome cnpCpf: type: string description: Cpf numnis: type: string description: Código workShiftDTO: description: Escala horária type: object required: – id – code – name – timeShiftType properties: id: type: string maxLength: 36 description: Identificador code: type: integer format: int64 description: Código name: type: string description: Nome timeShiftType: type: object allOf: – #/definitions/timeShiftTypeDTO description: Turno timeShiftTypeDTO: description: Turno do horário type: object required: – name – timeShiftType properties: name: type: string description: Nome do tipo de turno timeShiftType: type: string allOf: – #/definitions/timeShiftType description: Tipo de turno costCenterDTO: description: Escala horária type: object required: – id – code – name properties: id: type: string maxLength: 36 description: Identificador code: type: string description: Código name: type: string description: Nome 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: 100 pageAEJDTO: 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: 100 filterEmployeeForMobileDTO: description: Filtros de colaborador do pontomobile type: object properties: employeeIds: type: array items: type: string description: colaboradores personIds: type: array items: type: string description: Pessoa employmentRelationshipIds: type: array items: type: string description: Vinculo empregaticio workshiftIds: type: array items: type: string description: Escala costCenterIds: type: array items: type: string description: Centro de custo companyBranchIds: type: array items: type: string description: Filial employersIds: type: array items: type: string description: Empresas employeeForMobilidadeDTO: description: Dados do colaborador para integração com o mobilidade type: object required: – employee – person – companyBranch – employer – enabledModules – workshift – costCenter properties: employee: type: object allOf: – #/definitions/employeeDTO description: Colaborador person: type: object allOf: – #/definitions/personDTO description: Person companyBranch: type: object allOf: – #/definitions/companyBranchData description: Filial employer: type: object allOf: – #/definitions/companyData description: Empresa enabledModules: type: array items: type: string allOf: – #/definitions/admissionModuleType minimum: 1 description: Modulo workshift: type: object allOf: – #/definitions/workShiftDTO description: Workshift costCenter: type: object allOf: – #/definitions/costCenterDTO description: Centro de custo employmentRelationshipDTO: description: Vinculo empregaticio type: object required: – id – contractType properties: id: type: string description: Id contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato filterEmployeeForAEJReportDTO: description: Filtros de colaborador para relatório AEJ type: object required: – companyBranchId properties: companyBranchId: type: string description: Filial employeeIds: type: array items: type: string description: colaboradores workshiftId: type: array items: type: string description: Escala costCenterId: type: array items: type: string description: Centro de custo jobPositionId: type: array items: type: string description: Cargo locationId: type: array items: type: string description: Local contractType: type: array items: type: string allOf: – #/definitions/contractType description: Tipo de contrato timeShiftType: type: array items: type: string allOf: – #/definitions/timeShiftType description: Turno considerDismissed: type: boolean description: Considerar demitidos default: true employeeDataForAEJReportDTO: description: Dados do colaborador para relatório AEJ type: object required: – employee – person – startDate – endDate properties: employee: type: object allOf: – #/definitions/employeeForAEJReportDTO description: Colaborador person: type: object allOf: – #/definitions/personDTO description: Person startDate: type: string format: date description: Data inicial apuração endDate: type: string format: date description: Data final apuração employeeForAEJReportDTO: description: Colaborador para relatório AEJ type: object required: – id properties: id: type: string description: Identificador eSocialRegistration: type: string description: Registo eSocial notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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