2.0info: 1.1.0 remuneration_batch x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: remuneration_batch 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/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /remuneration_batch/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus 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: PUBLIC responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /remuneration_batch/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 /remuneration_batch/queries/exportWorkstationGroup: 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 /remuneration_batch/queries/exportWorkstationgroupstructure: 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 /remuneration_batch/queries/exportJobPosition: 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 /remuneration_batch/queries/exportJobpositionstructure: 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 /remuneration_batch/queries/exportPerson: 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 /remuneration_batch/queries/exportEmployee: 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 /remuneration_batch/queries/exportIcpPplr: 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 /remuneration_batch/queries/exportIcpCommission: 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 /remuneration_batch/queries/exportIcpBonus: 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 /remuneration_batch/queries/exportIcpCashHandlingBonus: 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 /remuneration_batch/queries/exportIcpGratification: 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 /remuneration_batch/queries/exportIcpLongServiceBonus: 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 /remuneration_batch/queries/exportLongServiceBonus: 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 /remuneration_batch/queries/exportBatchJob: 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 /remuneration_batch/queries/exportBatchJobExecution: 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 /remuneration_batch/queries/exportBatchJobParams: 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 /remuneration_batch/queries/exportStepExecution: 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 /remuneration_batch/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 /remuneration_batch/actions/requestUploadFile: post: description: Solicitação para realizar o upload de um arquivo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado responses: 200: description: Ok schema: type: object required: – fileId – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. type: string description: Versão do arquivo. locationURI: type: string description: URI onde o upload deve ser realizado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /remuneration_batch/actions/commitFile: post: description: Realiza o commit de um arquivo que foi carregado anteriormente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileId – version properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) type: string description: Versão do arquivo responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno do commit de um arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /remuneration_batch/actions/requestAccessFile: post: description: Solicitação para acessar um arquivo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) ttl: type: integer format: int64 description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado (padrão 30 minutos) default: 30 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/requestAccessData description: Retorno do acesso do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /remuneration_batch/actions/deleteFile: post: description: Solicitação para apagar um arquivo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno de delete do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /remuneration_batch/actions/importWorkstationGroup: 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 /remuneration_batch/actions/importWorkstationgroupstructure: 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 /remuneration_batch/actions/importJobPosition: 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 /remuneration_batch/actions/importJobpositionstructure: 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 /remuneration_batch/actions/importPerson: 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 /remuneration_batch/actions/importEmployee: 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 /remuneration_batch/actions/importIcpPplr: 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 /remuneration_batch/actions/importIcpCommission: 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 /remuneration_batch/actions/importIcpBonus: 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 /remuneration_batch/actions/importIcpCashHandlingBonus: 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 /remuneration_batch/actions/importIcpGratification: 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 /remuneration_batch/actions/importIcpLongServiceBonus: 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 /remuneration_batch/actions/importLongServiceBonus: 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 /remuneration_batch/actions/importBatchJob: 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 /remuneration_batch/actions/importBatchJobExecution: 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 /remuneration_batch/actions/importBatchJobParams: 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 /remuneration_batch/actions/importStepExecution: 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 /remuneration_batch/signals/importData: post: description: Realiza o processo de importação de um recurso de dados para uma tabela específica tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – resourceId – resourceType – targetType properties: resourceId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. resourceType: type: string allOf: – #/definitions/resourceType description: Tipo do recurso targetType: type: string allOf: – #/definitions/targetType description: Tabela alvo da carga de dados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /remuneration_batch/events/importWorkstationGroupEvent: 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 /remuneration_batch/events/exportWorkstationGroupEvent: 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 /remuneration_batch/events/importWorkstationgroupstructureEvent: 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 /remuneration_batch/events/exportWorkstationgroupstructureEvent: 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 /remuneration_batch/events/importJobPositionEvent: 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 /remuneration_batch/events/exportJobPositionEvent: 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 /remuneration_batch/events/importJobpositionstructureEvent: 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 /remuneration_batch/events/exportJobpositionstructureEvent: 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 /remuneration_batch/events/importPersonEvent: 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 /remuneration_batch/events/exportPersonEvent: 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 /remuneration_batch/events/importEmployeeEvent: 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 /remuneration_batch/events/exportEmployeeEvent: 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 /remuneration_batch/events/importIcpPplrEvent: 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 /remuneration_batch/events/exportIcpPplrEvent: 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 /remuneration_batch/events/importIcpCommissionEvent: 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 /remuneration_batch/events/exportIcpCommissionEvent: 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 /remuneration_batch/events/importIcpBonusEvent: 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 /remuneration_batch/events/exportIcpBonusEvent: 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 /remuneration_batch/events/importIcpCashHandlingBonusEvent: 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 /remuneration_batch/events/exportIcpCashHandlingBonusEvent: 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 /remuneration_batch/events/importIcpGratificationEvent: 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 /remuneration_batch/events/exportIcpGratificationEvent: 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 /remuneration_batch/events/importIcpLongServiceBonusEvent: 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 /remuneration_batch/events/exportIcpLongServiceBonusEvent: 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 /remuneration_batch/events/importLongServiceBonusEvent: 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 /remuneration_batch/events/exportLongServiceBonusEvent: 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 /remuneration_batch/events/importBatchJobEvent: 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 /remuneration_batch/events/exportBatchJobEvent: 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 /remuneration_batch/events/importBatchJobExecutionEvent: 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 /remuneration_batch/events/exportBatchJobExecutionEvent: 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 /remuneration_batch/events/importBatchJobParamsEvent: 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 /remuneration_batch/events/exportBatchJobParamsEvent: 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 /remuneration_batch/events/importStepExecutionEvent: 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 /remuneration_batch/events/exportStepExecutionEvent: 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: resourceType: description: Tipo de recurso de dados type: string enum: – CSV_FILE targetType: description: type: string enum: – ICP_BONUS – ICP_COMISSION – ICP_CASHHANDLINGBONUS – ICP_LONGSERVICEBONUS – ICP_PPLR – ICP_GRATIFICATION healthCheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN employeeType: description: Tipo de colaborador type: string enum: – EMPTY – EMPLOYEE – THIRDPARTY – PARTNER jobStatus: description: type: string enum: – RUNNING – COMPLETED – FAILED stepStatus: description: type: string enum: – RUNNING – COMPLETED – FAILED 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR 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/healthCheckStatus description: Status icpBonusDTO: description: DTO referente ao registro de bônus referentes aos arquivos de dados type: object required: – workstationCode – workstationStructureCode – jobPositionCode – jobPositionStructureCode – startDate – endDate properties: workstationCode: type: string description: Código do posto de trabalho workstationStructureCode: type: integer format: int64 description: Código da estrutura do posto de trabalho jobPositionCode: type: string description: Código do cargo jobPositionStructureCode: type: integer format: int64 description: Código da estrutura do cargo valueType: type: string description: Tipo do valor value: type: string description: Valor do bônus startDate: type: string format: date description: Data início endDate: type: string format: date description: Data fim requester: type: string description: Usuário requisitante target: type: string description: Alvo do PPLR percentage: type: string description: Percentual de comissão period: type: integer format: int64 description: Período de tempo de serviço requestUploadData: description: Dados de retorno da solicitação de upload de um arquivo allOf: – #/definitions/resultBaseData – type: object required: – fileId – version – locationURI properties: fileId: type: string description: Identificador único do arquivo type: string description: Versão do arquivo locationURI: type: string description: URI onde o upload deve ser realizado requestAccessData: description: Dados de retorno do acesso do arquivo allOf: – #/definitions/resultBaseData – type: object required: – locationURI properties: locationURI: type: string description: URI onde o arquivo está disponível para download resultBaseData: description: Retorno base para os endpoints discriminator: _discriminator type: object required: – ok – _discriminator properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta default: false message: type: string description: Mensagem de retorno default: _discriminator: type: string description: workstationGroup: description: Grupo de postos de trabalho type: object required: – id – name properties: id: type: string description: Identificador único do grupo de posto de trabalho name: type: string description: Nome do grupo de postos de trabalho code: type: string description: Código do grupo de Postos workstationgroupstructure: type: object allOf: – #/definitions/workstationgroupstructure description: Estrutura do Grupo de postos workstationgroupstructure: description: Estrutura salarial do grupo de postos type: object required: – id properties: id: type: string description: Identificador único da estrutura salarial name: type: string description: Nome da estrutura salarial code: type: integer format: int64 description: Codigo da estrutura de postos jobPosition: description: Cargo type: object required: – id – name properties: id: type: string description: Identificador único do cargo name: type: string description: Nome do cargo jobpositionstructure: type: object allOf: – #/definitions/jobpositionstructure description: Identificador sa estrutura a qual esta entidade está associada code: type: string description: Código do cargo expirationDate: type: string format: date description: Data de expiração do cargo jobpositionstructure: description: Estrutura de cargos type: object required: – id – name – code properties: id: type: string description: Identificador único da estrutura name: type: string description: Nome da estrutura de cargos code: type: integer format: int64 description: Código da estrutura do cargo person: description: Pessoa type: object required: – id – userName – fullName properties: id: type: string description: Identificador único da pessoa userName: type: string description: Nome de usuário da pessoa fullName: type: string description: Nome completo do usuário employee: description: Colaborador type: object required: – id – person – employeetype properties: id: type: string description: Identificador único do Colaborador person: type: object allOf: – #/definitions/person description: Identificador da pessoa associada ao Colaborador dismissaldate: type: string format: date description: Data de demissão do colaborador (Se for o caso) employeetype: type: string allOf: – #/definitions/employeeType description: Tipo de colaborador icpPplr: description: incentivo de curto prazo do pplr type: object required: – workstationGroup – jobPosition – target – startDate – requester properties: id: type: string description: Identificador único da entidade. workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Grupo de postos de trabalho. jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo. target: type: string description: Alvo. startDate: type: string format: date description: Data de início vigência. endDate: type: string format: date description: Data de término vigência. requester: type: object allOf: – #/definitions/employee description: Solicitante. createDate: type: string format: date description: Data de criação. icpCommission: description: remuneração variável comissão type: object required: – workstationGroup – jobPosition – percentage – startDate – requester properties: id: type: string description: Identificador único da entidade. workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Grupo de postos de trabalho. jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo. percentage: type: string description: Percentual. startDate: type: string format: date description: Data de início vigência. endDate: type: string format: date description: Data de término vigência. requester: type: object allOf: – #/definitions/employee description: Solicitante. createDate: type: string format: date description: Data de criação. icpBonus: description: remuneração variável bonus type: object required: – workstationGroup – jobPosition – valueType – value – startDate – requester properties: id: type: string description: Identificador único da entidade. workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Grupo de postos de trabalho. jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo. valueType: type: string description: Tipo do valor value: type: string description: Valor startDate: type: string format: date description: Data de início vigência. endDate: type: string format: date description: Data de término vigência. requester: type: object allOf: – #/definitions/employee description: Solicitante. createDate: type: string format: date description: Data de criação. icpCashHandlingBonus: description: remuneração variável quebra de caixa type: object required: – workstationGroup – jobPosition – valueType – value – startDate – requester properties: id: type: string description: Identificador único da entidade. workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Grupo de postos de trabalho. jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo. valueType: type: string description: Tipo do valor value: type: string description: Valor startDate: type: string format: date description: Data de início vigência. endDate: type: string format: date description: Data de término vigência. requester: type: object allOf: – #/definitions/employee description: Solicitante. createDate: type: string format: date description: Data de criação. icpGratification: description: remuneração variável gratificação type: object required: – workstationGroup – jobPosition – valueType – value – startDate – requester properties: id: type: string description: Identificador único da entidade. workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Grupo de postos de trabalho. jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo. valueType: type: string description: Tipo do valor value: type: string description: Valor startDate: type: string format: date description: Data de início vigência. endDate: type: string format: date description: Data de término vigência. requester: type: object allOf: – #/definitions/employee description: Solicitante. createDate: type: string format: date description: Data de criação. icpLongServiceBonus: description: remuneração variável tempo de serviço type: object required: – workstationGroup – jobPosition – startDate – requester properties: id: type: string description: Identificador único da entidade. workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Grupo de postos de trabalho. jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo. startDate: type: string format: date description: Data de início vigência. endDate: type: string format: date description: Data de término vigência. requester: type: object allOf: – #/definitions/employee description: Solicitante. createDate: type: string format: date description: Data de criação. longServiceBonus: description: remuneração variável tempo de servico – anos type: object required: – period – valueType – value properties: id: type: string description: Identificador único da entidade. icpLongServiceBonus: type: object allOf: – #/definitions/icpLongServiceBonus description: IcpLongServiceBonus period: type: integer format: int64 description: Período de tempo de serviço. valueType: type: string description: Tipo do valor value: type: string description: Valor batchJob: description: type: object required: – jobType – name properties: id: type: string description: Identificador único do processo jobType: type: string allOf: – #/definitions/targetType description: Tipo do processo name: type: string description: Nome do job type: string description: Versão do job createDate: type: string format: date-time description: Data de criação batchJobExecution: description: type: object required: – status – startDate properties: id: type: string description: Identificador único do processo batchJob: type: object allOf: – #/definitions/batchJob description: Identificador do job status: type: string allOf: – #/definitions/jobStatus description: Status do processo startDate: type: string format: date-time description: Data de início do processo endDate: type: string format: date-time description: Data de término do processo processedRecords: type: integer format: int64 description: Quantidade de registros processados errorRecords: type: integer format: int64 description: Quantidade de registros com erro warningRecords: type: integer format: int64 description: Quantidade de registros com alerta successRecords: type: integer format: int64 description: Quantidade de registros com sucesso user: type: string description: Usuário responsável pelo processo batchJobParams: description: type: object required: – params properties: id: type: string description: Identificador único batchJobExecution: type: object allOf: – #/definitions/batchJobExecution description: Identificador da execução do job params: type: string description: Parâmetros da execução processo stepExecution: description: type: object required: – stepName – startDate properties: id: type: string description: Identificador único batchJobExecution: type: object allOf: – #/definitions/batchJobExecution description: Identificador da execução do job stepName: type: string description: Nome do step status: type: string allOf: – #/definitions/stepStatus description: Status do step statusMessage: type: string description: Mensagem de status startDate: type: string format: date-time description: Data de início do step endDate: type: string format: date-time description: Data de término do step 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 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