HCM – Contract Additional Info (employment_additional_info)

2.0info: 4.0.0 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 get: description: Retorna os históricos de afastamento que influenciam as férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data de início da referência de busca in: query required: true type: string format: date – name: endDate description: Data fim da referência de busca in: query required: true type: string format: date – name: employeeId description: Identificador único do colaborador in: query required: true type: string – name: situationIdList description: Identificadores únicos das situações in: query required: true type: array items: type: string minimum: 1 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/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/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/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/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/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/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 generateNegative: type: string allOf: – #/definitions/generateNegativeType description: Gerar negativa hiredInTheYear: type: string allOf: – #/definitions/hiredInTheYearType description: Admitidos no ano 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 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 generateNegative: type: string allOf: – #/definitions/generateNegativeType description: Gerar negativa hiredInTheYear: type: string allOf: – #/definitions/hiredInTheYearType description: Admitidos no ano 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/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/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: 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/annotationHistory responses: 200: description: Ok 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: 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: 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/causeDismissal responses: 200: description: Ok 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: 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: 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/annotationHistoryAttachment responses: 200: description: Ok schema: #/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: 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: 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/dismissalReasonEsocial responses: 200: description: Ok 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: 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: 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/resignationHistory responses: 200: description: Ok 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: 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: 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/leaveHistory responses: 200: description: Ok 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: 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: 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/resignationHistoryAttachment responses: 200: description: Ok 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: 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: 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/leaveHistoryAttachment responses: 200: description: Ok schema: #/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: 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/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: 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/stabilityHistory responses: 200: description: Ok 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: 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: 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/employeeSnapshot responses: 200: description: Ok 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: 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 definitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN statusType: description: Tipo do resultado da operação type: string enum: – ERROR – SUCCESS eSocialDismissalType: description: Tipo de desligamento eSocial 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 dismissalType: description: Tipo de desligamento type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V99 successorSubscriptionType: description: Tipo de inscrição sucessora type: string enum: – CPF – CNPJ workAccidentType: description: Tipo de acidente de trabalho type: string enum: – V1 – V2 – V3 onusRemuneration: description: Ônus pela remuneração type: string enum: – V1 – V2 – V3 sourceReasonChange: description: Origem da mudança type: string enum: – V1 – V2 – V3 processType: description: Tipo do Processo type: string enum: – V1 – V2 – V3 situationType: description: Tipo da situação 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 contractType: description: Tipo de contrato type: string enum: – EMPLOYEE – DIRECTOR – TRAINEE – APRENTICE – THIRD_PARTY eSocialReasonType: description: Motivo afastamento e-social 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 enumJurFis: description: Tipo de pessoa type: string enum: – VJ – VF stabilityType: description: Tipo de estabilidade 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 originType: description: Origem type: string enum: – SITUATION – COLLECTIVE_NEGOTIATION – ADD_BY_USER eSocialTrainingCodeType: description: Código de treinamento eSocial type: string enum: – V1006 – V1207 annotationFinalityType: description: Finalidade anotação 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 directionType: description: Tipo de ordenação type: string enum: – ASC – DESC calculationType: description: Tipo de cálculo type: string enum: – MONTHLY_PAYROLL – ADVANCE_SALARY – THIRTEENTH_SALARY – ADVANCE_THIRTEENTH_SALARY – INDIVIDUAL_VACATION – COLLECTIVE_VACATION – DISMISSAL generateNegativeType: description: Tipo de geração negativa type: string enum: – YES – NO – VACATION_PREMIUM hiredInTheYearType: description: Tipo de admitidos no ano type: string enum: – NEGATIVE_BALANCE_PERIOD – PAID_LEAVE – PAY_ENTITLEMENT_VACATION_DAYS – ENDS_PERIOD_REGARDLESS_BALANCE trafficAccidentType: description: Tipo de acidente de trânsito type: string enum: – V1 – V2 – V3 userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR 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 evenWithInSixtyDays: type: boolean description: Mesmo motivo dentro de 60 dias trafficAccidentType: type: string allOf: – #/definitions/trafficAccidentType description: Tipo de acidente de trânsito 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 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: 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 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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: 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 recisã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 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 evenWithInSixtyDays: type: boolean description: Mesmo motivo dentro de 60 dias trafficAccidentType: type: string allOf: – #/definitions/trafficAccidentType description: Tipo de acidente de trânsito 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: 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: 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: 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 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: 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 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 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 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 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: integer format: int64 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: 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: 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: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE