HCM – Payroll Calculation Monitor (monitor)

2.0info: 2.2.0 HCM – Payroll Calculation Monitor description: HCM – Payroll Calculation Monitor x-senior-domain: HCM – Payroll Calculation Monitor x-senior-domain-path: hcm_payroll_calculation x-senior-service-path: monitor 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_calculationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /monitor/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 /monitor/queries/getFinancialStatementMonitor: post: description: Buscar informações do monitoramento do evento calculado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – calculationDefinition – wageType properties: employee: type: string maxLength: 36 description: Identificação do colaborador calculationDefinition: type: string maxLength: 36 description: Identificação da definição de cálculo wageType: type: string maxLength: 36 description: Identificação do evento calculado responses: 200: description: Ok schema: type: object allOf: – #/definitions/financialStatementInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Buscar informações do monitoramento do evento calculado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Identificação do colaborador in: query required: true type: string maxLength: 36 – name: calculationDefinition description: Identificação da definição de cálculo in: query required: true type: string maxLength: 36 – name: wageType description: Identificação do evento calculado in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object allOf: – #/definitions/financialStatementInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /monitor/queries/getVacationReceiptDetailMonitor: post: description: Buscar informações do monitoramento do evento de férias calculado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – employee – vacationSchedule – acquisitivePeriod – wageType properties: processId: type: string maxLength: 36 description: Identificador do processo do cálculo employee: type: string maxLength: 36 description: Identificador único do colaborador vacationSchedule: type: string maxLength: 36 description: Identificador da programação de férias acquisitivePeriod: type: string maxLength: 36 description: Identificador do período aquisitivo wageType: type: string maxLength: 36 description: Identificador do evento responses: 200: description: Ok schema: type: object required: – monitor properties: monitor: type: string description: Monitoramento da apuração de horas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Buscar informações do monitoramento do evento de férias calculado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do processo do cálculo in: query required: true type: string maxLength: 36 – name: employee description: Identificador único do colaborador in: query required: true type: string maxLength: 36 – name: vacationSchedule description: Identificador da programação de férias in: query required: true type: string maxLength: 36 – name: acquisitivePeriod description: Identificador do período aquisitivo in: query required: true type: string maxLength: 36 – name: wageType description: Identificador do evento in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – monitor properties: monitor: type: string description: Monitoramento da apuração de horas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /monitor/queries/getDismissalRegisterDetailMonitor: post: description: Buscar informações do monitoramento do evento de rescisão calculado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – employee – dismissalSchedule – dismissalCalculationType – wageType properties: processId: type: string maxLength: 36 description: Identificador do processo do cálculo employee: type: string maxLength: 36 description: Identificador único do colaborador dismissalSchedule: type: string maxLength: 36 description: Identificador da programação de rescisão dismissalCalculationType: type: string description: Tipo de cálculo acquisitivePeriod: type: string maxLength: 36 description: Identificador do período aquisitivo wageType: type: string maxLength: 36 description: Identificador do evento responses: 200: description: Ok schema: type: object required: – monitor properties: monitor: type: string description: Monitoramento do demonstrativo de rescisão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Buscar informações do monitoramento do evento de rescisão calculado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do processo do cálculo in: query required: true type: string maxLength: 36 – name: employee description: Identificador único do colaborador in: query required: true type: string maxLength: 36 – name: dismissalSchedule description: Identificador da programação de rescisão in: query required: true type: string maxLength: 36 – name: dismissalCalculationType description: Tipo de cálculo in: query required: true type: string – name: acquisitivePeriod description: Identificador do período aquisitivo in: query type: string maxLength: 36 – name: wageType description: Identificador do evento in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – monitor properties: monitor: type: string description: Monitoramento do demonstrativo de rescisão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /monitor/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 /monitor/queries/exportAverageMonitor: 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 /monitor/queries/exportAverageWageTypeMonitor: 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 /monitor/queries/exportFinancialStatementMonitor: 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 /monitor/queries/exportPayrollRegisterMonitor: 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 /monitor/queries/exportVacationReceiptMonitor: 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 /monitor/queries/exportVacationReceiptDetailMonitor: 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 /monitor/queries/exportDismissalRegisterMonitor: 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 /monitor/queries/exportDismissalRegisterDetailMonitor: 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 /monitor/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 /monitor/actions/employeeVacationCompanyTransfer: post: description: Realiza o processo da transferência de empresa de um colaborador no domínio monitoramento de ficha financeira. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – previousEmployee – newEmployee properties: previousEmployee: type: string maxLength: 36 description: Colaborador origem newEmployee: type: string maxLength: 36 description: Colaborador destino vacationCompanyTransfer: type: array items: type: object allOf: – #/definitions/vacationCompanyTransfer description: Dados da definição de cálculo para transferência de empresa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /monitor/actions/employeeFinancialStatementCompanyTransfer: post: description: Realiza o processo da transferência de empresa de um colaborador no domínio monitoramento de ficha financeira. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – previousEmployee – newEmployee properties: previousEmployee: type: string maxLength: 36 description: Colaborador origem newEmployee: type: string maxLength: 36 description: Colaborador destino calculationDefinitionCompanyTransfer: type: array items: type: object allOf: – #/definitions/calculationDefinitionCompanyTransfer description: Dados da definição de cálculo para transferência de empresa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /monitor/actions/importAverageMonitor: 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 /monitor/actions/importAverageWageTypeMonitor: 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 /monitor/actions/importFinancialStatementMonitor: 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 /monitor/actions/importPayrollRegisterMonitor: 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 /monitor/actions/importVacationReceiptMonitor: 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 /monitor/actions/importVacationReceiptDetailMonitor: 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 /monitor/actions/importDismissalRegisterMonitor: 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 /monitor/actions/importDismissalRegisterDetailMonitor: 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 /monitor/signals/financialStatementMonitorCleaning: post: description: Limpa o monitoramento da apuração de horas não pertencentes ao processo informado, caso seja informado tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – calculationDefinitionId – employeeIds properties: calculationDefinitionId: type: string maxLength: 36 description: Identificador único do código de cálculo processId: type: string maxLength: 36 description: Identificador único do processo employeeIds: type: array items: type: string minimum: 1 description: Lista de identificador único do colaborador responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/averageMonitorBulk: post: description: Realiza a inserção em lote do monitoramento do cálculo de médias tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – calculationDefinitionId – averageMonitorCalculations properties: processId: type: string maxLength: 36 description: Identificador do processo calculationDefinitionId: type: string maxLength: 36 description: Identificador da definição de cálculo averageMonitorCalculations: type: array items: type: object allOf: – #/definitions/averageMonitorCalculation minimum: 1 description: Cálculos de médias responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/averageWageTypeMonitorBulk: post: description: Realiza a inserção em lote do monitoramento do cálculo de eventos com médias tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – calculationDefinitionId – averageWageTypeMonitorCalculations properties: processId: type: string maxLength: 36 description: Identificador do processo calculationDefinitionId: type: string maxLength: 36 description: Identificador da definição de cálculo averageWageTypeMonitorCalculations: type: array items: type: object allOf: – #/definitions/averageWageTypeMonitorCalculation minimum: 1 description: Cálculos de eventos com médias responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/financialStatementMonitorBulk: post: description: Realiza a inserção em lote do monitoramento da ficha financeira tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – employeeFinancialStatement – version properties: employeeFinancialStatement: type: array items: type: object allOf: – #/definitions/employeeFinancialStatementData minimum: 1 description: Informações geral da ficha financeira type: string description: Versão responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/vacationReceiptMonitorBulk: post: description: Realiza a inserção em lote do monitoramento do recibo de férias tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – vacationReceiptData properties: processId: type: string maxLength: 36 description: Identificador único do processo vacationReceiptData: type: array items: type: object allOf: – #/definitions/vacationReceiptData minimum: 1 description: Informações gerais dos recibos de férias dos colaboradores responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/vacationReceiptMonitorCleaning: post: description: Limpeza do monitoramento do recibo de férias tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processVacationSchedule properties: processVacationSchedule: type: array items: type: object allOf: – #/definitions/processVacationSchedule minimum: 1 description: Informações das programações de férias dos colaboradores por identificador de processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/dismissalRegisterMonitorBulk: post: description: Realiza a inserção em lote do monitoramento da rescisão tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – dismissalRegisterData properties: processId: type: string maxLength: 36 description: Identificador único do processo dismissalRegisterData: type: array items: type: object allOf: – #/definitions/dismissalRegisterData minimum: 1 description: Informações da rescisão responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/dismissalRegisterMonitorCleaning: post: description: Limpeza do monitoramento da rescisão tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processDismissalSchedule properties: processDismissalSchedule: type: array items: type: object allOf: – #/definitions/processDismissalSchedule minimum: 1 description: Informações das programações de rescisão dos colaboradores por identificador de processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/saveDismissalRegisterDetailMonitor: post: description: Realiza a inserção individual do detalhe do monitoramento da rescisão, atualizando caso já exista tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – employee – dismissalSchedule – dismissalCalculationType – wageType – information properties: processId: type: string maxLength: 36 description: Identificador do processo do cálculo employee: type: string maxLength: 36 description: Identificador único do colaborador dismissalSchedule: type: string maxLength: 36 description: Identificador da programação de rescisão dismissalCalculationType: type: string description: Tipo de cálculo acquisitivePeriod: type: string maxLength: 36 description: Identificador do período aquisitivo wageType: type: string maxLength: 36 description: Identificador do evento information: type: string description: Informações do evento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/deleteDismissalRegisterDetailMonitor: post: description: Exclui o detalhe do monitoramento da rescisão encontrado através dos parâmetros informados tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – employee – dismissalSchedule – dismissalCalculationType – wageType properties: processId: type: string maxLength: 36 description: Identificador do processo do cálculo employee: type: string maxLength: 36 description: Identificador único do colaborador dismissalSchedule: type: string maxLength: 36 description: Identificador da programação de rescisão dismissalCalculationType: type: string description: Tipo de cálculo acquisitivePeriod: type: string maxLength: 36 description: Identificador do período aquisitivo wageType: type: string maxLength: 36 description: Identificador do evento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/deleteEmployeeVacationCompanyTransfer: post: description: Realiza o processo de remoção de dados de férias da transferência de empresa de um colaborador. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – employee properties: employee: type: string maxLength: 36 description: Colaborador responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/deleteEmployeeFinancialStatementCompanyTransfer: post: description: Realiza o processo de remoção de dados de ficha financeira da transferência de empresa de um colaborador tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – employee properties: employee: type: string maxLength: 36 description: Colaborador responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/events/importAverageMonitorEvent: 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 /monitor/events/exportAverageMonitorEvent: 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 /monitor/events/importAverageWageTypeMonitorEvent: 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 /monitor/events/exportAverageWageTypeMonitorEvent: 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 /monitor/events/importFinancialStatementMonitorEvent: 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 /monitor/events/exportFinancialStatementMonitorEvent: 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 /monitor/events/importPayrollRegisterMonitorEvent: 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 /monitor/events/exportPayrollRegisterMonitorEvent: 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 /monitor/events/importVacationReceiptMonitorEvent: 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 /monitor/events/exportVacationReceiptMonitorEvent: 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 /monitor/events/importVacationReceiptDetailMonitorEvent: 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 /monitor/events/exportVacationReceiptDetailMonitorEvent: 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 /monitor/events/importDismissalRegisterMonitorEvent: 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 /monitor/events/exportDismissalRegisterMonitorEvent: 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 /monitor/events/importDismissalRegisterDetailMonitorEvent: 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 /monitor/events/exportDismissalRegisterDetailMonitorEvent: 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 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 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 averageMonitorCalculation: description: Cálculo de médias type: object required: – employeeId – ruleType – calculationType – average – information properties: employeeId: type: string maxLength: 36 description: Identificador do colaborador ruleType: type: string description: Regra calculationType: type: string description: Tipo de cálculo average: type: string description: Média information: type: string description: Informações de monitoramento averageWageTypeMonitorCalculation: description: Cálculo de eventos com médias type: object required: – employeeId – ruleType – calculationType – wageTypeId – wageTypeCode – information properties: employeeId: type: string maxLength: 36 description: Identificador do colaborador ruleType: type: string description: Regra calculationType: type: string description: Tipo de cálculo wageTypeId: type: string maxLength: 36 description: Identificador do evento wageTypeCode: type: integer format: int64 description: Código do evento information: type: string description: Informações de monitoramento averageMonitorInformationData: description: Informações de monitoramento do cálculo de médias type: object required: – totalizerCode – totalizerDescription – isConsiderMonthLessFifteenDays – quantityMonthsSearch – quantityMonthsGreatestValuesAndDivision – sum – divider – average – monthlyValues – version properties: totalizerCode: type: integer format: int64 description: Código do totalizador totalizerDescription: type: string description: Descrição do totalizador isConsiderMonthLessFifteenDays: type: boolean description: Considera meses com menos de 15 dias quantityMonthsSearch: type: integer format: int64 description: Quantidade de meses para pesquisa quantityMonthsGreatestValuesAndDivision: type: integer format: int64 description: Quantidade de meses com os maiores valores para divisão sum: type: string description: Soma divider: type: integer format: int64 description: Divisor average: type: string description: Média monthlyValues: type: array items: type: object allOf: – #/definitions/averageMonitorInformationMonthlyValueData minimum: 1 description: Valores mensais type: string description: Versão averageMonitorInformationMonthlyValueData: description: Informações de monitoramento dos valores mensais do cálculo de médias type: object required: – month – value – disregard properties: month: type: string format: date description: Mês value: type: string description: Valor disregard: type: integer format: int64 description: Motivo do mês ser desconsiderado averageWageTypeMonitorInformationData: description: Informações de monitoramento do cálculo de eventos com médias type: object required: – wageTypeCode – wageTypeDescription – reference – value – version properties: wageTypeCode: type: integer format: int64 description: Código do evento wageTypeDescription: type: string description: Descrição do evento reference: type: number format: double description: Referência value: type: string description: value type: string description: Versão employeeFinancialStatementData: description: Informações gerais do demonstrativo de pagamento type: object properties: employee: type: string maxLength: 36 description: Colaborador processId: type: string maxLength: 36 description: Identificador único do processo salaryType: type: string description: Tipo do salário calculationDefinition: type: object allOf: – #/definitions/calculationDefinitionData description: Definições do código de cálculo financialStatement: type: array items: type: object allOf: – #/definitions/financialStatementInfo description: Informações gerais da ficha financeira calculationDefinitionData: description: Dados do código de cálculo type: object properties: id: type: string maxLength: 36 description: Identificado único code: type: integer format: int64 description: Código competence: type: string format: date description: Competência calculationType: type: string description: Tipo de cálculo paymentDate: type: string format: date description: Data de pagamento financialStatementInfo: description: Informações gerais da ficha financeira type: object properties: id: type: string maxLength: 36 description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Nome characteristic: type: string description: Característica identificationType: type: string description: Tipo bases: type: object allOf: – #/definitions/bases description: Bases do evento rule: type: object allOf: – #/definitions/rule description: Regra type: string description: Versão bases: description: Bases do evento type: object properties: total: type: string description: Total deductionTotal: type: string description: Total de dedução legal totalSimplified: type: string description: Total simplificado deductionSimplified: type: string description: Total de dedução simplificada bases: type: array items: type: object allOf: – #/definitions/base description: Informações das bases base: description: Informações da base type: object properties: operator: type: string description: Tipo da operação code: type: integer format: int64 description: Código name: type: string description: Nome originInformationType: type: string description: Origem basesType: type: string description: Tipo de base value: type: string description: Valor rule: description: Regra type: object properties: reference: type: number format: double description: Referência value: type: string description: Valor type: type: string description: Tipo entry: type: object allOf: – #/definitions/entry description: Lançamento formula: type: array items: type: object allOf: – #/definitions/formula description: Fórmulas formula: description: Fórmula do cálculo da regra type: object properties: label: type: string description: Fórmula values: type: array items: type: string format: byte description: Valores entry: description: Lançamento type: object properties: reference: type: number format: double description: Referência value: type: string description: Valor vacationReceiptData: description: Informações gerais do recibo de férias type: object required: – employee – acquisitivePeriod – vacationSchedule – information properties: employee: type: string maxLength: 36 description: Colaborador acquisitivePeriod: type: string maxLength: 36 description: Período aquisitivo vacationSchedule: type: string maxLength: 36 description: Programação de férias information: type: string maxLength: 1000 description: Informações do cálculo do recibo vacationReceiptDetailData: type: array items: type: object allOf: – #/definitions/vacationReceiptDetailData description: Informações dos eventos do recibo de férias vacationReceiptDetailData: description: Informações dos detalhes do recibo de férias type: object required: – wageType – information properties: wageType: type: string maxLength: 36 description: Evento information: type: string description: Informações do evento processVacationSchedule: description: Informações das programações de férias dos colaboradores por identificador de processo type: object required: – processId – vacationScheduleList properties: processId: type: string maxLength: 36 description: Id do processo vacationScheduleList: type: array items: type: string minimum: 1 description: Programações de férias vacationReceiptInfo: description: Informações do monitoramento do recibo de férias type: object required: – disregardedDays properties: salaryType: type: string description: Tipo de salário salary: type: string description: Salário vacationSchedule: type: object allOf: – #/definitions/vacationScheduleInfo description: Informações da programação de férias acquisitivePeriod: type: object allOf: – #/definitions/acquisitivePeriodInfo description: Informações do período aquisitivo disregardedDays: type: array items: type: string format: date minimum: 1 description: Dias a desconsiderar type: string description: Versão vacationScheduleInfo: description: Informações de férias type: object properties: thirteenthSalaryVacation: type: boolean description: Décimo terceiro salário startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final returnDate: type: string format: date description: Data de retorno vacationDays: type: number format: double description: Dias de férias minimum: 0 maximum: 99.99 vacationPremiumDays: type: number format: double description: Dias de abono minimum: 0 maximum: 99.99 paidLeaveCollectiveVacation: type: number format: double description: Licença remunerada férias coletivas minimum: 0 maximum: 99.99 paymentDate: type: string format: date description: Data de pagamento acquisitivePeriodInfo: description: Informações do período aquisitivo type: object properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final dismissalRegisterData: description: Informações da rescisão type: object required: – employee – dismissalSchedule properties: employee: type: string maxLength: 36 description: Colaborador dismissalSchedule: type: string maxLength: 36 description: Programação de rescisão dismissalRegisterDetailData: type: array items: type: object allOf: – #/definitions/dismissalRegisterDetailData description: Informações dos eventos de rescisão dismissalRegisterDetailData: description: Informações dos detalhes da rescisão type: object required: – dismissalCalculationType – wageType – information properties: dismissalCalculationType: type: string description: Tipo de cálculo acquisitivePeriod: type: string maxLength: 36 description: Período aquisitivo wageType: type: string maxLength: 36 description: Evento information: type: string description: Informações do evento processDismissalSchedule: description: Informações das programações de rescisão dos colaboradores por identificador de processo type: object required: – processId – dismissalScheduleList properties: processId: type: string maxLength: 36 description: Id do processo dismissalScheduleList: type: array items: type: string minimum: 1 description: Programações de rescisão vacationCompanyTransfer: description: Dados de férias para transferência de empresa type: object required: – previousAcquisitivePeriod – newAcquisitivePeriod – previousVacationSchedule – newVacationSchedule properties: previousAcquisitivePeriod: type: string maxLength: 36 description: Período aquisitivo origem newAcquisitivePeriod: type: string maxLength: 36 description: Período aquisitivo destino previousVacationSchedule: type: string maxLength: 36 description: Programação de férias origem newVacationSchedule: type: string maxLength: 36 description: Programação de férias destino calculationDefinitionCompanyTransfer: description: Dados da definição de cálculo para transferência de empresa type: object required: – previousCalculationDefinition – newCalculationDefinition properties: previousCalculationDefinition: type: string maxLength: 36 description: Definição de cálculo origem newCalculationDefinition: type: string maxLength: 36 description: Definição de cálculo destino averageMonitor: description: Monitoramento do cálculo de médias type: object required: – processId – calculationDefinition – employee – ruleType – calculationType – average – information properties: id: type: string format: uuid description: Identificador único processId: type: string format: uuid description: Identificador do processo calculationDefinition: type: string format: uuid description: Identificador da definição de cálculo employee: type: string format: uuid description: Identificador do Colaborador ruleType: type: string description: Regra calculationType: type: string description: Tipo de cálculo average: type: string description: Média information: type: string description: Informações de monitoramento averageWageTypeMonitor: description: Monitoramento do cálculo de eventos com médias type: object required: – processId – calculationDefinition – employee – ruleType – calculationType – wageType – wageTypeCode – information properties: id: type: string format: uuid description: Identificador único processId: type: string format: uuid description: Identificador do processo calculationDefinition: type: string format: uuid description: Identificador da definição de cálculo employee: type: string format: uuid description: Identificador do Colaborador ruleType: type: string description: Regra calculationType: type: string description: Tipo de cálculo wageType: type: string format: uuid description: Identificador do evento wageTypeCode: type: integer format: int64 description: Código do evento information: type: string description: Informações de monitoramento financialStatementMonitor: description: Monitoramento da ficha financeira type: object required: – employee – calculationDefinition – wageType – processId – information properties: id: type: string format: uuid description: Identificador único employee: type: string format: uuid description: Colaborador calculationDefinition: type: string format: uuid description: Código de cálculo wageType: type: string format: uuid description: Evento processId: type: string format: uuid description: Identificador do processo information: type: string description: Informação payrollRegisterMonitor: description: Monitoramento do demonstrativo de pagamento type: object required: – employee – calculationDefinition – processId – information properties: id: type: string format: uuid description: Identificador único employee: type: string format: uuid description: Colaborador calculationDefinition: type: string format: uuid description: Código de cálculo processId: type: string format: uuid description: Identificador do processo information: type: string maxLength: 1000 description: Informação vacationReceiptMonitor: description: Monitoramento do recibo de férias type: object required: – id – employee – acquisitivePeriod – vacationSchedule – processId – information properties: id: type: string format: uuid description: Identificador único employee: type: string format: uuid description: Colaborador acquisitivePeriod: type: string format: uuid description: Período aquisitivo vacationSchedule: type: string format: uuid description: Programação de férias processId: type: string format: uuid description: Identificador do processo information: type: string maxLength: 1000 description: Informação vacationReceiptDetailMonitor: description: Monitoramento do detalhe do recibo de férias type: object required: – id – employee – acquisitivePeriod – vacationSchedule – processId – wageType – information properties: id: type: string format: uuid description: Identificador único employee: type: string format: uuid description: Colaborador acquisitivePeriod: type: string format: uuid description: Período aquisitivo vacationSchedule: type: string format: uuid description: Programação de férias processId: type: string format: uuid description: Identificador do processo wageType: type: string format: uuid description: Evento information: type: string description: Informação dismissalRegisterMonitor: description: Monitoramento da rescisão type: object required: – id – employee – dismissalSchedule – processId properties: id: type: string format: uuid description: Identificador único employee: type: string format: uuid description: Colaborador dismissalSchedule: type: string format: uuid description: Programação de rescisão processId: type: string format: uuid description: Identificador do processo dismissalRegisterDetailMonitor: description: Monitoramento dos detalhes da rescisão type: object required: – id – employee – dismissalSchedule – dismissalCalculationType – acquisitivePeriod – wageType – processId – information properties: id: type: string format: uuid description: Identificador único employee: type: string format: uuid description: Colaborador dismissalSchedule: type: string format: uuid description: Programação de rescisão dismissalCalculationType: type: string description: Tipo de cálculo acquisitivePeriod: type: string format: uuid description: Período aquisitivo wageType: type: string format: uuid description: Evento processId: type: string format: uuid description: Identificador do processo information: type: string description: Informação 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