2.0info: 1.7.0 HCM – Contract Employment Additional Info Processor description: HCM – Contract Employment Additional Info Processor x-senior-domain: HCM – Contract Employment Additional Info Processor x-senior-domain-path: hcm_contract x-senior-service-path: employment_additional_info_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_additional_info_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_additional_info_processor/queries/employeeHistoryByPeriod: post: description: Histórico do colaborador 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: Id do 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: – leaveHistories properties: leaveHistories: type: array items: type: object allOf: – #/definitions/leaveHistoryDTO minimum: 1 description: Histórico de afastamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Histórico do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Id do 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: – leaveHistories properties: leaveHistories: type: array items: type: object allOf: – #/definitions/leaveHistoryDTO minimum: 1 description: Histórico de afastamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info_processor/queries/employeesHistoriesByPeriod: post: description: Busca os históricos dos colaborador filtrado pelo período 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 do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info_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_additional_info_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_additional_info_processor/signals/consolidateEmployeeAdditionalInfo: post: description: Consolida as informações adicionais dos 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_additional_info_processor/signals/evaluateLeaveHistoryInfluenceOnVacation: post: description: Avalia a influência de afastamentos para cálculo de férias. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – batchDescription properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string description: Id do lote de colaboradores batchDescription: type: string description: Descrição 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: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_additional_info_processor/events/employeeAdditionalInfoConsolidationFinished: post: description: Notifica a finalização da consolidação de informações adicionais do lote de colaboradores. 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 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_additional_info_processor/events/employeeTimeEvaluationContractAddInfoFinished: 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_additional_info_processor/events/evaluateLeaveHistoryInfluenceOnVacationFinished: post: description: Finalizada a avaliação da influência de afastamentos para cálculo de férias. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – batchDescription properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string description: Id do lote de colaboradores batchDescription: type: string description: Descrição 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/genericErrordefinitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN sourceReasonChange: description: Origem da mudança type: string enum: – V1 – V2 – V3 processType: description: Tipo do Processo type: string enum: – V1 – V2 – V3 onusRemuneration: description: Ônus pela remuneração type: string enum: – V1 – V2 – V3 workAccidentType: description: Tipo de acidente de trabalho type: string enum: – V1 – V2 – V3 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 verifiedDaysType: description: Tipo de dias verificados type: string enum: – ALL_DAYS – ONLY_VERIFIED_DAYS – ONLY_UNVERIFIED_DAYS generateNegativeType: description: 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 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 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 leaveHistoryDTO: description: Histórico de Afastamento type: object required: – id – employeeId – startDate – situation – numberHoursLeft – sourceReasonChange – processType – birthDate – diseaseCid – subgroupCid – cnpjUnion – onusRemuneration – workAccidentType – justifiedDays – observation – sameReasonEsocial – resultedSicknessAssistance – estimatedEndDate – estimatedDayEnd properties: id: type: string description: Identificador único employeeId: type: string description: Identificador do colaborador 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 minimum: 0 maximum: 1439 situation: type: integer format: int64 description: Situação numberHoursLeft: type: integer format: int64 description: Número de horas restantes sourceReasonChange: type: string allOf: – #/definitions/sourceReasonChange description: Origem da mudança processType: type: string allOf: – #/definitions/processType description: Tipo do processo processNumber: type: string maxLength: 21 description: Número do processo birthDate: type: string format: date description: Data de nascimento diseaseCid: type: string description: CID da doença subgroupCid: type: string description: CID do subgrupo cnpjUnion: type: integer format: int64 description: CNPJ onusRemuneration: type: string allOf: – #/definitions/onusRemuneration description: Ônus pela remuneração workAccidentType: type: string allOf: – #/definitions/workAccidentType description: Tipo de acidente de trabalho justifiedDays: type: integer format: int64 description: Dias justificados observation: type: string description: Observação sameReasonEsocial: type: boolean description: Mesma razão e-social resultedSicknessAssistance: type: boolean description: Resultou em assistência médica estimatedEndDate: type: string format: date description: Data final estimada estimatedDayEnd: type: integer format: int64 description: Dia final estimado 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 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º 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 do colaborador type: object required: – leaveHistories properties: leaveHistories: type: array items: type: object allOf: – #/definitions/leaveHistoryDTO minimum: 1 description: Históricos de afastamento filtersDTO: description: Filtros type: object properties: companies: type: array items: type: string description: Empresas employees: type: array items: type: string description: Colaboradores 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