2.0info: 1.3.0 HCM – Payroll Entry General Processor description: HCM – Payroll Entry General Processor x-senior-domain: HCM – Payroll Entry General Processor x-senior-domain-path: hcm_payroll_entry x-senior-service-path: general_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_payroll_entrysecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /general_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 /general_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 /general_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 /general_processor/signals/saveClockingEventEvents: post: description: Salva os eventos gerados pelo ponto tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – clockingEventEventsBatchInfo properties: clockingEventEventsBatchInfo: type: object allOf: – #/definitions/clockingEventEventsBatchInfo description: Informações sobre o bloco e o processo employeeEvents: type: array items: type: object allOf: – #/definitions/employeeEventDTO description: Colaboradores com seus eventos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general_processor/events/entryFixedVariableFinished: post: description: Notifica a conclusão da consolidação de lançamentos fixos e variáveis para o cálculo da Folha. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – company – calculationDefinitionData – 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 responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general_processor/events/resetTimeEvaluationAfterDismissal: post: description: Evento para resetar a apuração de ponto após a demissão do colaborador na geração de eventos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – employeeDTO – countDTO properties: processId: type: string description: Id do processo batchId: type: string description: Id do lote de colaboradores. employeeDTO: type: array items: type: object allOf: – #/definitions/resetTimeEvaluationEmployeeDTO minimum: 1 description: DTO com informações do colaborador countDTO: type: object allOf: – #/definitions/countDTO description: DTO de contagem de processamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN doubleType: description: Eventos duplos type: string enum: – DESPISE – KEEP 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 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 countDTO: description: DTO de contagem de processamento type: object required: – processedSuccessfully – processedWithError properties: processedSuccessfully: type: integer format: int64 description: Processados com sucesso processedWithError: type: integer format: int64 description: Processados com erro resetTimeEvaluationEmployeeDTO: description: DTO do zerar apuração type: object required: – employeeId properties: employeeId: type: string description: Identificador do colaborador dismissalDate: type: string format: date description: Identificador da definição de cálculo 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 clockingEventEventsBatchInfo: description: Informações sobre o bloco e o processo type: object required: – processId – batchId – errorProcessed – doubleEvents – competence properties: processId: type: string description: Identificador do processo batchId: type: string description: Identificador do bloco errorProcessed: type: integer format: int64 description: Quantidade de colaboradores processados com erro doubleEvents: type: string allOf: – #/definitions/doubleType description: Eventos duplos competence: type: string format: date description: Competência dismissalDate: type: string format: date description: Data de demissão resetEvaluationAfterDismissal: type: boolean description: Resetar apuração após a demissão do colaborador employeeEventDTO: description: DTO com o colaborador e seus eventos type: object required: – employeeId – calculationDefinitionId properties: employeeId: type: string description: Identificador do colaborador dismissalDate: type: string format: date description: Data de demissão calculationDefinitionId: type: string description: Identificador da definição de cálculo events: type: array items: type: object allOf: – #/definitions/eventDTO description: Eventos eventDTO: description: DTO do evento type: object required: – quantity – value – eventId properties: quantity: type: integer format: int64 description: Referência do evento value: type: integer format: int64 description: Valor do evento eventId: type: string description: Identificador do evento 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º 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