2.0info: 5.0.0 HCM – Payroll Time Evaluation Orchestrator description: HCM – Payroll Time Evaluation Orchestrator x-senior-domain: HCM – Clocking Event Time Evaluation Orchestrator x-senior-domain-path: hcm_clocking_event_time_evaluation x-senior-service-path: orchestrator 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: /orchestrator/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 /orchestrator/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 /orchestrator/queries/exportProcess: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /orchestrator/queries/exportProcessStepEvent: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /orchestrator/queries/exportProcessProcessingError: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /orchestrator/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 /orchestrator/actions/importProcess: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /orchestrator/actions/importProcessStepEvent: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /orchestrator/actions/importProcessProcessingError: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /orchestrator/signals/deleteProcessData: post: description: Remove os dados armazenados por processId tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Identificador do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /orchestrator/signals/generateEventFinished: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – generateEventParamsBatch properties: generateEventParamsBatch: type: object allOf: – #/definitions/generateEventParamsBatchDTO description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /orchestrator/events/employeeTimeEvaluationFinished: post: description: Evento Avisar que carregamento foi finalizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – employees 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: Colaboradores evaluateParams: type: object allOf: – #/definitions/evaluateParamsDTO description: Parâmetros cálculo de apuração reevaluateParams: type: object allOf: – #/definitions/reevaluateParamsDTO description: Parâmetros recálculo de apuração responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /orchestrator/events/generateEventProcessFinished: post: description: Evento para avisar que a geração dos eventos foi finalizada em todos os serviços x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – generateEventParamsBatch properties: generateEventParamsBatch: type: object allOf: – #/definitions/generateEventParamsBatchDTO description: Parâmetros do bloco do processo de geração de eventos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /orchestrator/events/generateEventLoadFinished: post: description: Evento para avisar que o carregamento dos dados para a geração de eventos foi finalizada em todos os serviços x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – generateEventParamsBatch properties: generateEventParamsBatch: type: object allOf: – #/definitions/generateEventParamsBatchDTO description: Parâmetros do bloco do processo de geração de eventos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /orchestrator/events/generateEventSaveFinished: post: description: Evento para avisar que o salvamento dos dados da geração de eventos foi finalizado 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 responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /orchestrator/events/importProcessEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /orchestrator/events/exportProcessEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /orchestrator/events/importProcessStepEventEvent: 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 /orchestrator/events/exportProcessStepEventEvent: 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 /orchestrator/events/importProcessProcessingErrorEvent: 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 /orchestrator/events/exportProcessProcessingErrorEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim eventGenerationCreditPaymentType: type: string enum: – PAY – NOTHING_TO_DO description: Tipo de operações para o banco de horas positivo: * `PAY` – Pagar * `NOTHING_TO_DO` – Nada a fazer eventGenerationDebitPaymentType: type: string enum: – DISCOUNT – NOTHING_TO_DO – CANCEL_DEBIT description: Tipo de operações para o banco de horas negativo: * `DISCOUNT` – Descontar * `NOTHING_TO_DO` – Nada a fazer * `CANCEL_DEBIT` – Cancelar débito verifiedDaysType: type: string enum: – ALL_DAYS – ONLY_VERIFIED_DAYS – ONLY_UNVERIFIED_DAYS description: Tipo de dias verificados: * `ALL_DAYS` – Todos os dias * `ONLY_VERIFIED_DAYS` – Somente os dias verificados * `ONLY_UNVERIFIED_DAYS` – Somente os dias não verificados doubleType: type: string enum: – DESPISE – KEEP description: Eventos duplos: * `DESPISE` – Desprezar * `KEEP` – Manter processType: type: string enum: – TIME_EVALUATION – TIME_EVALUATION_RECALCULATION – HOUR_BANK_CLOSURE – HOUR_BANK_REEVALUATE – GENERATE_EVENT – TIME_EVALUATION_VERIFICATION – RESET_TIME_EVALUATION – TIME_EVALUATION_PENDING description: Tipos de processo: * `TIME_EVALUATION` – Cálculo * `TIME_EVALUATION_RECALCULATION` – Recálculo * `HOUR_BANK_CLOSURE` – Fechamento do banco de horas * `HOUR_BANK_REEVALUATE` – Recálculo do banco de horas * `GENERATE_EVENT` – Geração de evento * `TIME_EVALUATION_VERIFICATION` – Verificação do ponto/dias apurados * `RESET_TIME_EVALUATION` – Zerar apuração * `TIME_EVALUATION_PENDING` – Processar pendências da apuração userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error 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 checkDTO: description: Nome e status de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status evaluateParamsDTO: description: Parâmetros do cálculo de apuração type: object required: – startDate – endDate – considerDismissed – reconsiderDeletedClockingEventsAdjustment properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo considerDismissed: type: boolean description: Considerar demitidos reconsiderDeletedClockingEventsAdjustment: type: boolean description: Reconsiderar marcações excluídas no acerto batch: type: string description: Descricao do bloco generateEventParamsBatchDTO: description: Parâmetros do bloco do processo de geração de eventos type: object required: – processId – batchId – employees – eventGenerationParams 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 eventGenerationParams: type: object allOf: – #/definitions/eventGenerationParamsDTO description: payload dos parâmetros eventGenerationParamsDTO: description: Parâmetros da geração de eventos type: object required: – doubleEvents – competence – startDate properties: doubleEvents: type: string allOf: – #/definitions/doubleType description: Eventos duplos competence: type: string format: date description: Competência isCloseAccounts: type: boolean description: Fechar contas do banco default: false debitPaymentType: type: string allOf: – #/definitions/eventGenerationDebitPaymentType description: Operação para o banco de horas negativo creditPaymentType: type: string allOf: – #/definitions/eventGenerationCreditPaymentType description: Operação para o banco de horas positivo dismissalDate: type: string format: date description: Data de demissão resetEvaluationAfterDismissal: type: boolean description: Zerar apuração pós demissão default: false startDate: type: string format: date description: Data inicial calculateTermination: type: boolean description: Calcular para rescisão default: false reevaluateParamsDTO: description: Parâmetros do recálculo de apuração type: object required: – startDate – endDate – considerDismissed – onlyModifiedDaysAfterEvaluation – realocateClockingEvents – undoAdjustments – verifiedDays properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo considerDismissed: type: boolean description: Considerar demitidos onlyModifiedDaysAfterEvaluation: type: boolean description: Somente dias alterados após a apuração realocateClockingEvents: type: boolean description: Realocar marcações undoAdjustments: type: boolean description: Desfazer acertos verifiedDays: type: string allOf: – #/definitions/verifiedDaysType description: Dias verificados batch: type: string description: Descricao do bloco process: description: Responsável pelo controle da coreografia de pré-requisitos do processo de apuração de horas dos colaboradores. type: object required: – processId – batchId – total properties: id: type: string format: uuid description: Identificador único processId: type: string format: uuid description: Identificador do processo batchId: type: string format: uuid description: Identificador do lote total: type: integer format: int64 description: Total de pré-requisitos finalizados minimum: 0 processType: type: string allOf: – #/definitions/processType description: Tipo do processo type: integer format: int64 description: Versão do fluxo do processo status: type: string maxLength: 100 description: Status do processamento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: processStepEvent: description: Controle de eventos recebidos por etapa na orquestração do processo. type: object required: – process – stepOrder – originDomain – originService – originEvent properties: id: type: string format: uuid description: Identificador único process: type: object allOf: – #/definitions/process description: Processo stepOrder: type: integer format: int64 description: Ordem da etapa originDomain: type: string maxLength: 100 description: Domínio de origem originService: type: string maxLength: 100 description: Serviço de origem originEvent: type: string maxLength: 100 description: Evento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: processProcessingError: description: Registro de erros de processamento do processor por colaborador. type: object required: – process properties: id: type: string format: uuid description: Identificador único process: type: object allOf: – #/definitions/process description: Processo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage