HCM – Contract Additional Info (employment_additional_info)

2.0info: 6.2.1 HCM – Contract Additional Info description: HCM – Foundation Employment Additional Info x-senior-domain: HCM – Contract x-senior-domain-path: hcm_contract x-senior-service-path: employment_additional_info contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcm_contractsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /employment_additional_info/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/heathcheckDTO 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/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/queries/hasLeaveWithESocialReasonTypeInPeriod: post: description: Verifica se existe um afastamento para o colaborador nos período pesquisado com um dos motivos eSocial pesquisados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – periodStartDate – periodEndDate – eSocialReasonTypes properties: employeeId: type: string maxLength: 36 description: Identificador único do colabroador periodStartDate: type: string format: date description: Data de inicio do periodo consultado periodEndDate: type: string format: date description: Data fim do periodo consultado eSocialReasonTypes: type: array items: type: string allOf: – #/definitions/eSocialReasonType minimum: 1 description: Motivos eSocial pesquisados responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/queries/getSituationTypeEmployeeByDate: post: description: Busca qual a situação do colaborador na data informada. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – date properties: employee: type: string maxLength: 36 description: Id do colaborador date: type: string format: date description: Data responses: 200: description: Ok schema: type: object required: – situation properties: situation: type: string description: Tipo da situação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca qual a situação do colaborador na data informada. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employee description: Id do colaborador in: query required: true type: string maxLength: 36 – name: date description: Data in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – situation properties: situation: type: string description: Tipo da situação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço recordNotFound: type: boolean description: Indica se não foi encontrado um registro para essa entidade no serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço recordNotFound: type: boolean description: Indica se não foi encontrado um registro para essa entidade no serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/queries/getLeaveHistoriesByPeriodAndEmployee: post: description: Busca os históricos de afastamento dentro do período e por colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – leaveHistoryByPeriodAndEmployeesInputDTO properties: leaveHistoryByPeriodAndEmployeesInputDTO: type: array items: type: object allOf: – #/definitions/leaveHistoryByPeriodAndEmployeesInputDTO minimum: 1 description: Lista de DTO de entrada para busca de histórico de afastamento por período e colaboradores responses: 200: description: Ok schema: type: object properties: leaveHistoryByPeriodAndEmployeesOutputDTO: type: array items: type: object allOf: – #/definitions/leaveHistoryByPeriodAndEmployeesOutputDTO description: Lista de DTO de saída para busca de histórico de afastamento por período e colaboradores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/queries/getLeaveHistoryWithSituation: post: description: Retorna os históricos de afastamento que influenciam as férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – employeeId – situationIdList properties: startDate: type: string format: date description: Data de início da referência de busca endDate: type: string format: date description: Data fim da referência de busca employeeId: type: string description: Identificador único do colaborador situationIdList: type: array items: type: string minimum: 1 description: Identificadores únicos das situações responses: 200: description: Ok schema: type: object required: – leaveHistoryWithSituationData properties: leaveHistoryWithSituationData: type: array items: type: object allOf: – #/definitions/leaveHistoryWithSituationData minimum: 1 description: Lista de DTO de saída para busca de histórico de afastamento das situações que influenciam férias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/queries/isValidForTransfer: post: description: Verifica se os colaboradores estão válidos para transferência na data parametrizada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employees – date properties: employees: type: array items: type: object allOf: – #/definitions/genericIdDTO minimum: 1 description: Colaboradores date: type: string format: date description: Data responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/employeeTransferValidationResult minimum: 1 description: Resultado das validações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/queries/exportAnnotationHistory: 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 /employment_additional_info/queries/exportCauseDismissal: 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 /employment_additional_info/queries/exportAnnotationHistoryAttachment: 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 /employment_additional_info/queries/exportDismissalReasonEsocial: 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 /employment_additional_info/queries/exportResignationHistory: 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 /employment_additional_info/queries/exportLeaveHistory: 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 /employment_additional_info/queries/exportResignationHistoryAttachment: 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 /employment_additional_info/queries/exportLeaveHistoryAttachment: 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 /employment_additional_info/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 /employment_additional_info/queries/exportCompanyBranchHistory: 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 /employment_additional_info/queries/exportExclusionProcess: 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 /employment_additional_info/queries/exportExclusionProcessStepGroup: 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 /employment_additional_info/queries/exportExclusionProcessStep: 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 /employment_additional_info/queries/exportAnnotationType: 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 /employment_additional_info/queries/exportAnnotationTypeStructure: 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 /employment_additional_info/queries/exportAnnotationTypeStructureCompanyHistory: 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 /employment_additional_info/queries/exportE001pes: 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 /employment_additional_info/queries/exportSituation: 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 /employment_additional_info/queries/exportDisease: 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 /employment_additional_info/queries/exportDiseaseSubgroup: 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 /employment_additional_info/queries/exportE070emp: 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 /employment_additional_info/queries/exportEmploymentRelationship: 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 /employment_additional_info/queries/exportESocialReason: 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 /employment_additional_info/queries/exportSituationStructure: 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 /employment_additional_info/queries/exportSituationStructureCompanyHistory: 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 /employment_additional_info/queries/exportE070fil: 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 /employment_additional_info/queries/exportStabilityHistory: 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 /employment_additional_info/queries/exportEmployeeSnapshot: 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 /employment_additional_info/queries/exportPositionSnapshot: 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 /employment_additional_info/queries/exportPositionSnapshotVersion: 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 /employment_additional_info/queries/exportEmployeeModule: 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 /employment_additional_info/queries/exportEmployeeReintegration: 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 /employment_additional_info/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/stabilityHistoryBatch: post: description: Inclusão coletiva do histórico de estabilidade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/stabilityHistoryGenericBatchDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/outputBatchDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/stabilityHistoryBatchDelete: post: description: Exclusão coletiva do histórico de estabilidade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/stabilityHistoryGenericBatchDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/outputBatchDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/annotationHistoryBatch: post: description: Inclusão coletiva do histórico de anotação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/annotationHistoryGenericBatchDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/outputBatchDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/annotationHistoryBatchDelete: post: description: Exclusão coletiva do histórico de anotação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/annotationHistoryGenericBatchDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/outputBatchDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/leaveHistoryBatch: post: description: Inclusão coletiva do histórico de afastamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/leaveHistoryGenericBatchDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/outputBatchDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/leaveHistoryBatchDelete: post: description: Exclusão coletiva do histórico de afastamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/leaveHistoryGenericBatchDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/outputBatchDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/createAnnotationHistoryByCompanyBranchTransfer: post: description: Cria um histórico de anotação para transferências entre empresas diferentes tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/annotationHistoryByCompanyBranchTransferDTO responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/undoCreateAnnotationHistoryByCompanyBranchTransfer: post: description: Exclui um histórico de anotação para transferências entre empresas diferentes tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/annotationHistoryByCompanyBranchTransferDTO responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/createResignationHistoryByCompanyBranchTransfer: post: description: Cria um histórico de desligamento para transferências entre empresas diferentes tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – summaryId – dismissalDate – employeeId – newCompanyBranchId properties: summaryId: type: string maxLength: 36 description: ID do log de processo dismissalDate: type: string format: date description: Data de desligamento employeeId: type: string maxLength: 36 description: ID do colaborador newCompanyBranchId: type: string maxLength: 36 description: ID da nova filial a qual o colaborador será alocado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/undoCreateResignationHistoryByCompanyBranchTransfer: post: description: Exclui um histórico de desligamento para transferências entre empresas diferentes tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – summaryId – resignationHistoryId properties: summaryId: type: string maxLength: 36 description: ID do log de processo resignationHistoryId: type: string maxLength: 36 description: Colaborador novo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/deleteVacationLeaveHistoryInBatch: post: description: Realiza a exclusão do histórico de afastamento de férias tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – startDate properties: employeeId: type: array items: type: string minimum: 1 description: ID do colaborador startDate: type: array items: type: string format: date minimum: 1 description: Data de início das férias responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/deleteVacationLeaveHistory: post: description: Realiza a exclusão do histórico de afastamento de férias tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – startDate properties: employeeId: type: string maxLength: 36 description: ID do colaborador startDate: type: string format: date description: Data de início das férias responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/deleteEmployeeResignationHistory: post: description: Realiza a exclusão do histórico de desligamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string maxLength: 36 description: ID do colaborador responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/deleteEmployeeResignationHistoryBatch: post: description: Realiza a exclusão do histórico de desligamento em lote. Exclusivo para uso interno do sistema. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeIdList properties: employeeIdList: type: array items: type: string minimum: 1 description: Lista de IDs dos colaboradores responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/transferEmployeeAdditionalInformation: post: description: Realiza a transferência de informações de históricos eventuais de um colaborador para o outro. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transferDate – summaryId – originalEmployee – newEmployee properties: transferDate: type: string format: date description: Data da transferência summaryId: type: string maxLength: 36 description: Identificador do processo originalEmployee: type: object allOf: – #/definitions/genericIdDTO description: Colaborador de origem newEmployee: type: object allOf: – #/definitions/genericIdDTO description: Colaborador que receberá os históricos com base na origem responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/undoTransferEmployeeAdditionalInformation: post: description: Reverte a transferência de informações de históricos eventuais de um colaborador para o outro. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transferDate – summaryId – employee properties: transferDate: type: string format: date description: Data da transferência summaryId: type: string maxLength: 36 description: Identificador do processo employee: type: object allOf: – #/definitions/genericIdDTO description: Colaborador que terá os históricos excluídos. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/actions/importAnnotationHistory: 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 /employment_additional_info/actions/importCauseDismissal: 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 /employment_additional_info/actions/importAnnotationHistoryAttachment: 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 /employment_additional_info/actions/importDismissalReasonEsocial: 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 /employment_additional_info/actions/importResignationHistory: 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 /employment_additional_info/actions/importLeaveHistory: 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 /employment_additional_info/actions/importResignationHistoryAttachment: 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 /employment_additional_info/actions/importLeaveHistoryAttachment: 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 /employment_additional_info/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 /employment_additional_info/actions/importCompanyBranchHistory: 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 /employment_additional_info/actions/importExclusionProcess: 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 /employment_additional_info/actions/importExclusionProcessStepGroup: 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 /employment_additional_info/actions/importExclusionProcessStep: 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 /employment_additional_info/actions/importAnnotationType: 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 /employment_additional_info/actions/importAnnotationTypeStructure: 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 /employment_additional_info/actions/importAnnotationTypeStructureCompanyHistory: 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 /employment_additional_info/actions/importE001pes: 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 /employment_additional_info/actions/importSituation: 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 /employment_additional_info/actions/importDisease: 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 /employment_additional_info/actions/importDiseaseSubgroup: 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 /employment_additional_info/actions/importE070emp: 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 /employment_additional_info/actions/importEmploymentRelationship: 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 /employment_additional_info/actions/importESocialReason: 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 /employment_additional_info/actions/importSituationStructure: 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 /employment_additional_info/actions/importSituationStructureCompanyHistory: 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 /employment_additional_info/actions/importE070fil: 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 /employment_additional_info/actions/importStabilityHistory: 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 /employment_additional_info/actions/importEmployeeSnapshot: 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 /employment_additional_info/actions/importPositionSnapshot: 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 /employment_additional_info/actions/importPositionSnapshotVersion: 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 /employment_additional_info/actions/importEmployeeModule: 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 /employment_additional_info/actions/importEmployeeReintegration: 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 /employment_additional_info/signals/cancelBatchProcess: post: description: Efetua o cancelamento de um processo coletivo tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/batchProcessDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_additional_info/signals/finishBatchProcess: post: description: Emite a notificação para o usuário ao finalizar um processo coletivo tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/batchProcessDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_additional_info/signals/stabilityHistoryBatchItem: post: description: Inclusão de itens de histórico de estabilidade por lote tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/stabilityHistoryBatchItemDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_additional_info/signals/annotationHistoryBatchItem: post: description: Inclusão de itens de histórico de anotação por lote tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/annotationHistoryBatchItemDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_additional_info/signals/leaveHistoryBatchItem: post: description: Inclusão de itens de histórico de afastamento por lote tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/leaveHistoryBatchItemDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_additional_info/signals/stabilityHistoryBatchItemDelete: post: description: Exclusão de itens de histórico de estabilidade por lote tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/stabilityHistoryBatchItemDeleteDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_additional_info/signals/annotationHistoryBatchItemDelete: post: description: Exclusão de itens de histórico de anotação por lote tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/annotationHistoryBatchItemDeleteDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_additional_info/signals/leaveHistoryBatchItemDelete: post: description: Exclusão de itens de histórico de afastamento por lote tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/leaveHistoryBatchItemDeleteDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_additional_info/signals/employeeAdditionalInfoSave: post: description: Salvar as informações adicionais do colaborador tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – batchDescription properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote de colaboradores. batchDescription: type: string description: Descrição logDebugEnabled: type: boolean description: Log de depuração habilitado default: false monitorEnabled: type: boolean description: Monitor habilitado default: false calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final disregardedDays: type: array items: type: string format: date description: Dias a desconsiderar hiredInTheYearWithBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano com saldo de férias hiredInTheYearWithoutBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano sem saldo de férias responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_additional_info/signals/startExclusionProcess: post: description: Inicia um processo de exclusão tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – pid properties: pid: type: string description: Id do Processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /employment_additional_info/events/employeeDismissalDateChanged: post: description: Mudança na data de desligamento do colaborador x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string maxLength: 36 description: Identificador único do colaborador dismissalDate: type: string format: date description: Nova data de desligamento isTransfer: type: boolean description: Indica se é uma transferência entre empresas default: false responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_additional_info/events/employeeLeaveHistoryModified: post: description: Evento para sinalização de ações no histórico de afastamento do colaborador x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id – startDate – endDate properties: id: type: string description: Identificador Único startDate: type: string format: date description: Data Inicial endDate: type: string format: date description: Data final responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_additional_info/events/employeeAdditionalInfoSaveFinished: post: description: Notifica a finalização da gravação das informações adicionais do colaborador x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – batchDescription properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote de colaboradores. batchDescription: type: string description: Descrição logDebugEnabled: type: boolean description: Log de depuração habilitado default: false monitorEnabled: type: boolean description: Monitor habilitado default: false calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final disregardedDays: type: array items: type: string format: date description: Dias a desconsiderar hiredInTheYearWithBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano com saldo de férias hiredInTheYearWithoutBalance: type: string allOf: – #/definitions/hiredInCurrentYearType description: Admitidos no ano sem saldo de férias responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_additional_info/events/legacyEntityChanged: post: description: Evento genérico de mudança numa entidade que possui integração de volta para o HCM x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/legacyEntityOperation responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_additional_info/events/legacyLeaveHistoryChanged: post: description: Evento de mudança do histórico de afastamento para a integração de volta para o HCM x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – operation – details properties: operation: type: object allOf: – #/definitions/legacyEntityOperation description: Operação realizada details: type: object allOf: – #/definitions/leaveHistory description: Detalhes da operação realizada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_additional_info/events/exclusionProcessStatusChanged: post: description: Evento responsável por informar mudança no status do processo de exclusão x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – pid – entityName – recordId – description – status properties: pid: type: string description: Identificador do processo de exclusão entityName: type: string description: Nome da entidade recordId: type: string description: Identificador do registro description: type: string description: Descrição do registro status: type: string allOf: – #/definitions/enumExclusionProcessStatus description: Status responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /employment_additional_info/events/importAnnotationHistoryEvent: 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 /employment_additional_info/events/exportAnnotationHistoryEvent: 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 /employment_additional_info/events/importCauseDismissalEvent: 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 /employment_additional_info/events/exportCauseDismissalEvent: 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 /employment_additional_info/events/importAnnotationHistoryAttachmentEvent: 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 /employment_additional_info/events/exportAnnotationHistoryAttachmentEvent: 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 /employment_additional_info/events/importDismissalReasonEsocialEvent: 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 /employment_additional_info/events/exportDismissalReasonEsocialEvent: 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 /employment_additional_info/events/importResignationHistoryEvent: 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 /employment_additional_info/events/exportResignationHistoryEvent: 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 /employment_additional_info/events/importLeaveHistoryEvent: 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 /employment_additional_info/events/exportLeaveHistoryEvent: 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 /employment_additional_info/events/importResignationHistoryAttachmentEvent: 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 /employment_additional_info/events/exportResignationHistoryAttachmentEvent: 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 /employment_additional_info/events/importLeaveHistoryAttachmentEvent: 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 /employment_additional_info/events/exportLeaveHistoryAttachmentEvent: 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 /employment_additional_info/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 /employment_additional_info/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 /employment_additional_info/events/importCompanyBranchHistoryEvent: 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 /employment_additional_info/events/exportCompanyBranchHistoryEvent: 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 /employment_additional_info/events/importExclusionProcessEvent: 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 /employment_additional_info/events/exportExclusionProcessEvent: 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 /employment_additional_info/events/importExclusionProcessStepGroupEvent: 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 /employment_additional_info/events/exportExclusionProcessStepGroupEvent: 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 /employment_additional_info/events/importExclusionProcessStepEvent: 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 /employment_additional_info/events/exportExclusionProcessStepEvent: 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 /employment_additional_info/events/importAnnotationTypeEvent: 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 /employment_additional_info/events/exportAnnotationTypeEvent: 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 /employment_additional_info/events/importAnnotationTypeStructureEvent: 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 /employment_additional_info/events/exportAnnotationTypeStructureEvent: 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 /employment_additional_info/events/importAnnotationTypeStructureCompanyHistoryEvent: 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 /employment_additional_info/events/exportAnnotationTypeStructureCompanyHistoryEvent: 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 /employment_additional_info/events/importE001pesEvent: 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 /employment_additional_info/events/exportE001pesEvent: 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 /employment_additional_info/events/importSituationEvent: 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 /employment_additional_info/events/exportSituationEvent: 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 /employment_additional_info/events/importDiseaseEvent: 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 /employment_additional_info/events/exportDiseaseEvent: 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 /employment_additional_info/events/importDiseaseSubgroupEvent: 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 /employment_additional_info/events/exportDiseaseSubgroupEvent: 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 /employment_additional_info/events/importE070empEvent: 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 /employment_additional_info/events/exportE070empEvent: 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 /employment_additional_info/events/importEmploymentRelationshipEvent: 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 /employment_additional_info/events/exportEmploymentRelationshipEvent: 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 /employment_additional_info/events/importESocialReasonEvent: 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 /employment_additional_info/events/exportESocialReasonEvent: 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 /employment_additional_info/events/importSituationStructureEvent: 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 /employment_additional_info/events/exportSituationStructureEvent: 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 /employment_additional_info/events/importSituationStructureCompanyHistoryEvent: 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 /employment_additional_info/events/exportSituationStructureCompanyHistoryEvent: 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 /employment_additional_info/events/importE070filEvent: 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 /employment_additional_info/events/exportE070filEvent: 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 /employment_additional_info/events/importStabilityHistoryEvent: 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 /employment_additional_info/events/exportStabilityHistoryEvent: 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 /employment_additional_info/events/importEmployeeSnapshotEvent: 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 /employment_additional_info/events/exportEmployeeSnapshotEvent: 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 /employment_additional_info/events/importPositionSnapshotEvent: 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 /employment_additional_info/events/exportPositionSnapshotEvent: 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 /employment_additional_info/events/importPositionSnapshotVersionEvent: 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 /employment_additional_info/events/exportPositionSnapshotVersionEvent: 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 /employment_additional_info/events/importEmployeeModuleEvent: 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 /employment_additional_info/events/exportEmployeeModuleEvent: 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 /employment_additional_info/events/importEmployeeReintegrationEvent: 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 /employment_additional_info/events/exportEmployeeReintegrationEvent: 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 /employment_additional_info/entities/annotationHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/annotationHistory responses: 200: description: The created resource schema: #/definitions/annotationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/annotationHistory responses: 200: description: The created resource schema: #/definitions/annotationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/annotationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/annotationHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAnnotationHistory responses: 200: description: Ok schema: #/definitions/editAnnotationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/annotationHistory responses: 200: description: Ok schema: #/definitions/annotationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/annotationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/annotationHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/annotationHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/causeDismissal: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/causeDismissal responses: 200: description: The created resource schema: #/definitions/causeDismissal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/causeDismissal responses: 200: description: The created resource schema: #/definitions/causeDismissal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/causeDismissal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/causeDismissal/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCauseDismissal responses: 200: description: Ok schema: #/definitions/editCauseDismissal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/causeDismissal responses: 200: description: Ok schema: #/definitions/causeDismissal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/causeDismissal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/causeDismissal/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/causeDismissal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/annotationHistory/{parentId}/annotationHistoryAttachments: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/annotationHistoryAttachment responses: 200: description: The created resources schema: type: array items: #/definitions/annotationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/annotationHistoryAttachment responses: 200: description: The created resources schema: type: array items: #/definitions/annotationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/annotationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/annotationHistory/{parentId}/annotationHistoryAttachments/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAnnotationHistoryAttachment responses: 200: description: Ok schema: #/definitions/editAnnotationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/annotationHistoryAttachment responses: 200: description: Ok schema: #/definitions/annotationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/annotationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/dismissalReasonEsocial: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dismissalReasonEsocial responses: 200: description: The created resource schema: #/definitions/dismissalReasonEsocial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dismissalReasonEsocial responses: 200: description: The created resource schema: #/definitions/dismissalReasonEsocial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dismissalReasonEsocial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/dismissalReasonEsocial/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDismissalReasonEsocial responses: 200: description: Ok schema: #/definitions/editDismissalReasonEsocial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dismissalReasonEsocial responses: 200: description: Ok schema: #/definitions/dismissalReasonEsocial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dismissalReasonEsocial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/dismissalReasonEsocial/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dismissalReasonEsocial responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/resignationHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/resignationHistory responses: 200: description: The created resource schema: #/definitions/resignationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/resignationHistory responses: 200: description: The created resource schema: #/definitions/resignationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/resignationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/resignationHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editResignationHistory responses: 200: description: Ok schema: #/definitions/editResignationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/resignationHistory responses: 200: description: Ok schema: #/definitions/resignationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/resignationHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/resignationHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/resignationHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/leaveHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/leaveHistory responses: 200: description: The created resource schema: #/definitions/leaveHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/leaveHistory responses: 200: description: The created resource schema: #/definitions/leaveHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/leaveHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/leaveHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editLeaveHistory responses: 200: description: Ok schema: #/definitions/editLeaveHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/leaveHistory responses: 200: description: Ok schema: #/definitions/leaveHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/leaveHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/leaveHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/leaveHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/resignationHistoryAttachment: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/resignationHistoryAttachment responses: 200: description: The created resource schema: #/definitions/resignationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/resignationHistoryAttachment responses: 200: description: The created resource schema: #/definitions/resignationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/resignationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/resignationHistoryAttachment/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editResignationHistoryAttachment responses: 200: description: Ok schema: #/definitions/editResignationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/resignationHistoryAttachment responses: 200: description: Ok schema: #/definitions/resignationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/resignationHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/resignationHistoryAttachment/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/resignationHistoryAttachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/leaveHistory/{parentId}/leaveHistoryAttachments: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/leaveHistoryAttachment responses: 200: description: The created resources schema: type: array items: #/definitions/leaveHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/leaveHistoryAttachment responses: 200: description: The created resources schema: type: array items: #/definitions/leaveHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/leaveHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/leaveHistory/{parentId}/leaveHistoryAttachments/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editLeaveHistoryAttachment responses: 200: description: Ok schema: #/definitions/editLeaveHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/leaveHistoryAttachment responses: 200: description: Ok schema: #/definitions/leaveHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/leaveHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/exclusionProcess: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/exclusionProcessStepGroup: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/exclusionProcess/{parentId}/groups: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/exclusionProcessStepGroup responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/exclusionProcessStepGroup responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/exclusionProcess/{parentId}/groups/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editExclusionProcessStepGroup responses: 200: description: Ok schema: #/definitions/editExclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/exclusionProcessStepGroup responses: 200: description: Ok schema: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/exclusionProcessStep: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/exclusionProcessStepGroup/{parentId}/steps: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/exclusionProcessStep responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/exclusionProcessStep responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/exclusionProcessStepGroup/{parentId}/steps/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editExclusionProcessStep responses: 200: description: Ok schema: #/definitions/editExclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/exclusionProcessStep responses: 200: description: Ok schema: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/stabilityHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/stabilityHistory responses: 200: description: The created resource schema: #/definitions/stabilityHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/stabilityHistory responses: 200: description: The created resource schema: #/definitions/stabilityHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/stabilityHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/stabilityHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editStabilityHistory responses: 200: description: Ok schema: #/definitions/editStabilityHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/stabilityHistory responses: 200: description: Ok schema: #/definitions/stabilityHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/stabilityHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/stabilityHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/stabilityHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/employee/{parentId}/employeeSnapshot: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeSnapshot responses: 200: description: The created resource schema: #/definitions/employeeSnapshot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeSnapshot responses: 200: description: The created resource schema: #/definitions/employeeSnapshot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeSnapshot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/employee/{parentId}/employeeSnapshot/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmployeeSnapshot responses: 200: description: Ok schema: #/definitions/editEmployeeSnapshot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeSnapshot responses: 200: description: Ok schema: #/definitions/employeeSnapshot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeSnapshot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/employeeModule: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeModule responses: 200: description: The created resource schema: #/definitions/employeeModule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeModule responses: 200: description: The created resource schema: #/definitions/employeeModule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeModule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/employeeModule/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmployeeModule responses: 200: description: Ok schema: #/definitions/editEmployeeModule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeModule responses: 200: description: Ok schema: #/definitions/employeeModule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeModule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/employeeModule/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeModule responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/employeeReintegration: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeReintegration responses: 200: description: The created resource schema: #/definitions/employeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeReintegration responses: 200: description: The created resource schema: #/definitions/employeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/employeeReintegration/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmployeeReintegration responses: 200: description: Ok schema: #/definitions/editEmployeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeReintegration responses: 200: description: Ok schema: #/definitions/employeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/resignationHistory/{parentId}/employeeReintegration: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeReintegration responses: 200: description: The created resource schema: #/definitions/employeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeReintegration responses: 200: description: The created resource schema: #/definitions/employeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/resignationHistory/{parentId}/employeeReintegration/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEmployeeReintegration responses: 200: description: Ok schema: #/definitions/editEmployeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeReintegration responses: 200: description: Ok schema: #/definitions/employeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeReintegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /employment_additional_info/entities/employeeReintegration/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeReintegration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: heathcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim statusType: type: string enum: – ERROR – SUCCESS description: Tipo do resultado da operação: * `ERROR` – Erro * `SUCCESS` – Sucesso eSocialDismissalType: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 – V21 – V22 – V23 – V24 – V25 – V26 – V27 – V28 – V29 – V30 – V31 – V32 – V33 – V34 – V35 – V37 – V38 – V39 – V40 – V41 – V42 – V43 – V44 – V45 – V46 – V47 – V48 – V49 description: Tipo de desligamento eSocial: * `V0` – 0 – Não enviar ao eSocial * `V1` – 1 – Rescisão com justa causa, por iniciativa do empregador * `V2` – 2 – Rescisão sem justa causa, por iniciativa do empregador * `V3` – 3 – Rescisão antecipada do contrato a termo por iniciativa do empregador * `V4` – 4 – Rescisão antecipada do contrato a termo por iniciativa do empregado * `V5` – 5 – Rescisão por culpa recíproca * `V6` – 6 – Rescisão por término do contrato a termo * `V7` – 7 – Rescisão do contrato de trabalho por iniciativa do empregado * `V8` – 8 – Rescisão do contrato de trabalho por interesse do(a) empregado(a), nas hipóteses previstas nos arts. 394 e 483, § 1º, da CLT * `V9` – 9 – Rescisão por opção do empregado em virtude de falecimento do empregador individual ou empregador doméstico * `V10` – 10 – Rescisão por falecimento do empregado * `V11` – 11 – Transferência de empregado para empresa do mesmo grupo empresarial que tenha assumido os encargos trabalhistas, sem que tenha havido rescisão do contrato de trabalho * `V12` – 12 – Transferência de empregado da empresa consorciada para o consórcio que tenha assumido os encargos trabalhistas, e vice-versa, sem que tenha havido rescisão do contrato de trabalho * `V13` – 13 – Transferência de empregado de empresa ou consórcio, para outra empresa ou consórcio que tenha assumido os encargos trabalhistas por motivo de sucessão (fusão, cisão ou incorporação), sem que tenha havido rescisão do contrato de trabalho * `V14` – 14 – Rescisão do contrato de trabalho por encerramento da empresa, de seus estabelecimentos ou supressão de parte de suas atividades ou falecimento do empregador individual ou empregador doméstico sem continuação da atividade * `V15` – 15 – Rescisão do contrato de aprendizagem por desempenho insuficiente, inadaptação ou ausência injustificada do aprendiz à escola que implique perda do ano letivo (Válido até 18/07/2021) * `V16` – 16 – Declaração de nulidade do contrato de trabalho por infringência ao inciso II do art. 37 da Constituição Federal, quando mantido o direito ao salário * `V17` – 17 – Rescisão indireta do contrato de trabalho * `V18` – 18 – Aposentadoria compulsória (Válido até 18/07/2021) * `V19` – 19 – Aposentadoria por idade (Válido até 18/07/2021) * `V20` – 20 – Aposentadoria por idade e tempo de contribuição (Válido até 18/07/2021) * `V21` – 21 – Reforma militar * `V22` – 22 – Reserva militar * `V23` – 23 – Exoneração * `V24` – 24 – Demissão * `V25` – 25 – Vacância de cargo efetivo * `V26` – 26 – Rescisão do contrato de trabalho por paralisação temporária ou definitiva da empresa, estabelecimento ou parte das atividades motivada por atos de autoridade municipal, estadual ou federal * `V27` – 27 – Rescisão por motivo de força maior * `V28` – 28 – Término da cessão/requisição (Válido até 18/07/2021) * `V29` – 29 – Redistribuição * `V30` – 30 – Mudança de regime trabalhista * `V31` – 31 – Reversão de reintegração * `V32` – 32 – Extravio de militar * `V33` – 33 – Rescisão por acordo entre as partes (art. 484-A da CLT) * `V34` – 34 – Transferência de titularidade do empregado doméstico para outro representante da mesma unidade familiar * `V35` – 35 – Extinção do contrato de trabalho intermitente (Válido até 30/06/2018) * `V37` – 37 – Remoção, em caso de alteração do órgão declarante * `V38` – 38 – Aposentadoria, exceto por invalidez * `V39` – 39 – Aposentadoria de servidor estatutário, por invalidez * `V40` – 40 – Término do exercício do mandato eletivo * `V41` – 41 – Rescisão do contrato de aprendizagem por desempenho insuficiente ou inadaptação do aprendiz * `V42` – 42 – Rescisão do contrato de aprendizagem por ausência injustificada do aprendiz à escola que implique perda do ano letivo * `V43` – 43 – Transferência de empregado de empresa considerada inapta por inexistência de fato * `V44` – 44 – Agrupamento contratual * `V45` – 45 – Exclusão de militar das Forças Armadas do serviço ativo, com efeitos financeiros * `V46` – 46 – Exclusão de militar das Forças Armadas do serviço ativo, sem efeitos financeiros * `V47` – 47 – Rescisão do contrato de trabalho por encerramento da empresa, de seus estabelecimentos ou supressão de parte de suas atividades * `V48` – 48 – Falecimento do empregador individual sem continuação da atividade * `V49` – 49 – Falecimento do empregador doméstico sem continuação da atividade dismissalType: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V99 description: Tipo de desligamento: * `V0` – 0 – Não enviar ao eSocial * `V1` – 1 – Exoneração do diretor não empregado sem justa causa, por deliberação da assembleia, dos sócios cotistas ou da autoridade competente * `V2` – 2 – Término de mandato do diretor não empregado que não tenha sido reconduzido ao cargo * `V3` – 3 – Exoneração a pedido de diretor não empregado * `V4` – 4 – Exoneração do diretor não empregado por culpa recíproca ou força maior * `V5` – 5 – Morte do diretor não empregado * `V6` – 6 – Exoneração do diretor não empregado por falência, encerramento ou supressão de parte da empresa * `V7` – 7 – Mudança de CPF * `V99` – 99 – Outros successorSubscriptionType: type: string enum: – CPF – CNPJ description: Tipo de inscrição sucessora: * `CPF` – CPF * `CNPJ` – CNPJ workAccidentType: type: string enum: – V1 – V2 – V3 description: Tipo de acidente de trabalho: * `V1` – 1 – Atropelamento * `V2` – 2 – Colisão * `V3` – 3 – Outros onusRemuneration: type: string enum: – V1 – V2 – V3 description: Ônus pela remuneração: * `V1` – 1 – Apenas do empregador * `V2` – 2 – Apenas do sindicato * `V3` – 3 – Parte do empregador, sendo a diferença e/ou complementação salarial paga pelo sindicato sourceReasonChange: type: string enum: – V1 – V2 – V3 description: Origem da mudança: * `V1` – 1 – Por iniciativa do empregador * `V2` – 2 – Revisão administrativa * `V3` – 3 – Determinação judicial processType: type: string enum: – V1 – V2 – V3 description: Tipo do Processo: * `V1` – 1 – Administrativo * `V2` – 2 – Judicial * `V3` – 3 – Número de Benefício – NB do INSS situationType: type: string enum: – WORKING – VACATION – ILLNESSAID – LABORACCIDENT – MILITARYSERVICE – MATERNITYLEAVE – MATERNITYLEAVENONCRIMINALABORTION – MATERNITYLEAVEANTICIPATIONEXTENSION – CITIZENCOMPANYMATERNITY – INSSMATERNITYLEAVE – LEAVEWITHOUTCOMPENSATION – PAIDLEAVE – PATERNITYLEAVE – CITIZENCOMPANYPATERNITY – COLLECTIVEVACATION – MEDICALLEAVE – MEDICALLEAVEWITHOUTINSS – ABSENCES – OVERTIME – TIMEEVALUATIONSITUATION – PRECAUTIONREADINESS – TRADEUNIONMANDATE – WORKACCIDENTLEAVE – WORKACCIDENTLEAVEWITHOUTINSS – RETIREMENTDUETODISABILITY – PROFESSIONALQUALIFICATION – PRIORNOTICEHOURSWORKED – OTHERS – REINSTATEMENT description: Tipo da situação: * `WORKING` – Trabalhando * `VACATION` – Férias * `ILLNESSAID` – Auxílio doença * `LABORACCIDENT` – Acidente de trabalho * `MILITARYSERVICE` – Serviço militar * `MATERNITYLEAVE` – Licença maternidade * `MATERNITYLEAVENONCRIMINALABORTION` – Licença maternidade – Aborto não criminoso * `MATERNITYLEAVEANTICIPATIONEXTENSION` – Licença maternidade – Prorrogação mediante atestado médico * `CITIZENCOMPANYMATERNITY` – Licença maternidade – Empresa cidadã * `INSSMATERNITYLEAVE` – Licença maternidade INSS * `LEAVEWITHOUTCOMPENSATION` – Licença sem remuneração * `PAIDLEAVE` – Licença remunerada * `PATERNITYLEAVE` – Licença paternidade * `CITIZENCOMPANYPATERNITY` – Licença paternidade – Empresa cidadã * `COLLECTIVEVACATION` – Férias coletivas * `MEDICALLEAVE` – Licença médica (pgto Empresa) * `MEDICALLEAVEWITHOUTINSS` – Licença médica sem incidência INSS * `ABSENCES` – Faltas * `OVERTIME` – Horas extras * `TIMEEVALUATIONSITUATION` – Situação de apuração ponto * `PRECAUTIONREADINESS` – Sobreaviso/Prontidão * `TRADEUNIONMANDATE` – Mandato sindical * `WORKACCIDENTLEAVE` – Licença acidente de trabalho (pgto empresa) * `WORKACCIDENTLEAVEWITHOUTINSS` – Licença acidente de trabalho sem incidência INSS * `RETIREMENTDUETODISABILITY` – Apostentadoria por invalidez * `PROFESSIONALQUALIFICATION` – Qualificação profissional * `PRIORNOTICEHOURSWORKED` – Aviso prévio trabalhado * `OTHERS` – Outros * `REINSTATEMENT` – Contrato temporariamente suspenso – Reintegração contractType: type: string enum: – EMPLOYEE – DIRECTOR – TRAINEE – APRENTICE – THIRD_PARTY description: Tipo de contrato: * `EMPLOYEE` – Empregado * `DIRECTOR` – Diretor * `TRAINEE` – Estagiário * `APRENTICE` – Aprendiz * `THIRD_PARTY` – Terceiro eSocialReasonType: type: string enum: – V0 – V1 – V3 – V5 – V6 – V7 – V8 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 – V21 – V22 – V23 – V24 – V25 – V26 – V27 – V28 – V29 – V30 – V31 – V33 – V34 – V35 – V36 – V37 – V38 description: Motivo afastamento e-social: * `V0` – 0 – Não enviar * `V1` – 1 – Acidente/Doença do trabalho * `V3` – 3 – Acidente/Doença não relacionada ao trabalho * `V5` – 5 – Afastamento/licença prevista em regime próprio (estatuto), sem remuneração * `V6` – 6 – Aposentadoria por invalidez * `V7` – 7 – Acompanhamento – Licença para acompanhamento de membro da família enfermo * `V8` – 8 – Afastamento do empregado para participar de atividade do Conselho Curador do FGTS – art. 65, §6º, Dec. 99.684/90 (Regulamento do FGTS) * `V10` – 10 – Afastamento/licença prevista em regime próprio (estatuto), com remuneração * `V11` – 11 – Cárcere * `V12` – 12 – Cargo Eletivo – Candidato a cargo eletivo – Art. 25, parágrafo único, da Lei 7.664/1988 – Celetistas em geral * `V13` – 13 – Cargo Eletivo – Candidato a cargo eletivo – Art. 1°, inciso II, alínea “l” da Lei Complementar 64/1990 – Servidor público, estatutário ou não, dos órgãos ou entidades da Administração Direta ou Indireta da União, dos Estados, do Distrito Federal, dos Municípios e dos Territórios, inclusive das fundações mantidas pelo Poder Público. * `V14` – 14 – Cessão / Requisição * `V15` – 15 – Gozo de férias ou recesso – Afastamento temporário para o gozo de férias ou recesso * `V16` – 16 – Licença remunerada – Lei, liberalidade da empresa ou Acordo/Convenção Coletiva de Trabalho * `V17` – 17 – Licença Maternidade * `V18` – 18 – Licença maternidade – Prorrogação por 60 dias, Lei 11.770/2008 (Empresa Cidadã), inclusive para o cônjuge sobrevivente * `V19` – 19 – Licença Maternidade – Afastamento temporário por motivo de aborto não criminoso * `V20` – 20 – Licença maternidade – Afastamento temporário por motivo de licença-maternidade para o cônjuge sobrevivente ou decorrente de adoção ou de guarda judicial de criança * `V21` – 21 – Licença não remunerada ou Sem Vencimento * `V22` – 22 – Mandato eleitoral – Afastamento temporário para o exercício de mandato eleitoral * `V23` – 23 – Mandato Eleitoral – Afastamento temporário para o exercício de mandato eleitoral, com remuneração * `V24` – 24 – Mandato Sindical – Afastamento temporário para exercício de mandato sindical * `V25` – 25 – Mulher vítima de violência – Art. 9º, § 2º, inciso II, da Lei 11.340/2006 – Lei Maria da Penha * `V26` – 26 – Participação de empregado no Conselho Nacional de Previdência Social – CNPS – Art. 3º da Lei 8.213/1991 * `V27` – 27 – Qualificação – Afastamento por suspensão do contrato de acordo com o art 476-A da CLT * `V28` – 28 – Representante Sindical – Afastamento pelo tempo que se fizer necessário, quando, na qualidade de representante de entidade sindical, estiver participando de reunião oficial de organismo internacional do qual o Brasil seja membro * `V29` – 29 – Serviço Militar – Afastamento temporário para prestar serviço militar obrigatório * `V30` – 30 – Suspensão disciplinar – Art. 474 da CLT * `V31` – 31 – Servidor público em disponibilidade * `V33` – 33 – Licença maternidade – 180 dias, Lei 13.301/2016 * `V34` – 34 – Inatividade do trabalhador avulso (portuário ou não portuário) por período superior a 90 dias * `V35` – 35 – Licença maternidade – Antecipação e/ou prorrogação mediante atestado médico * `V36` – 36 – Afastamento temporário de exercente de mandato eletivo para cargo em comissão * `V37` – 37 – Suspensão temporária do contrato de trabalho nos termos da Lei 14.020/2020 (conversão da MP 936/2020) * `V38` – 38 – Impedimento de concorrência à escala para trabalho avulso enumJurFis: type: string enum: – VJ – VF description: Tipo de pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física stabilityType: type: string enum: – LABOR_ACCIDENT – ACCIDENT_PREVENTION_COMMITTEE – COOPERATIVE_LEADER – ELECTED_EMPLOYEE_REPRESENTATIVES_COMMISSION – PROVIDED_COLLECTIVE_NEGOTIATION – PREGNANCY – TRADE_UNION_MANDATE – MATERNITY_LEAVE – MEMBER_BOARD_TRUSTEES_FGTS – MEMBER_NATIONAL_SOCIAL_WELFARE_COUNCIL – PEOPLE_WITH_DISABILITIES – WORKDAY_REDUCTION_COVID19 – MILITARY_SERVICE – TEMPORARY_SUSPENSION_COVID19 description: Tipo de estabilidade: * `LABOR_ACCIDENT` – Acidente de trabalho * `ACCIDENT_PREVENTION_COMMITTEE` – CIPA * `COOPERATIVE_LEADER` – Dirigente de cooperativa * `ELECTED_EMPLOYEE_REPRESENTATIVES_COMMISSION` – Eleito na comissão de representação dos empregados * `PROVIDED_COLLECTIVE_NEGOTIATION` – Estabilidade prevista em convenção/acordo coletivo * `PREGNANCY` – Gravidez * `TRADE_UNION_MANDATE` – Mandato sindical * `MATERNITY_LEAVE` – Maternidade * `MEMBER_BOARD_TRUSTEES_FGTS` – Membro do conselho curador de FGTS * `MEMBER_NATIONAL_SOCIAL_WELFARE_COUNCIL` – Membro do conselho nacional de previdência * `PEOPLE_WITH_DISABILITIES` – Pessoa com deficiência (PCD) * `WORKDAY_REDUCTION_COVID19` – Redução da jornada (COVID-19) * `MILITARY_SERVICE` – Serviço militar * `TEMPORARY_SUSPENSION_COVID19` – Suspensão temporária (COVID-19) originType: type: string enum: – SITUATION – COLLECTIVE_NEGOTIATION – ADD_BY_USER description: Origem: * `SITUATION` – Cadastro da situação * `COLLECTIVE_NEGOTIATION` – Cadastro da convenção/acordo coletivo * `ADD_BY_USER` – Digitada pelo usuário eSocialTrainingCodeType: type: string enum: – V1006 – V1207 description: Código de treinamento eSocial: * `V1006` – 1006 – Autorização para trabalhar em instalações elétricas * `V1207` – 1207 – Operação e realização de intervenções em máquinas annotationFinalityType: type: string enum: – SUCCESSION – SALARY_DESCRIPTION_START – SALARY_DESCRIPTION_END – DEFICIENCY – WORK_CONTRACT_OBSERVATIONS – ELECTRICAL_INSTALLATIONS_WORK_AUTHORIZATION – INTERVENTIONS_ON_MACHINE – CRANE_EQUIPMENT_OPERATOR – TRAINING – WORK_SCHEDULE_ART_62_INC_1_START – WORK_SCHEDULE_ART_62_INC_1_END – WORK_SCHEDULE_ART_62_INC_2_START – WORK_SCHEDULE_ART_62_INC_2_END – WORK_SCHEDULE_ART_62_INC_3_START – WORK_SCHEDULE_ART_62_INC_3_END – CNPJ_TRANSFER – OTHERS description: Finalidade anotação: * `SUCCESSION` – Sucessão * `SALARY_DESCRIPTION_START` – Descrição de salário: início * `SALARY_DESCRIPTION_END` – Descrição de salário: fim * `DEFICIENCY` – Deficiência * `WORK_CONTRACT_OBSERVATIONS` – Observações do contrato de trabalho * `ELECTRICAL_INSTALLATIONS_WORK_AUTHORIZATION` – Autorização para trabalhar em Instalações elétricas * `INTERVENTIONS_ON_MACHINE` – Operação e realização de intervenções em máquinas * `CRANE_EQUIPMENT_OPERATOR` – Operador do equipamento de guindar * `TRAINING` – Treinamento, Capacitação ou Exercício Simulado * `WORK_SCHEDULE_ART_62_INC_1_START` – Regime de Jornada: CLT Art 62 inciso 1 início * `WORK_SCHEDULE_ART_62_INC_1_END` – Regime de Jornada: CLT Art 62 inciso 1 fim * `WORK_SCHEDULE_ART_62_INC_2_START` – Regime de Jornada: CLT Art 62 inciso 2 início * `WORK_SCHEDULE_ART_62_INC_2_END` – Regime de Jornada: CLT Art 62 inciso 2 fim * `WORK_SCHEDULE_ART_62_INC_3_START` – Regime de Jornada: CLT Art 62 inciso 3 início * `WORK_SCHEDULE_ART_62_INC_3_END` – Regime de Jornada: CLT Art 62 inciso 3 fim * `CNPJ_TRANSFER` – Transferências entre CNPJs * `OTHERS` – Outros directionType: type: string enum: – ASC – DESC description: Tipo de ordenação: * `ASC` – Ascendente * `DESC` – Descendente calculationType: type: string enum: – MONTHLY_PAYROLL – ADVANCE_SALARY – THIRTEENTH_SALARY – ADVANCE_THIRTEENTH_SALARY – INDIVIDUAL_VACATION – COLLECTIVE_VACATION – DISMISSAL – SUPPLEMENTARY_PAYROLL – SUPPLEMENTARY_LABOR_AGREEMENT – SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL – SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION – SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS – SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL description: Tipo de cálculo: * `MONTHLY_PAYROLL` – Folha mensal * `ADVANCE_SALARY` – Adiantamento salarial * `THIRTEENTH_SALARY` – 13º salário integral * `ADVANCE_THIRTEENTH_SALARY` – Adiantamento 13º salário * `INDIVIDUAL_VACATION` – Férias individuais * `COLLECTIVE_VACATION` – Férias coletivas * `DISMISSAL` – Rescisão individual * `SUPPLEMENTARY_PAYROLL` – Folha complementar * `SUPPLEMENTARY_LABOR_AGREEMENT` – Dissídio complementar * `SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL` – Folha de pagamento de dissídio * `SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION` – Rescisão complementar – Erro ou omissão * `SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS` – Rescisão complementar – Comissões pendentes * `SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL` – Rescisão complementar – Dissídio hiredInCurrentYearType: type: string enum: – CURRENT_ACQUISITIVE_PERIOD_REMAINS_OPEN – OPEN_NEW_ACQUISITIVE_PERIOD description: Admitidos no ano: * `CURRENT_ACQUISITIVE_PERIOD_REMAINS_OPEN` – Período aquisitivo permanece aberto. Apenas fecha o período aquisitivo se os dias de direito forem totalmente consumidos. * `OPEN_NEW_ACQUISITIVE_PERIOD` – Abre novo período aquisitivo. trafficAccidentType: type: string enum: – V1 – V2 – V3 description: Tipo de acidente de trânsito: * `V1` – 1 – Atropelamento * `V2` – 2 – Colisão * `V3` – 3 – Outros admissionModuleType: type: string enum: – HCMHRI – HCMFLX – HCMCEM – HCMSF – HCMGRS – HCMAMP description: Tipo de inscrição do estabelecimento no caso de contratação indireta: * `HCMHRI` – HCMHRI – HRIS * `HCMFLX` – HCMFLX – Folha X * `HCMCEM` – HCMCEM – Ponto X * `HCMSF` – HCMSF – Gestão de Desempenho * `HCMGRS` – HCMGRS – Gestão Recrutamento e seleção * `HCMAMP` – HCMAMP – Marcação de ponto 2.0 operationType: type: string enum: – INSERT – UPDATE – DELETE description: Tipo de operação: * `INSERT` – Inserção * `UPDATE` – Atualização * `DELETE` – Exclusão enumExclusionProcessStatus: type: string enum: – PENDING – PROCESSING – ERROR – SUCCESS description: Status do processo de exclusão: * `PENDING` – Pendente * `PROCESSING` – Processando * `ERROR` – Erro * `SUCCESS` – Sucesso reintegrationType: type: string enum: – REINTEGRATION_BY_COURT_DECISION – REINTEGRATION_DUE_TO_LEGAL_AMNESTY – OTHERS description: Tipo da reintegração: * `REINTEGRATION_BY_COURT_DECISION` – 1 – Reintegração por Decisão Judicial * `REINTEGRATION_DUE_TO_LEGAL_AMNESTY` – 2 – Reintegração por Anistia Legal * `OTHERS` – 9 – Outros judgmentPaymentType: type: string enum: – YES – NO description: Tipo do pagamento juízo: * `YES` – Sim * `NO` – Não userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error annotationHistoryByCompanyBranchTransferDTO: description: Dados de entrada para criar ou excluir um histórico de anotação para transferências entre empresas diferentes type: object required: – summaryId – transferDate – originalEmployeeId – newEmployeeId properties: summaryId: type: string maxLength: 36 description: ID do log de processo transferDate: type: string format: date description: Data da transferência originalEmployeeId: type: string maxLength: 36 description: Colaborador antigo newEmployeeId: type: string maxLength: 36 description: Colaborador novo statusTypeDTO: description: Dados de saída representando o resultado da operação type: object required: – statusType properties: statusType: type: string allOf: – #/definitions/statusType description: Tipo do resultado da operação filterBatchDTO: description: Filtro para operações de inclusão e exclusão coletiva type: object properties: companyIds: type: array items: type: string description: ID das empresas employeeIds: type: array items: type: string description: ID dos colaboradores batchDTO: description: DTO base para operações de inclusão e exclusão coletiva discriminator: _discriminator type: object required: – filter – _discriminator properties: filter: type: object allOf: – #/definitions/filterBatchDTO description: Filtro para operações de inclusão e exclusão coletiva _discriminator: type: string description: stabilityHistoryGenericBatchDTO: description: DTO do histórico de estabilidade para operações de inclusão e exclusão coletiva allOf: – #/definitions/batchDTO – type: object required: – stabilityHistories properties: stabilityHistories: type: object allOf: – #/definitions/stabilityHistoryBatchDTO description: DTO do histórico de estabilidade annotationHistoryGenericBatchDTO: description: DTO do histórico de anotação para operações de inclusão e exclusão coletiva allOf: – #/definitions/batchDTO – type: object required: – annotationHistories properties: annotationHistories: type: object allOf: – #/definitions/annotationHistoryBatchDTO description: DTO do histórico de anotação leaveHistoryGenericBatchDTO: description: DTO do histórico de afastamento para operações de inclusão e exclusão coletiva allOf: – #/definitions/batchDTO – type: object required: – leaveHistories properties: leaveHistories: type: object allOf: – #/definitions/leaveHistoryBatchDTO description: DTO do histórico de afastamento stabilityHistoryBatchDTO: description: DTO do histórico de estabilidade allOf: – #/definitions/historyBatchDTO – type: object required: – stabilityType – originType properties: stabilityType: type: string allOf: – #/definitions/stabilityType description: Tipo de estabilidade originType: type: string allOf: – #/definitions/originType description: Origem observation: type: string description: Observação endDate: type: string format: date description: Término da estabilidade annotationHistoryBatchDTO: description: DTO do histórico de anotação allOf: – #/definitions/historyBatchDTO – type: object required: – annotationTypeId – sequence properties: annotationTypeId: type: string maxLength: 36 description: Id do tipo de anotação documentNumber: type: string maxLength: 20 description: Numero do documento annotation: type: string maxLength: 999 description: Anotação responsibleId: type: string maxLength: 36 description: Id do responsável sequence: type: integer format: int64 description: Sequência leaveHistoryBatchDTO: description: DTO do histórico de afastamento allOf: – #/definitions/historyBatchDTO – type: object required: – situationId properties: startTime: type: integer format: int64 description: Hora inicial minimum: 0 maximum: 1439 default: 0 endDate: type: string format: date description: Data final endTime: type: integer format: int64 description: Hora final (Caso uma data final seja definida, o valor padrão desse campo passa a ser 1439) minimum: 0 maximum: 1439 situationId: type: string maxLength: 36 description: Id da situação numberHoursLeft: type: integer format: int64 description: Quantidade de horas faltas sourceReasonChange: type: string allOf: – #/definitions/sourceReasonChange description: Origem da mudança processType: type: string allOf: – #/definitions/processType description: Tipo do processo processNumber: type: string maxLength: 21 description: Número do processo birthDate: type: string format: date description: Data do parto diseaseCidId: type: string maxLength: 36 description: Id do CID da doença subgroupCidId: type: string maxLength: 36 description: Id do CID do subgrupo cnpjUnion: type: integer format: int64 description: CNPJ onusRemuneration: type: string allOf: – #/definitions/onusRemuneration description: Ônus pela remuneração workAccidentType: type: string allOf: – #/definitions/workAccidentType description: Tipo de acidente de trabalho justifiedDays: type: integer format: int64 description: Dias justificados observation: type: string maxLength: 255 description: Observação sameReasonEsocial: type: boolean description: Mesma razão e-social resultedSicknessAssistance: type: boolean description: Resultou em assistência médica estimatedEndDate: type: string format: date description: Data final estimada estimatedDayEnd: type: integer format: int64 description: Dia final estimado maximum: 9999 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/heathcheckDTO description: Status historyBatchDTO: description: DTO base de todos os históricos coletivos discriminator: _discriminator type: object required: – startDate – _discriminator properties: startDate: type: string format: date description: Data de início _discriminator: type: string description: outputBatchDTO: description: DTO de saída para operações de inclusão e exclusão coletiva discriminator: _discriminator type: object required: – summaryId – _discriminator properties: summaryId: type: string maxLength: 36 description: ID do log de processo _discriminator: type: string description: batchItemDTO: description: DTO base para operações por lote de inclusão e exclusão coletiva allOf: – #/definitions/outputBatchDTO – type: object required: – batchId properties: batchId: type: string maxLength: 36 description: ID do lote inclusionBatchItemDTO: description: DTO base para operações por lote de inclusão coletiva allOf: – #/definitions/batchItemDTO – type: object required: – itens properties: itens: type: array items: type: object allOf: – #/definitions/employeeBatchItemDTO minimum: 1 description: Colaboradores a serem processados exclusionBatchItemDTO: description: DTO base para operações por lote de exclusão coletiva allOf: – #/definitions/batchItemDTO – type: object required: – itens properties: itens: type: array items: type: string minimum: 1 description: IDs da entidade a ser processada stabilityHistoryBatchItemDTO: description: DTO do lote de inclusão coletiva de histórico de estabilidade allOf: – #/definitions/inclusionBatchItemDTO – type: object required: – dto properties: dto: type: object allOf: – #/definitions/stabilityHistoryBatchDTO description: DTO do histórico de estabilidade annotationHistoryBatchItemDTO: description: DTO do lote de inclusão coletiva de histórico de anotação allOf: – #/definitions/inclusionBatchItemDTO – type: object required: – dto properties: dto: type: object allOf: – #/definitions/annotationHistoryBatchDTO description: DTO do histórico de anotação leaveHistoryBatchItemDTO: description: DTO do lote de inclusão coletiva de histórico de afastamento allOf: – #/definitions/inclusionBatchItemDTO – type: object required: – dto properties: dto: type: object allOf: – #/definitions/leaveHistoryBatchDTO description: DTO do histórico de afastamento stabilityHistoryBatchItemDeleteDTO: description: DTO do lote de exclusão coletiva de histórico de estabilidade allOf: – #/definitions/exclusionBatchItemDTO – type: object required: – dto properties: dto: type: object allOf: – #/definitions/stabilityHistoryBatchDTO description: DTO do histórico de estabilidade annotationHistoryBatchItemDeleteDTO: description: DTO do lote de exclusão coletiva de histórico de anotação allOf: – #/definitions/exclusionBatchItemDTO – type: object required: – dto properties: dto: type: object allOf: – #/definitions/annotationHistoryBatchDTO description: DTO do histórico de anotação leaveHistoryBatchItemDeleteDTO: description: DTO do lote de exclusão coletiva de histórico de afastamento allOf: – #/definitions/exclusionBatchItemDTO – type: object required: – dto properties: dto: type: object allOf: – #/definitions/leaveHistoryBatchDTO description: DTO do histórico de afastamento employeeBatchItemDTO: description: DTO do colaborador para operações por lote de inclusão coletiva type: object required: – id – code – companyId – companyCode properties: id: type: string maxLength: 36 description: ID do colaborador code: type: integer format: int64 description: Código do colaborador companyId: type: string maxLength: 36 description: ID da empresa companyCode: type: integer format: int64 description: Código da empresa batchProcessDTO: description: DTO de entrada para operações de cancelamento e finalização de um processo coletivo type: object required: – processId properties: processId: type: string maxLength: 36 description: ID do log de processo ordination: description: Definição de ordenação type: object required: – field properties: field: type: string description: Campo da ordenação direction: type: string allOf: – #/definitions/directionType description: Tipo da ordenação leaveHistoryByPeriodAndEmployeesInputDTO: description: DTO de entrada para busca de histórico de afastamento por período e colaboradores type: object required: – startDate – endDate – employeeIds properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final employeeIds: type: array items: type: string minimum: 1 description: Lista de identificadores de colaboradores leaveHistoryByPeriodAndEmployeesOutputDTO: description: DTO de saída para busca de histórico de afastamento por período e colaboradores type: object required: – employeeId – leaveHistoryId properties: employeeId: type: string description: Identificador do colaborador leaveHistoryId: type: array items: type: string minimum: 1 description: Lista de identificadores de históricos de afastamento leaveHistoryWithSituationData: description: Dados do histórico de afastamento que influenciam as férias type: object required: – periodStartDate – periodEndDate – startDateLeaveHistory – situation – situationType properties: periodStartDate: type: string format: date description: Data inicial do período periodEndDate: type: string format: date description: Data final do período startDateLeaveHistory: type: string format: date description: Data inicial do afastamento startTimeLeaveHistory: type: integer format: int64 description: Hora inicial do afastamento endDateLeaveHistory: type: string format: date description: Data final do afastamento endTimeLeaveHistory: type: integer format: int64 description: Hora final do afastamento situation: type: string description: Identificador único da situação situationType: type: string allOf: – #/definitions/situationType description: Tipo da situação justifiedDays: type: integer format: int64 description: Dias justificados employeeTransferValidationResult: description: Resultado da validação de transferência de um colaborador type: object required: – employee – valid properties: employee: type: object allOf: – #/definitions/genericIdDTO description: Identificador único do colaborador valid: type: boolean description: Resultado da validação message: type: string description: Mensagem de erro genericIdDTO: description: Identificador único genérico type: object required: – id properties: id: type: string maxLength: 36 description: Identificador legacyEntityOperation: description: Dados de operação realizada em entidade que possui integração de volta para a base do HCM type: object required: – operationId – entityName – operationType – externalId properties: operationId: type: string description: Identificador único da operação entityName: type: string description: Nome da entidade alterada operationType: type: string allOf: – #/definitions/operationType description: Tipo de operação externalId: type: string description: Identificador externo da entidade alterada annotationHistory: description: Histórico de Anotação type: object required: – employee – startDate – annotationType – sequence properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Contrato employeeEmployer: type: object allOf: – #/definitions/e070emp description: Empresa do colaborador startDate: type: string format: date description: Data annotationType: type: object allOf: – #/definitions/annotationType description: Tipo sequence: type: integer format: int64 description: Sequência minimum: 1 maximum: 99 documentNumber: type: string maxLength: 20 description: Número do documento annotation: type: string maxLength: 999 description: Anotação responsible: type: object allOf: – #/definitions/employee description: Responsável annotationHistoryAttachments: type: array items: type: object allOf: – #/definitions/annotationHistoryAttachment description: Anexos deleted: type: boolean description: Indicativo de exclusão do registro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAnnotationHistory: type: object required: – id allOf: – #/definitions/annotationHistory causeDismissal: description: Causa de rescisão type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Nome externalId: type: string maxLength: 255 description: Identificador externo deleted: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCauseDismissal: type: object required: – id allOf: – #/definitions/causeDismissal annotationHistoryAttachment: description: Anexo do histórico de anotação type: object required: – name – locationURI properties: id: type: string format: uuid description: Identificador único annotationHistory: type: object allOf: – #/definitions/annotationHistory description: Histórico de Anotação name: type: string maxLength: 255 description: Nome do arquivo locationURI: type: string maxLength: 2048 description: URI do local documentId: type: string format: uuid description: Id do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAnnotationHistoryAttachment: type: object required: – id allOf: – #/definitions/annotationHistoryAttachment dismissalReasonEsocial: description: Motivo de desligamento eSocial type: object required: – causeDismissal – startDate properties: id: type: string format: uuid description: Identificador único causeDismissal: type: object allOf: – #/definitions/causeDismissal description: Causa de rescisão startDate: type: string format: date description: Competência eSocialDismissalType: type: string allOf: – #/definitions/eSocialDismissalType description: Tipo de desligamento eSocial dismissalType: type: string allOf: – #/definitions/dismissalType description: Tipo de desligamento voluntaryDismissalProgram: type: boolean description: Programa de demissão voluntária default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDismissalReasonEsocial: type: object required: – id allOf: – #/definitions/dismissalReasonEsocial resignationHistory: description: Histórico de Desligamento type: object required: – dismissalDate – employee – causeDismissal properties: id: type: string format: uuid description: Id dismissalDate: type: string format: date description: Data de desligamento employee: type: object allOf: – #/definitions/employee description: Colaborador causeDismissal: type: object allOf: – #/definitions/causeDismissal description: Causa de rescisão successorSubscriptionType: type: string allOf: – #/definitions/successorSubscriptionType description: Tipo de inscrição sucessora numberSuccessorSubscription: type: integer format: int64 description: Número da inscrição sucessora observation: type: string maxLength: 255 description: Observação deleted: type: boolean description: Indicativo de exclusão do registro externalId: type: string maxLength: 255 description: Identificador externo employeeReintegration: type: object allOf: – #/definitions/employeeReintegration description: Reintegração do colaborador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editResignationHistory: type: object required: – id allOf: – #/definitions/resignationHistory leaveHistory: description: Histórico de Afastamento type: object required: – employee – startDate – situation properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Contrato de trabalho employeeEmployer: type: object allOf: – #/definitions/e070emp description: Empresa do colaborador startDate: type: string format: date description: Data inicial startTime: type: integer format: int64 description: Hora inicial minimum: 0 maximum: 1439 default: 0 endDate: type: string format: date description: Data final endTime: type: integer format: int64 description: Hora final (Caso uma data final seja definida, o valor padrão desse campo passa a ser 1439) minimum: 0 maximum: 1439 situation: type: object allOf: – #/definitions/situation description: Situação numberHoursLeft: type: integer format: int64 description: Quantidade de horas faltas sourceReasonChange: type: string allOf: – #/definitions/sourceReasonChange description: Origem da mudança processType: type: string allOf: – #/definitions/processType description: Tipo do processo processNumber: type: string maxLength: 21 description: Número do processo birthDate: type: string format: date description: Data do parto diseaseCid: type: object allOf: – #/definitions/disease description: CID da doença subgroupCid: type: object allOf: – #/definitions/diseaseSubgroup description: CID do subgrupo cnpjUnion: type: integer format: int64 description: CNPJ onusRemuneration: type: string allOf: – #/definitions/onusRemuneration description: Ônus pela remuneração workAccidentType: type: string allOf: – #/definitions/workAccidentType description: Tipo de acidente de trabalho justifiedDays: type: integer format: int64 description: Dias justificados observation: type: string maxLength: 255 description: Observação sameReasonEsocial: type: boolean description: Mesma razão e-social resultedSicknessAssistance: type: boolean description: Resultou em assistência médica estimatedEndDate: type: string format: date description: Data final estimada estimatedDayEnd: type: integer format: int64 description: Dia final estimado maximum: 9999 leaveHistoryAttachments: type: array items: type: object allOf: – #/definitions/leaveHistoryAttachment description: Anexos generatedByPayroll: type: boolean description: Afastamento gerado pela folha deleted: type: boolean description: Indicativo de exclusão do registro externalId: type: string maxLength: 255 description: Identificador externo cnpjForElectiveMandatory: type: string maxLength: 14 description: CNPJ do órgão para mandato eletivo optedRemunerationPermanentPosition: type: boolean description: Optou pela remuneração do cargo efetivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editLeaveHistory: type: object required: – id allOf: – #/definitions/leaveHistory resignationHistoryAttachment: description: Anexos do Histórico de Desligamento type: object required: – resignationHistory – name – idBlobService – locationURI – fileSize – version properties: id: type: string format: uuid description: Id resignationHistory: type: object allOf: – #/definitions/resignationHistory description: Histórico de desligamento name: type: string maxLength: 255 description: Nome idBlobService: type: string maxLength: 1000 description: Id do blobservice locationURI: type: string maxLength: 255 description: URI do local fileSize: type: integer format: int64 description: Tamanho type: string description: Versão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editResignationHistoryAttachment: type: object required: – id allOf: – #/definitions/resignationHistoryAttachment leaveHistoryAttachment: description: Anexos do histórico de afastamento type: object required: – name – locationURI properties: id: type: string format: uuid description: Identificador único leaveHistory: type: object allOf: – #/definitions/leaveHistory description: Histórico de afastamento name: type: string maxLength: 255 description: Nome do arquivo locationURI: type: string maxLength: 2048 description: URI do local documentId: type: string format: uuid description: Id do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editLeaveHistoryAttachment: type: object required: – id allOf: – #/definitions/leaveHistoryAttachment employee: description: Colaborador type: object required: – person – code – employer – employmentRelationship – hireDate properties: id: type: string format: uuid description: Identificador único person: type: object allOf: – #/definitions/e001pes description: Pessoa code: type: integer format: int64 description: Cadastro employer: type: object allOf: – #/definitions/e070emp description: Empresa que o contratou employmentRelationship: type: object allOf: – #/definitions/employmentRelationship description: Vínculo empregatício hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de desligamento employeeSnapshot: type: object allOf: – #/definitions/employeeSnapshot description: Históricos correntes do colaborador username: type: string description: Nome do usuario deleted: type: boolean description: Indicativo de exclusão do registro externalId: type: string maxLength: 255 description: Indicador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: companyBranchHistory: description: Histórico de filial type: object required: – employee – startDate properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final companyBranch: type: object allOf: – #/definitions/e070fil description: Filial deleted: type: boolean description: Indicativo de exclusão do registro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: exclusionProcess: description: Processo de exclusão type: object required: – entityName – recordId – description – status properties: id: type: string format: uuid description: Identificador único entityName: type: string description: Nome da entidade recordId: type: string description: Identificador único do registro description: type: string description: Descrição status: type: string allOf: – #/definitions/enumExclusionProcessStatus description: Status startDate: type: string format: date-time description: Data e hora de início finishDate: type: string format: date-time description: Data e hora de fim errorMessage: type: string description: Mensagem de erro groups: type: array items: type: object allOf: – #/definitions/exclusionProcessStepGroup description: Grupos createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: exclusionProcessStepGroup: description: Grupo de etapas do processo de exclusão type: object required: – description – status properties: id: type: string format: uuid description: Identificador único exclusionProcess: type: object allOf: – #/definitions/exclusionProcess description: Process de exclusão description: type: string description: Descrição status: type: string allOf: – #/definitions/enumExclusionProcessStatus description: Status errorMessage: type: string description: Mensagem de erro errorDetail: type: string description: Detalhe do erro startDate: type: string format: date-time description: Data e hora de início finishDate: type: string format: date-time description: Data e hora de fim steps: type: array items: type: object allOf: – #/definitions/exclusionProcessStep description: Passos createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editExclusionProcessStepGroup: type: object required: – id allOf: – #/definitions/exclusionProcessStepGroup exclusionProcessStep: description: Etapa do processo de exclusão type: object required: – description – status properties: id: type: string format: uuid description: Identificador único stepGroup: type: object allOf: – #/definitions/exclusionProcessStepGroup description: Grupo de etapas do processo de exclusão description: type: string description: Descrição status: type: string allOf: – #/definitions/enumExclusionProcessStatus description: Status startDate: type: string format: date-time description: Data e hora de início finishDate: type: string format: date-time description: Data e hora de fim errorMessage: type: string description: Mensagem de erro errorDetail: type: string description: Detalhe do erro created_by: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editExclusionProcessStep: type: object required: – id allOf: – #/definitions/exclusionProcessStep annotationType: description: Tipos de Anotação type: object required: – code properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Descrição do tipo x-i18n: true finality: type: string allOf: – #/definitions/annotationFinalityType description: Finalidade annotationTypeStructure: type: object allOf: – #/definitions/annotationTypeStructure description: Estrutura de tipo de anotação deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. annotationTypeStructure: description: Estrutura de tipo de anotação type: object required: – code properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: annotationTypeStructureCompanyHistory: description: Histórico de estrutura de tipo de anotação da empresa type: object required: – company – annotationTypeStructure – startDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa annotationTypeStructure: type: object allOf: – #/definitions/annotationTypeStructure description: Estrutura de tipo de anotação startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e001pes: description: Pessoa type: object required: – codPes – nomPes – datNas properties: id: type: string format: uuid description: Identificador único codPes: type: integer format: int64 description: Código nomPes: type: string maxLength: 100 description: Nome datNas: type: string format: date description: Data de nascimento excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: situation: description: Situação type: object required: – code – name – situationType properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Nome x-i18n: true situationType: type: string allOf: – #/definitions/situationType description: Tipo da situação situationStructure: type: object allOf: – #/definitions/situationStructure description: Estrutura de situação deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação externalId: type: string maxLength: 255 description: Indicador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. disease: description: Doença da Classificação Internacional de Doenças. type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: string maxLength: 4 description: Código name: type: string description: Nome x-i18n: true diseaseSubgroup: type: object allOf: – #/definitions/diseaseSubgroup description: Subgrupo de doenças deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. diseaseSubgroup: description: Subgrupo da Classificação Internacional de Doenças. type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: string maxLength: 3 description: Código name: type: string description: Nome x-i18n: true deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. e070emp: description: Empresa type: object required: – codEmp – nomEmp properties: id: type: string format: uuid description: Identificador único codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação externalId: type: string maxLength: 255 description: Indicador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employmentRelationship: description: Vínculo empregatício type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: string description: Código name: type: string description: Nome x-i18n: true contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. eSocialReason: description: Motivo e-social type: object required: – situation – competence – eSocialReasonType properties: id: type: string format: uuid description: Identificador único situation: type: object allOf: – #/definitions/situation description: Situação competence: type: string format: date description: Competência eSocialReasonType: type: string allOf: – #/definitions/eSocialReasonType description: Motivo de afastamento e-social deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: situationStructure: description: Estrutura de situação type: object required: – code properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: situationStructureCompanyHistory: description: Histórico de estrutura de situação da empresa type: object required: – company – situationStructure – startDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa situationStructure: type: object allOf: – #/definitions/situationStructure description: Estrutura de situação startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070fil: description: Filial type: object required: – codFil – nomFil properties: id: type: string format: uuid description: Identificador único e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa numCgc: type: string maxLength: 18 description: CPF/CNPJ excluido: type: boolean description: Indicativo de exclusão do registro default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: stabilityHistory: description: Histórico de estabilidade do colaborador type: object required: – employee – startDate – stabilityType – originType properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador employeeEmployer: type: object allOf: – #/definitions/e070emp description: Empresa do colaborador startDate: type: string format: date description: Início da estabilidade endDate: type: string format: date description: Término da estabilidade stabilityType: type: string allOf: – #/definitions/stabilityType description: Tipo de estabilidade originType: type: string allOf: – #/definitions/originType description: Origem observation: type: string description: Observação deleted: type: boolean description: Indicativo de exclusão do registro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editStabilityHistory: type: object required: – id allOf: – #/definitions/stabilityHistory employeeSnapshot: description: Históricos correntes do colaborador type: object properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador companyBranch: type: string format: uuid description: Filial corrente do colaborador companyBranchCode: type: integer format: int64 description: Código da filial corrente do colaborador position: type: string format: uuid description: Posição corrente do colaborador companyBranchName: type: string description: Nome da filial deleted: type: boolean description: Indicativo de exclusão do registro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeSnapshot: type: object required: – id allOf: – #/definitions/employeeSnapshot positionSnapshot: description: Posição corrente type: object required: – position – hierarchicalPosition – treeLevel – leftIndex – rightIndex – version properties: id: type: string format: uuid description: Identificador único position: type: string format: uuid description: Identificador único da posição parentPosition: type: object allOf: – #/definitions/positionSnapshot description: Posição pai hierarchicalPosition: type: string description: Identificador da hierarquia Ex: 1;1;2 treeLevel: type: integer format: int64 description: Nível do item da hierarquia leftIndex: type: integer format: int64 description: Índice da esquerda rightIndex: type: integer format: int64 description: Índice da direita type: object allOf: – #/definitions/positionSnapshotVersion description: Versão da posição corrente createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: positionSnapshotVersion: description: Versão gerada da hierarquia corrente type: object required: – hierarchy – hierarchyType properties: id: type: string format: uuid description: Identificador único hierarchy: type: string format: uuid description: Hierarquia hierarchyType: type: string format: uuid description: Tipo da hierarquia startDateTime: type: string format: date-time description: Início da aplicação da versão endDateTime: type: string format: date-time description: Fim da aplicação da versão active: type: boolean description: Ativo default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeModule: description: Módulos do colaborador type: object required: – employee – moduleType – externalId properties: id: type: string format: uuid description: Identificador employee: type: object allOf: – #/definitions/employee description: Colaborador moduleType: type: string maxLength: 6 description: Tipo do módulo deleted: type: boolean description: Indica se o registro foi excluído default: false externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeModule: type: object required: – id allOf: – #/definitions/employeeModule employeeReintegration: description: Reintegração/Outros Movimentos do Colaborador type: object required: – effectiveDate – reinstatementEffectiveDate – reintegrationType – judgmentPaymentType properties: id: type: string format: uuid description: Id da reintegração resignationHistory: type: object allOf: – #/definitions/resignationHistory description: Histórico de afastamento effectiveDate: type: string format: date description: Data de efeito reinstatementEffectiveDate: type: string format: date description: Data efetivo retorno ao trabalho reintegrationType: type: string allOf: – #/definitions/reintegrationType description: Tipo da reintegração lawsuitNumber: type: string maxLength: 20 description: Número do processo judicial numberYearPublicationAmnestyLaw: type: string maxLength: 13 description: Número e ano da publicação da lei de anistia recordAnnotation: type: string maxLength: 255 description: Anotação da ficha judgmentPaymentType: type: string allOf: – #/definitions/judgmentPaymentType description: Pagamento juízo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeReintegration: type: object required: – id allOf: – #/definitions/employeeReintegration 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