HCM – Payroll Employee General (general)

2.0info: 2.2.0 HCM – Payroll Employee General description: HCM – Payroll Employee General x-senior-domain: HCM – Payroll Employee General x-senior-domain-path: hcm_payroll_employee x-senior-service-path: general contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcm_payroll_employeesecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /general/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/employeeDependentConcessionLookup: post: description: Primitiva para a consulta de dados dos Eventos – Especialização da Folha (wageTypePayroll) usados em campos lookup das visões dinâmicas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/lookupItem minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para a consulta de dados dos Eventos – Especialização da Folha (wageTypePayroll) usados em campos lookup das visões dinâmicas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/lookupItem minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/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 /general/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportEmployeeDependentBank: 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 /general/queries/exportEmployeeAdditionalContractHistory: 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 /general/queries/exportEmployeeDependentFamilySalary: 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 /general/queries/exportEmployeeDependentIrrf: 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 /general/queries/exportEmployeeOppositionDiscountSyndicateHistory: 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 /general/queries/exportEmployeeDiscountAuthorizationSyndicateHistory: 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 /general/queries/exportEmployeeDiscountAuthorizationSyndicateHistoryAttachment: 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 /general/queries/exportEmployeeOppositionDiscountSyndicateHistoryAttachment: 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 /general/queries/exportEmployeeDependentConcessionBasesMonthAlimony: 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 /general/queries/exportEmployeeDependentConcessionBasesThirteenthAlimony: 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 /general/queries/exportEmployeeDependentAlimonyPayee: 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 /general/queries/exportEmployeeDependentConcessionBasesVacationAlimony: 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 /general/queries/exportEmployeeSelectionHistory: 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 /general/queries/exportEmployeeRemoteWorkHistory: 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 /general/queries/exportEmployeeDependentTypeHistory: 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 /general/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 /general/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 /general/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 /general/queries/exportCompanyIndications: 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 /general/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 /general/queries/exportEmploymentRelationshipPayroll: 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 /general/queries/exportEmployeeDependent: 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 /general/queries/exportContributionType: 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 /general/queries/exportE030age: 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 /general/queries/exportE030ban: 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 /general/queries/exportEmployeeDependentConcession: 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 /general/queries/exportWageTypeTable: 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 /general/queries/exportWageType: 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 /general/queries/exportTotalizer: 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 /general/queries/exportAccumulators: 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 /general/queries/exportSelection: 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 /general/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 /general/queries/exportEmployeeModule: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/blobServiceRequestUploadFile: post: description: Solicitação para realizar o upload de um arquivo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado. responses: 200: description: Ok schema: type: object required: – fileId – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). type: string description: Versão do arquivo. locationURI: type: string description: URI onde o upload deve ser realizado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/blobServiceCommitUploadedFile: post: description: Realiza o commit de um arquivo que foi carregado anteriormente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId – version properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). type: string description: Versão do arquivo. responses: 200: description: Ok schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/blobServiceRequestDownload: post: description: Requisição para baixar um arquivo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). ttl: type: integer format: int64 description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado (padrão 30 minutos). default: 30 responses: 200: description: Ok schema: type: object required: – locationURI properties: locationURI: type: string description: URI onde o arquivo está disponível para download. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/createEmployeeDiscountAuthorizationSyndicateHistoryWithAttachments: post: description: Criar histórico de autorizações de descontos sindicais com anexos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/employeeDiscountAuthorizationSyndicateHistoryDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/employeeDiscountAuthorizationSyndicateHistoryDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/updateEmployeeDiscountAuthorizationSyndicateHistoryWithAttachments: post: description: Alterar histórico de autorizações de descontos sindicais com anexos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/employeeDiscountAuthorizationSyndicateHistoryDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/employeeDiscountAuthorizationSyndicateHistoryDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteEmployeeDiscountAuthorizationSyndicateHistoryWithAttachments: post: description: Excluir histórico de autorizações de descontos sindicais com anexos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/employeeDiscountAuthorizationSyndicateHistoryBatch: post: description: Autorizações de descontos sindicais – Coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeDiscountAuthorizationSyndicateHistory – filter properties: employeeDiscountAuthorizationSyndicateHistory: type: object allOf: – #/definitions/employeeDiscountAuthorizationSyndicateHistoryCollectiveDTO description: filter: type: object allOf: – #/definitions/filterBatchDTO description: responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteEmployeeDiscountAuthorizationSyndicateHistoryBatch: post: description: Exclusão de autorizações de descontos sindicais – Coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeDiscountAuthorizationSyndicateHistory – filter properties: employeeDiscountAuthorizationSyndicateHistory: type: object allOf: – #/definitions/employeeDiscountAuthorizationSyndicateHistoryCollectiveDTO description: filter: type: object allOf: – #/definitions/filterBatchDTO description: responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/createEmployeeOppositionDiscountSyndicateHistoryWithAttachments: post: description: Criar histórico de oposições de descontos sindicais com anexos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/employeeOppositionDiscountSyndicateHistoryDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/employeeOppositionDiscountSyndicateHistoryDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/updateEmployeeOppositionDiscountSyndicateHistoryWithAttachments: post: description: Alterar histórico de oposições de descontos sindicais com anexos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/employeeOppositionDiscountSyndicateHistoryDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/employeeOppositionDiscountSyndicateHistoryDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteEmployeeOppositionDiscountSyndicateHistoryWithAttachments: post: description: Excluir histórico de oposições de descontos sindicais com anexos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/employeeOppositionDiscountSyndicateHistoryBatch: post: description: Oposições de descontos sindicais – Coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeOppositionDiscountSyndicateHistory – filter properties: employeeOppositionDiscountSyndicateHistory: type: object allOf: – #/definitions/employeeOppositionDiscountSyndicateHistoryCollectiveDTO description: filter: type: object allOf: – #/definitions/filterBatchDTO description: responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteEmployeeOppositionDiscountSyndicateHistoryBatch: post: description: Exclusão de oposições de descontos sindicais – Coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeOppositionDiscountSyndicateHistory – filter properties: employeeOppositionDiscountSyndicateHistory: type: object allOf: – #/definitions/employeeOppositionDiscountSyndicateHistoryCollectiveDTO description: filter: type: object allOf: – #/definitions/filterBatchDTO description: responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/employeeSelectionHistoryBatch: post: description: Históricos de código de seleção – Coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeSelectionHistory – filter properties: employeeSelectionHistory: type: object allOf: – #/definitions/employeeSelectionHistoryCollectiveDTO description: filter: type: object allOf: – #/definitions/filterBatchDTO description: responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteEmployeeSelectionHistoryBatch: post: description: Exclusão de histórico de código de seleção – Coletiva tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeSelectionHistory – filter properties: employeeSelectionHistory: type: object allOf: – #/definitions/employeeSelectionHistoryCollectiveDTO description: filter: type: object allOf: – #/definitions/filterBatchDTO description: responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/employeeCompanyTransfer: post: description: Realiza o processo da transferência de empresa de um colaborador no domínio do colaborador da folha. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – previousEmployee – newEmployee properties: previousEmployee: type: string maxLength: 36 description: Colaborador origem newEmployee: type: string maxLength: 36 description: Colaborador destino employeeDependentData: type: array items: type: object allOf: – #/definitions/employeeDependentCompanyTransferData description: Dados dos dependentes do colaborador transferido responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/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 /general/actions/undoSoftExclude: post: description: Desfaz 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 /general/actions/deleteEmployeeCompanyTransfer: post: description: Desfaz o processo da transferência de empresa de um colaborador no domínio de lançamentos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee properties: employee: type: string maxLength: 36 description: Colaborador destino responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/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 /general/actions/importEmployeeDependentBank: 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 /general/actions/importEmployeeAdditionalContractHistory: 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 /general/actions/importEmployeeDependentFamilySalary: 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 /general/actions/importEmployeeDependentIrrf: 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 /general/actions/importEmployeeOppositionDiscountSyndicateHistory: 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 /general/actions/importEmployeeDiscountAuthorizationSyndicateHistory: 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 /general/actions/importEmployeeDiscountAuthorizationSyndicateHistoryAttachment: 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 /general/actions/importEmployeeOppositionDiscountSyndicateHistoryAttachment: 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 /general/actions/importEmployeeDependentConcessionBasesMonthAlimony: 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 /general/actions/importEmployeeDependentConcessionBasesThirteenthAlimony: 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 /general/actions/importEmployeeDependentAlimonyPayee: 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 /general/actions/importEmployeeDependentConcessionBasesVacationAlimony: 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 /general/actions/importEmployeeSelectionHistory: 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 /general/actions/importEmployeeRemoteWorkHistory: 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 /general/actions/importEmployeeDependentTypeHistory: 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 /general/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 /general/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 /general/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 /general/actions/importCompanyIndications: 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 /general/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 /general/actions/importEmploymentRelationshipPayroll: 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 /general/actions/importEmployeeDependent: 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 /general/actions/importContributionType: 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 /general/actions/importE030age: 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 /general/actions/importE030ban: 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 /general/actions/importEmployeeDependentConcession: 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 /general/actions/importWageTypeTable: 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 /general/actions/importWageType: 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 /general/actions/importTotalizer: 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 /general/actions/importAccumulators: 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 /general/actions/importSelection: 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 /general/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 /general/actions/importEmployeeModule: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/signals/employeeDiscountAuthorizationSyndicateHistoryBatchItem: post: description: Autorizações de descontos sindicais – Coletiva tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/employeeDiscountAuthorizationSyndicateHistoryCollectiveDTO description: itens: type: array items: type: object allOf: – #/definitions/employeeIdDTO minimum: 1 description: batchId: type: string description: summaryId: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/employeeOppositionDiscountSyndicateHistoryBatchItem: post: description: Autorizações de descontos sindicais – Coletiva tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/employeeOppositionDiscountSyndicateHistoryCollectiveDTO description: itens: type: array items: type: object allOf: – #/definitions/employeeIdDTO minimum: 1 description: batchId: type: string description: summaryId: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/deleteEmployeeOppositionDiscountSyndicateHistoryBatchItem: post: description: Exclusão de oposições de descontos sindicais – Coletiva tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/employeeOppositionDiscountSyndicateHistoryCollectiveDTO description: itens: type: array items: type: string minimum: 1 description: batchId: type: string description: summaryId: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/deleteEmployeeDiscountAuthorizationSyndicateHistoryBatchItem: post: description: Exclusão de autorizações de descontos sindicais – Coletiva tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/employeeDiscountAuthorizationSyndicateHistoryCollectiveDTO description: itens: type: array items: type: string minimum: 1 description: batchId: type: string description: summaryId: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/cancelProcessNotification: post: description: Realiza as ações necessárias ao cancelar um processo. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – processType properties: processId: type: string maxLength: 36 description: Identificador do processo processType: type: string allOf: – #/definitions/processType description: Tipo do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/finishedProcessNotification: post: description: Realiza as ações necessárias ao finalizar um processo. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – processType properties: processId: type: string maxLength: 36 description: Identificador do processo processType: type: string allOf: – #/definitions/processType description: Tipo do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/employeeSelectionHistoryBatchItem: post: description: Inclusão histórico de código de seleção – Coletiva tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/employeeSelectionHistoryCollectiveDTO description: itens: type: array items: type: object allOf: – #/definitions/employeeIdDTO minimum: 1 description: batchId: type: string description: summaryId: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/deleteEmployeeSelectionHistoryBatchItem: post: description: Exclusão histórico de código de seleção – Coletiva tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dto – itens – batchId – summaryId properties: dto: type: object allOf: – #/definitions/employeeSelectionHistoryCollectiveDTO description: itens: type: array items: type: string minimum: 1 description: batchId: type: string description: summaryId: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/events/importEmployeeDependentBankEvent: 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 /general/events/exportEmployeeDependentBankEvent: 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 /general/events/importEmployeeAdditionalContractHistoryEvent: 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 /general/events/exportEmployeeAdditionalContractHistoryEvent: 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 /general/events/importEmployeeDependentFamilySalaryEvent: 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 /general/events/exportEmployeeDependentFamilySalaryEvent: 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 /general/events/importEmployeeDependentIrrfEvent: 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 /general/events/exportEmployeeDependentIrrfEvent: 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 /general/events/importEmployeeOppositionDiscountSyndicateHistoryEvent: 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 /general/events/exportEmployeeOppositionDiscountSyndicateHistoryEvent: 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 /general/events/importEmployeeDiscountAuthorizationSyndicateHistoryEvent: 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 /general/events/exportEmployeeDiscountAuthorizationSyndicateHistoryEvent: 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 /general/events/importEmployeeDiscountAuthorizationSyndicateHistoryAttachmentEvent: 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 /general/events/exportEmployeeDiscountAuthorizationSyndicateHistoryAttachmentEvent: 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 /general/events/importEmployeeOppositionDiscountSyndicateHistoryAttachmentEvent: 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 /general/events/exportEmployeeOppositionDiscountSyndicateHistoryAttachmentEvent: 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 /general/events/importEmployeeDependentConcessionBasesMonthAlimonyEvent: 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 /general/events/exportEmployeeDependentConcessionBasesMonthAlimonyEvent: 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 /general/events/importEmployeeDependentConcessionBasesThirteenthAlimonyEvent: 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 /general/events/exportEmployeeDependentConcessionBasesThirteenthAlimonyEvent: 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 /general/events/importEmployeeDependentAlimonyPayeeEvent: 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 /general/events/exportEmployeeDependentAlimonyPayeeEvent: 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 /general/events/importEmployeeDependentConcessionBasesVacationAlimonyEvent: 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 /general/events/exportEmployeeDependentConcessionBasesVacationAlimonyEvent: 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 /general/events/importEmployeeSelectionHistoryEvent: 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 /general/events/exportEmployeeSelectionHistoryEvent: 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 /general/events/importEmployeeRemoteWorkHistoryEvent: 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 /general/events/exportEmployeeRemoteWorkHistoryEvent: 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 /general/events/importEmployeeDependentTypeHistoryEvent: 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 /general/events/exportEmployeeDependentTypeHistoryEvent: 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 /general/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 /general/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 /general/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 /general/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 /general/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 /general/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 /general/events/importCompanyIndicationsEvent: 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 /general/events/exportCompanyIndicationsEvent: 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 /general/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 /general/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 /general/events/importEmploymentRelationshipPayrollEvent: 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 /general/events/exportEmploymentRelationshipPayrollEvent: 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 /general/events/importEmployeeDependentEvent: 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 /general/events/exportEmployeeDependentEvent: 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 /general/events/importContributionTypeEvent: 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 /general/events/exportContributionTypeEvent: 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 /general/events/importE030ageEvent: 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 /general/events/exportE030ageEvent: 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 /general/events/importE030banEvent: 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 /general/events/exportE030banEvent: 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 /general/events/importEmployeeDependentConcessionEvent: 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 /general/events/exportEmployeeDependentConcessionEvent: 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 /general/events/importWageTypeTableEvent: 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 /general/events/exportWageTypeTableEvent: 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 /general/events/importWageTypeEvent: 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 /general/events/exportWageTypeEvent: 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 /general/events/importTotalizerEvent: 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 /general/events/exportTotalizerEvent: 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 /general/events/importAccumulatorsEvent: 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 /general/events/exportAccumulatorsEvent: 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 /general/events/importSelectionEvent: 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 /general/events/exportSelectionEvent: 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 /general/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 /general/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 /general/events/importEmployeeModuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportEmployeeModuleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentBank: 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/employeeDependentBank responses: 200: description: The created resource schema: #/definitions/employeeDependentBank 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/employeeDependentBank responses: 200: description: The created resource schema: #/definitions/employeeDependentBank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeDependentBank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentBank/{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/editEmployeeDependentBank responses: 200: description: Ok schema: #/definitions/editEmployeeDependentBank 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/employeeDependentBank responses: 200: description: Ok schema: #/definitions/employeeDependentBank 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/employeeDependentBank 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 /general/entities/employeeDependentBank/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeDependentBank responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeAdditionalContractHistory: 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/employeeAdditionalContractHistory responses: 200: description: The created resource schema: #/definitions/employeeAdditionalContractHistory 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/employeeAdditionalContractHistory responses: 200: description: The created resource schema: #/definitions/employeeAdditionalContractHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeAdditionalContractHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeAdditionalContractHistory/{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/editEmployeeAdditionalContractHistory responses: 200: description: Ok schema: #/definitions/editEmployeeAdditionalContractHistory 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/employeeAdditionalContractHistory responses: 200: description: Ok schema: #/definitions/employeeAdditionalContractHistory 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/employeeAdditionalContractHistory 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 /general/entities/employeeAdditionalContractHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeAdditionalContractHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentFamilySalary: 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/employeeDependentFamilySalary responses: 200: description: The created resource schema: #/definitions/employeeDependentFamilySalary 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/employeeDependentFamilySalary responses: 200: description: The created resource schema: #/definitions/employeeDependentFamilySalary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeDependentFamilySalary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentFamilySalary/{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/editEmployeeDependentFamilySalary responses: 200: description: Ok schema: #/definitions/editEmployeeDependentFamilySalary 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/employeeDependentFamilySalary responses: 200: description: Ok schema: #/definitions/employeeDependentFamilySalary 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/employeeDependentFamilySalary 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 /general/entities/employeeDependentFamilySalary/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeDependentFamilySalary responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentIrrf: 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/employeeDependentIrrf responses: 200: description: The created resource schema: #/definitions/employeeDependentIrrf 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/employeeDependentIrrf responses: 200: description: The created resource schema: #/definitions/employeeDependentIrrf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeDependentIrrf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentIrrf/{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/editEmployeeDependentIrrf responses: 200: description: Ok schema: #/definitions/editEmployeeDependentIrrf 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/employeeDependentIrrf responses: 200: description: Ok schema: #/definitions/employeeDependentIrrf 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/employeeDependentIrrf 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 /general/entities/employeeDependentIrrf/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeDependentIrrf responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeOppositionDiscountSyndicateHistory: 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/employeeOppositionDiscountSyndicateHistory responses: 200: description: The created resource schema: #/definitions/employeeOppositionDiscountSyndicateHistory 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/employeeOppositionDiscountSyndicateHistory responses: 200: description: The created resource schema: #/definitions/employeeOppositionDiscountSyndicateHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeOppositionDiscountSyndicateHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeOppositionDiscountSyndicateHistory/{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/editEmployeeOppositionDiscountSyndicateHistory responses: 200: description: Ok schema: #/definitions/editEmployeeOppositionDiscountSyndicateHistory 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/employeeOppositionDiscountSyndicateHistory responses: 200: description: Ok schema: #/definitions/employeeOppositionDiscountSyndicateHistory 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/employeeOppositionDiscountSyndicateHistory 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 /general/entities/employeeOppositionDiscountSyndicateHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeOppositionDiscountSyndicateHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDiscountAuthorizationSyndicateHistory: 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/employeeDiscountAuthorizationSyndicateHistory responses: 200: description: The created resource schema: #/definitions/employeeDiscountAuthorizationSyndicateHistory 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/employeeDiscountAuthorizationSyndicateHistory responses: 200: description: The created resource schema: #/definitions/employeeDiscountAuthorizationSyndicateHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeDiscountAuthorizationSyndicateHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDiscountAuthorizationSyndicateHistory/{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/editEmployeeDiscountAuthorizationSyndicateHistory responses: 200: description: Ok schema: #/definitions/editEmployeeDiscountAuthorizationSyndicateHistory 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/employeeDiscountAuthorizationSyndicateHistory responses: 200: description: Ok schema: #/definitions/employeeDiscountAuthorizationSyndicateHistory 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/employeeDiscountAuthorizationSyndicateHistory 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 /general/entities/employeeDiscountAuthorizationSyndicateHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeDiscountAuthorizationSyndicateHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDiscountAuthorizationSyndicateHistoryAttachment: 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/employeeDiscountAuthorizationSyndicateHistoryAttachment responses: 200: description: The created resource schema: #/definitions/employeeDiscountAuthorizationSyndicateHistoryAttachment 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/employeeDiscountAuthorizationSyndicateHistoryAttachment responses: 200: description: The created resource schema: #/definitions/employeeDiscountAuthorizationSyndicateHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeDiscountAuthorizationSyndicateHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDiscountAuthorizationSyndicateHistoryAttachment/{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/editEmployeeDiscountAuthorizationSyndicateHistoryAttachment responses: 200: description: Ok schema: #/definitions/editEmployeeDiscountAuthorizationSyndicateHistoryAttachment 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/employeeDiscountAuthorizationSyndicateHistoryAttachment responses: 200: description: Ok schema: #/definitions/employeeDiscountAuthorizationSyndicateHistoryAttachment 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/employeeDiscountAuthorizationSyndicateHistoryAttachment 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 /general/entities/employeeDiscountAuthorizationSyndicateHistoryAttachment/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeDiscountAuthorizationSyndicateHistoryAttachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeOppositionDiscountSyndicateHistoryAttachment: 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/employeeOppositionDiscountSyndicateHistoryAttachment responses: 200: description: The created resource schema: #/definitions/employeeOppositionDiscountSyndicateHistoryAttachment 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/employeeOppositionDiscountSyndicateHistoryAttachment responses: 200: description: The created resource schema: #/definitions/employeeOppositionDiscountSyndicateHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeOppositionDiscountSyndicateHistoryAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeOppositionDiscountSyndicateHistoryAttachment/{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/editEmployeeOppositionDiscountSyndicateHistoryAttachment responses: 200: description: Ok schema: #/definitions/editEmployeeOppositionDiscountSyndicateHistoryAttachment 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/employeeOppositionDiscountSyndicateHistoryAttachment responses: 200: description: Ok schema: #/definitions/employeeOppositionDiscountSyndicateHistoryAttachment 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/employeeOppositionDiscountSyndicateHistoryAttachment 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 /general/entities/employeeOppositionDiscountSyndicateHistoryAttachment/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeOppositionDiscountSyndicateHistoryAttachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentConcessionBasesMonthAlimony: 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/employeeDependentConcessionBasesMonthAlimony responses: 200: description: The created resource schema: #/definitions/employeeDependentConcessionBasesMonthAlimony 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/employeeDependentConcessionBasesMonthAlimony responses: 200: description: The created resource schema: #/definitions/employeeDependentConcessionBasesMonthAlimony 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeDependentConcessionBasesMonthAlimony 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentConcessionBasesMonthAlimony/{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/editEmployeeDependentConcessionBasesMonthAlimony responses: 200: description: Ok schema: #/definitions/editEmployeeDependentConcessionBasesMonthAlimony 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/employeeDependentConcessionBasesMonthAlimony responses: 200: description: Ok schema: #/definitions/employeeDependentConcessionBasesMonthAlimony 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/employeeDependentConcessionBasesMonthAlimony 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 /general/entities/employeeDependentConcessionBasesMonthAlimony/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeDependentConcessionBasesMonthAlimony responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentConcessionBasesThirteenthAlimony: 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/employeeDependentConcessionBasesThirteenthAlimony responses: 200: description: The created resource schema: #/definitions/employeeDependentConcessionBasesThirteenthAlimony 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/employeeDependentConcessionBasesThirteenthAlimony responses: 200: description: The created resource schema: #/definitions/employeeDependentConcessionBasesThirteenthAlimony 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeDependentConcessionBasesThirteenthAlimony 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentConcessionBasesThirteenthAlimony/{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/editEmployeeDependentConcessionBasesThirteenthAlimony responses: 200: description: Ok schema: #/definitions/editEmployeeDependentConcessionBasesThirteenthAlimony 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/employeeDependentConcessionBasesThirteenthAlimony responses: 200: description: Ok schema: #/definitions/employeeDependentConcessionBasesThirteenthAlimony 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/employeeDependentConcessionBasesThirteenthAlimony 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 /general/entities/employeeDependentConcessionBasesThirteenthAlimony/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeDependentConcessionBasesThirteenthAlimony responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentAlimonyPayee: 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/employeeDependentAlimonyPayee responses: 200: description: The created resource schema: #/definitions/employeeDependentAlimonyPayee 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/employeeDependentAlimonyPayee responses: 200: description: The created resource schema: #/definitions/employeeDependentAlimonyPayee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeDependentAlimonyPayee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentAlimonyPayee/{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/editEmployeeDependentAlimonyPayee responses: 200: description: Ok schema: #/definitions/editEmployeeDependentAlimonyPayee 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/employeeDependentAlimonyPayee responses: 200: description: Ok schema: #/definitions/employeeDependentAlimonyPayee 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/employeeDependentAlimonyPayee 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 /general/entities/employeeDependentAlimonyPayee/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeDependentAlimonyPayee responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentConcessionBasesVacationAlimony: 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/employeeDependentConcessionBasesVacationAlimony responses: 200: description: The created resource schema: #/definitions/employeeDependentConcessionBasesVacationAlimony 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/employeeDependentConcessionBasesVacationAlimony responses: 200: description: The created resource schema: #/definitions/employeeDependentConcessionBasesVacationAlimony 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeDependentConcessionBasesVacationAlimony 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentConcessionBasesVacationAlimony/{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/editEmployeeDependentConcessionBasesVacationAlimony responses: 200: description: Ok schema: #/definitions/editEmployeeDependentConcessionBasesVacationAlimony 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/employeeDependentConcessionBasesVacationAlimony responses: 200: description: Ok schema: #/definitions/employeeDependentConcessionBasesVacationAlimony 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/employeeDependentConcessionBasesVacationAlimony 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 /general/entities/employeeDependentConcessionBasesVacationAlimony/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeDependentConcessionBasesVacationAlimony responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeSelectionHistory: 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/employeeSelectionHistory responses: 200: description: The created resource schema: #/definitions/employeeSelectionHistory 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/employeeSelectionHistory responses: 200: description: The created resource schema: #/definitions/employeeSelectionHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeSelectionHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeSelectionHistory/{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/editEmployeeSelectionHistory responses: 200: description: Ok schema: #/definitions/editEmployeeSelectionHistory 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/employeeSelectionHistory responses: 200: description: Ok schema: #/definitions/employeeSelectionHistory 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/employeeSelectionHistory 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 /general/entities/employeeSelectionHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeSelectionHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeRemoteWorkHistory: 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/employeeRemoteWorkHistory responses: 200: description: The created resource schema: #/definitions/employeeRemoteWorkHistory 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/employeeRemoteWorkHistory responses: 200: description: The created resource schema: #/definitions/employeeRemoteWorkHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeRemoteWorkHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeRemoteWorkHistory/{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/editEmployeeRemoteWorkHistory responses: 200: description: Ok schema: #/definitions/editEmployeeRemoteWorkHistory 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/employeeRemoteWorkHistory responses: 200: description: Ok schema: #/definitions/employeeRemoteWorkHistory 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/employeeRemoteWorkHistory 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 /general/entities/employeeRemoteWorkHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeRemoteWorkHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentTypeHistory: 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/employeeDependentTypeHistory responses: 200: description: The created resource schema: #/definitions/employeeDependentTypeHistory 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/employeeDependentTypeHistory responses: 200: description: The created resource schema: #/definitions/employeeDependentTypeHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeDependentTypeHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentTypeHistory/{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/editEmployeeDependentTypeHistory responses: 200: description: Ok schema: #/definitions/editEmployeeDependentTypeHistory 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/employeeDependentTypeHistory responses: 200: description: Ok schema: #/definitions/employeeDependentTypeHistory 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/employeeDependentTypeHistory 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 /general/entities/employeeDependentTypeHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeDependentTypeHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentConcession: 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/employeeDependentConcession responses: 200: description: The created resource schema: #/definitions/employeeDependentConcession 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/employeeDependentConcession responses: 200: description: The created resource schema: #/definitions/employeeDependentConcession 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/employeeDependentConcession 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/employeeDependentConcession/{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/editEmployeeDependentConcession responses: 200: description: Ok schema: #/definitions/editEmployeeDependentConcession 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/employeeDependentConcession responses: 200: description: Ok schema: #/definitions/employeeDependentConcession 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/employeeDependentConcession 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 /general/entities/employeeDependentConcession/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeDependentConcession responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim specialRetirementType: type: string enum: – V01 – V02 – V03 – V04 description: Tipos de aposentadorias especiais: * `V01` – Não ensejador de aposentadoria especial * `V02` – Ensejador de aposentadoria especial – 15 anos de contribuição e alíquota de 12% * `V03` – Ensejador de aposentadoria especial – 20 anos de contribuição e alíquota de 9% * `V04` – Ensejador de aposentadoria especial – 25 anos de contribuição e alíquota de 6% admissionType: type: string enum: – V1 – V2 – V3 – V4 – V5 description: Tipo de admissão eSocial: * `V1` – Admissão * `V2` – Transferência de empresa do mesmo grupo econômico * `V3` – Transferência de empresa consorciada ou de consórcio * `V4` – Transferência por motivo de sucessão, incorporação, cisão ou fusão * `V5` – Transferência do empregado doméstico para outro representante da mesma unidade familiar admissionOriginType: type: string enum: – V1 – V2 – V3 description: Indicativo de admissão: * `V1` – Normal * `V2` – Decorrente de ação fiscal * `V3` – Decorrente de decisão judicial internshipGradeType: type: string enum: – V1 – V2 – V3 – V4 – V8 – V9 description: Nível do estágio: * `V1` – 1 – Fundamental * `V2` – 2 – Médio * `V3` – 3 – Formação profissional * `V4` – 4 – Superior * `V8` – 8 – Especial * `V9` – 9 – Mãe social (Lei 7.644/1987) contractType: type: string enum: – EMPLOYEE – DIRECTOR – TRAINEE – APRENTICE – THIRD_PARTY description: Tipo de contrato: * `EMPLOYEE` – Empregado * `DIRECTOR` – Diretor * `TRAINEE` – Estagiário * `APRENTICE` – Aprendiz * `THIRD_PARTY` – Terceiro internshipNatureType: type: string enum: – VO – VN description: Natureza do Estágio: * `VO` – O – Obrigatório * `VN` – N – Não obrigatório calculateType: type: string enum: – MONTH – VACATION – THIRTEENTH_SALARY – PLR description: Base cálculo: * `MONTH` – Mensal * `VACATION` – Férias * `THIRTEENTH_SALARY` – 13º salário * `PLR` – PLR accountType: type: string enum: – CHECKING_ACCOUNT – SAVING_ACCOUNT – SALARY_ACCOUNT – OTHER description: Tipo conta corrente: * `CHECKING_ACCOUNT` – Conta corrente * `SAVING_ACCOUNT` – Conta poupança * `SALARY_ACCOUNT` – Conta salário * `OTHER` – Outros calculationBasisType: type: string enum: – FIXED_VALUE – REFERENCE_VALUE description: Base de cálculo: * `FIXED_VALUE` – Valor fixo * `REFERENCE_VALUE` – Valor referência thirteenthSalaryType: type: string enum: – NO_DEDUCTION – THIRTEENTH_SALARY_ONLY – DEDUCT_THIRTEENTH_SALARY_ADVANCE_AND_FULL_THIRTEENTH_SALARY description: 13º salário: * `NO_DEDUCTION` – Não desconta * `THIRTEENTH_SALARY_ONLY` – Desconta apenas no 13° salário integral * `DEDUCT_THIRTEENTH_SALARY_ADVANCE_AND_FULL_THIRTEENTH_SALARY` – Desconta no adiantamento 13° salário e no 13° salário integral advanceSalaryType: type: string enum: – YES_DEDUCTION – NO_DEDUCTION description: Adiantamento salarial: * `YES_DEDUCTION` – Desconta * `NO_DEDUCTION` – Não desconta vacationType: type: string enum: – YES_DEDUCTION – NO_DEDUCTION description: Férias: * `YES_DEDUCTION` – Desconta * `NO_DEDUCTION` – Não desconta plrSalaryType: type: string enum: – YES_DEDUCTION – NO_DEDUCTION description: Participação dos lucros: * `YES_DEDUCTION` – Desconta * `NO_DEDUCTION` – Não desconta alimonyFgtsType: type: string enum: – NOT_APPLICABLE – PERCENTAGE – VALUE description: Tipo pensão FGTS: * `NOT_APPLICABLE` – Não se aplica * `PERCENTAGE` – Percentual * `VALUE` – Valor totalizerType: type: string enum: – VALUE – REFERENCE description: Tipo do Totalizador: * `VALUE` – Valor * `REFERENCE` – Referência calculationAccumulatorsType: type: string enum: – MONTHLY_SALARY – HOURLY_SALARY – MONTHLY_COMMISSION – HOURLY_COMMISSION – MONTHLY_REMUNERATION – PREVIOUS_MONTH_REMUNERATION – PROPORTIONAL_NORMATIVE_SALARY – REGIONAL_MINIMUM_WAGE – MINIMUM_WAGE – CONTRIBUTION_SALARY – MONTH_IRRF_BASIS – MONTH_IRRF_VALUE – MONTH_VACATION_IRRF_BASIS – MONTH_VACATION_IRRF_VALUE – MONTH_THIRTEENTH_SALARY_IRRF_BASIS – MONTH_THIRTEENTH_SALARY_IRRF_VALUE – MONTH_INSS_BASIS – MONTH_INSS_VALUE – MONTH_THIRTEENTH_SALARY_INSS_BASIS – MONTH_THIRTEENTH_SALARY_INSS_VALUE – MONTH_FGTS_BASIS – MONTH_FGTS_VALUE – CALCULATION_INSS_BASIS – CALCULATION_THIRTEENTH_SALARY_INSS_BASIS – CALCULATION_IRRF_BASIS – CALCULATION_VACATION_IRRF_BASIS – CALCULATION_THIRTEENTH_SALARY_IRRF_BASIS – CALCULATION_FGTS_BASIS – BASIS_FGTS_THIRTEENTH_SALARY – MONTH_INSS_BASIS_OTHER_CONTRACTS – MONTH_INSS_VALUE_OTHER_CONTRACTS – THIRTEENTH_SALARY_INSS_BASIS_OUTHER_CONTRACTS – THIRTEENTH_SALARY_INSS_VALUE_OUTHER_CONTRACTS – MONTH_IRRF_BASIS_OTHER_CONTRACTS – MONTH_VACATION_IRRF_BASIS_OTHER_CONTRACTS – MONTH_THIRTEENTH_SALARY_IRRF_BASIS_OTHER_CONTRACTS – TOTAL_INCOME – TOTAL_DISCOUNTS – GROSS_VALUE_MONTHLY_ADVANCE – IRRF_VALUE_ADVANCE_SALARY – PREVIOUS_REFUND – PREVIOUS_VALUE_OVERFLOW – MONTHLY_SALARY_PAID_WORKER_HOURLY – REMUNERATION_LAST_MONTH_MATERNITY – PPR_IRRF_VALUE – JUDICIAL_PENSION_ADVANCE – DAY_SALARY – MONTH_THIRTEENTH_SALARY_FGTS_BASIS – MONTH_VALUE_FGTS_THIRTEENTH_SALARY – FGTS_PREVIOUS_MONTH_DISMISSAL – FGTS_THIRTEENTH_SALARY_PREVIOUS_MONTH_DISMISSAL – INTEGRAL_NORMATIVE_SALARY – OVERTIME_COMMISSION – MONTH_IRRF_VALUES_OTHER_CONTRACTS – MONTH_VACATION_IRRF_VALUES_OTHER_CONTRACTS – SIMPLIFIED_IRRF_DEDUCTION_MONTHLY_BASIS_OTHER_CONTRACTS – SIMPLIFIED_IRRF_DEDUCTION_THIRTEENTHSALARY_OTHER_CONTRACTS – SIMPLIFIED_IRRF_DEDUCTION_VACATION_OTHER_CONTRACTS – INSS_MONTH_DEDUCTION – TOTAL_THIRTEENTH_SALARY_VALUE – COMPENSATED_FGTS_BASIS – COMPENSATED_FGTS_THIRTEENTH_SALARY_BASIS description: Tipo do acumulador de cálculo: * `MONTHLY_SALARY` – Salário mensal * `HOURLY_SALARY` – Salário hora * `MONTHLY_COMMISSION` – Comissão do mês * `HOURLY_COMMISSION` – Comissão hora * `MONTHLY_REMUNERATION` – Remuneração do mês * `PREVIOUS_MONTH_REMUNERATION` – Remuneração mês anterior * `PROPORTIONAL_NORMATIVE_SALARY` – Salário normativo proporcional * `REGIONAL_MINIMUM_WAGE` – Salário mínimo regional * `MINIMUM_WAGE` – Salário mínimo * `CONTRIBUTION_SALARY` – Salário contribuição * `MONTH_IRRF_BASIS` – Base IR do mês * `MONTH_IRRF_VALUE` – Valor IR do mês * `MONTH_VACATION_IRRF_BASIS` – Base IR férias do mês * `MONTH_VACATION_IRRF_VALUE` – Valor IR férias do mês * `MONTH_THIRTEENTH_SALARY_IRRF_BASIS` – Base IR 13º salário do mês * `MONTH_THIRTEENTH_SALARY_IRRF_VALUE` – Valor IR 13º salário do mês * `MONTH_INSS_BASIS` – Base INSS do mês * `MONTH_INSS_VALUE` – Valor INSS do mês * `MONTH_THIRTEENTH_SALARY_INSS_BASIS` – Base INSS 13º salário do mês * `MONTH_THIRTEENTH_SALARY_INSS_VALUE` – Valor INSS 13º salário do mês * `MONTH_FGTS_BASIS` – Base FGTS do mês * `MONTH_FGTS_VALUE` – Valor FGTS do mês * `CALCULATION_INSS_BASIS` – Base INSS de cálculo * `CALCULATION_THIRTEENTH_SALARY_INSS_BASIS` – Base INSS 13º salário do cálculo * `CALCULATION_IRRF_BASIS` – Base IR do cálculo * `CALCULATION_VACATION_IRRF_BASIS` – Base IR férias do cálculo * `CALCULATION_THIRTEENTH_SALARY_IRRF_BASIS` – Base IR 13º salário do cálculo * `CALCULATION_FGTS_BASIS` – Base FGTS do cálculo * `BASIS_FGTS_THIRTEENTH_SALARY` – Base FGTS 13º salário * `MONTH_INSS_BASIS_OTHER_CONTRACTS` – Base INSS do mês outro contrato * `MONTH_INSS_VALUE_OTHER_CONTRACTS` – Valor INSS do mês outro contrato * `THIRTEENTH_SALARY_INSS_BASIS_OUTHER_CONTRACTS` – Base INSS 13º salário outro contrato * `THIRTEENTH_SALARY_INSS_VALUE_OUTHER_CONTRACTS` – Valor INSS 13º salário outro contrato * `MONTH_IRRF_BASIS_OTHER_CONTRACTS` – Base IR do mês outro contrato * `MONTH_VACATION_IRRF_BASIS_OTHER_CONTRACTS` – Base IR férias outro contrato * `MONTH_THIRTEENTH_SALARY_IRRF_BASIS_OTHER_CONTRACTS` – Base IR 13º salário outro contrato * `TOTAL_INCOME` – Total de proventos * `TOTAL_DISCOUNTS` – Total de descontos * `GROSS_VALUE_MONTHLY_ADVANCE` – Adiantamento do mês (bruto) * `IRRF_VALUE_ADVANCE_SALARY` – Valor IR sobre adiantamento * `PREVIOUS_REFUND` – Troco anterior * `PREVIOUS_VALUE_OVERFLOW` – Estouro anterior * `MONTHLY_SALARY_PAID_WORKER_HOURLY` – Salário mensal horista * `REMUNERATION_LAST_MONTH_MATERNITY` – Remuneração último mês maternidade * `PPR_IRRF_VALUE` – Valor IR participação lucros * `JUDICIAL_PENSION_ADVANCE` – Adto pensão judicial * `DAY_SALARY` – Salário dia * `MONTH_THIRTEENTH_SALARY_FGTS_BASIS` – Base FGTS 13° salário mês * `MONTH_VALUE_FGTS_THIRTEENTH_SALARY` – Valor FGTS 13° salário mês * `FGTS_PREVIOUS_MONTH_DISMISSAL` – FGTS mês anterior rescisão * `FGTS_THIRTEENTH_SALARY_PREVIOUS_MONTH_DISMISSAL` – FGTS 13º salário anterior rescisão * `INTEGRAL_NORMATIVE_SALARY` – Salário normativo integral * `OVERTIME_COMMISSION` – Comissão hora extra * `MONTH_IRRF_VALUES_OTHER_CONTRACTS` – Valor de IRRF do mês outro contrato * `MONTH_VACATION_IRRF_VALUES_OTHER_CONTRACTS` – Valor de IRRF de férias outro contrato * `SIMPLIFIED_IRRF_DEDUCTION_MONTHLY_BASIS_OTHER_CONTRACTS` – Deduções de IRRF simplificado no mês outro contrato * `SIMPLIFIED_IRRF_DEDUCTION_THIRTEENTHSALARY_OTHER_CONTRACTS` – Deduções de IRRF simplificado no 13º salário outro contrato * `SIMPLIFIED_IRRF_DEDUCTION_VACATION_OTHER_CONTRACTS` – Deduções de IRRF simplificado nas férias outro contrato * `INSS_MONTH_DEDUCTION` – Dedução de INSS pago no mês * `TOTAL_THIRTEENTH_SALARY_VALUE` – Total de 13º pago * `COMPENSATED_FGTS_BASIS` – Base FGTS indenizado * `COMPENSATED_FGTS_THIRTEENTH_SALARY_BASIS` – Base FGTS 13º salário indenizado operatorType: type: string enum: – SUM – SUBTRACT description: Tipo da operação: * `SUM` – + * `SUBTRACT` – – originType: type: string enum: – ACCUMULATORS – WAGETYPE – TOTALIZER description: Tipo da origem: * `ACCUMULATORS` – Acumulador * `WAGETYPE` – Evento * `TOTALIZER` – Totalizador originInformationType: type: string enum: – ACCUMULATORS – WAGETYPE – GENERAL_VALUES description: Tipo da informação de origem: * `ACCUMULATORS` – Acumuladores * `WAGETYPE` – Evento * `GENERAL_VALUES` – Valores Gerais basesType: type: string enum: – VALUE_WAGE_TYPE – VALUE_PROPORTIONAL_WORKING_HOURS_AND_DSR – VALUE_PROPORTIONAL_TO_ONE_HOUR – VALUE_PROPORTIONAL_NIGHT_HOURS description: Tipo de Base: * `VALUE_WAGE_TYPE` – Valor do Evento * `VALUE_PROPORTIONAL_WORKING_HOURS_AND_DSR` – Valor Proporcional as Horas úteis + Horas DSR * `VALUE_PROPORTIONAL_TO_ONE_HOUR` – Valor Proporcional a uma hora de trabalho * `VALUE_PROPORTIONAL_NIGHT_HOURS` – Valor Proporcional de Horas Noturnas processType: type: string enum: – COLLECTIVE_PROGRAMING – COLLECTIVE_HISTORY – COLLECTIVE_INCLUSION_EMPLOYEE_SELECTION_HISTORY – COLLECTIVE_EXCLUSION_EMPLOYEE_SELECTION_HISTORY description: Tipos de processo: * `COLLECTIVE_PROGRAMING` – Programações coletivas * `COLLECTIVE_HISTORY` – Históricos coletivos * `COLLECTIVE_INCLUSION_EMPLOYEE_SELECTION_HISTORY` – Inclusão coletiva de histórico de código de seleção * `COLLECTIVE_EXCLUSION_EMPLOYEE_SELECTION_HISTORY` – Exclusão coletiva de histórico de código de seleção salaryType: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 description: Tipo do salário: * `V1` – Por hora * `V2` – Por dia * `V3` – Por semana * `V4` – Por quinzena * `V5` – Por mês * `V6` – Por tarefa * `V7` – Comissionado – salário exclusivamente variável timeShiftType: type: string enum: – FIRSTSHIFT – SECONDSHIFT – THIRDSHIFT – FOURTHSHIFT – MIXEDDAYTIME – MIXEDNIGHTTIME – GENERAL description: Turno do horário: * `FIRSTSHIFT` – 1º Turno * `SECONDSHIFT` – 2º Turno * `THIRDSHIFT` – 3º Turno * `FOURTHSHIFT` – 4º Turno * `MIXEDDAYTIME` – Misto predominante diurno * `MIXEDNIGHTTIME` – Misto predominante noturno * `GENERAL` – Geral remoteWorkModalityType: type: string enum: – INTEGRAL – PARTIAL – HYBRID – OTHERS description: Modalidade de teletrabalho: * `INTEGRAL` – Integral * `PARTIAL` – Parcial * `HYBRID` – Híbrido * `OTHERS` – Outros eSocialAnnotationType: type: string enum: – V0 – V6 – V7 – V8 – V10 – V11 – V12 – V13 description: Tipo de anotação para o eSocial: * `V0` – Não se aplica * `V6` – Sucessão * `V7` – Descrição de salário * `V8` – Deficiência * `V10` – Regime de jornada * `V11` – Observações de contrato de trabalho * `V12` – Autorização para trabalhar em instalações elétricas * `V13` – Operação e realização de intervenções em máquinas workExpenseAllowanceType: type: string enum: – COMPANY – EMPLOYEE description: Custos de comparecimento: * `COMPANY` – Empresa * `EMPLOYEE` – Empregado dependentType: type: string enum: – V1 – V2 – V3 – V6 – V9 – V10 – V11 – V12 – V99 description: Tipo de dependente: * `V1` – 1 – Cônjuge * `V2` – 2 – Companheiro(a) com o(a) qual tenha filho ou viva há mais de 5 (cinco) anos ou possua declaração de união estável * `V3` – 3 – Filho(a) ou enteado(a) * `V6` – 6 – Irmão(ã), neto(a) ou bisneto(a) sem arrimo dos pais, do(a) qual detenha a guarda judicial * `V9` – 9 – Pais, avós e bisavós * `V10` – 10 – Menor pobre do qual detenha a guarda judicial * `V11` – 11 – Pessoa absolutamente incapaz, da qual seja tutor ou curador * `V12` – 12 – Ex-cônjuge * `V99` – 99 – Agregado/Outros userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status employeeDiscountAuthorizationSyndicateHistoryDTO: description: DTO – Histórico de autorizações de descontos sindicais type: object required: – employee – competenceInitial – contributionType properties: id: type: string description: Identificador único employee: type: string description: Colaborador competenceInitial: type: string format: date description: Competência inicial competenceFinal: type: string format: date description: Competência final contributionType: type: string description: Tipo de contribuição discountInitialCompetency: type: boolean description: Efetuar desconto na competência de início default: false observation: type: string description: Observação attachments: type: array items: type: object allOf: – #/definitions/AttachmentDTO description: Anexos employeeDiscountAuthorizationSyndicateHistoryCollectiveDTO: description: DTO – Histórico coletivo de autorizações de descontos sindicais type: object required: – competenceInitial – contributionType properties: competenceInitial: type: string format: date description: Competência inicial competenceFinal: type: string format: date description: Competência final contributionType: type: string description: Tipo de contribuição discountInitialCompetency: type: boolean description: Efetuar desconto na competência de início default: false observation: type: string description: Observação employeeOppositionDiscountSyndicateHistoryDTO: description: DTO – Histórico de oposições de descontos sindicais type: object required: – employee – contributionType – competenceInitial properties: id: type: string description: Identificador único employee: type: string description: Colaborador contributionType: type: string description: Tipo de contribuição competenceInitial: type: string format: date description: Competência inicial competenceFinal: type: string format: date description: Competência final observation: type: string description: Observação attachments: type: array items: type: object allOf: – #/definitions/AttachmentDTO description: Anexos AttachmentDTO: description: DTO – Anexo type: object required: – name – idBlobService – version properties: id: type: string description: Identificador único name: type: string description: Nome idBlobService: type: string description: Id Blob Service type: string description: Versão employeeOppositionDiscountSyndicateHistoryCollectiveDTO: description: DTO – Histórico coletivo de oposições de descontos sindicais type: object required: – competenceInitial – contributionType properties: competenceInitial: type: string format: date description: Competência inicial competenceFinal: type: string format: date description: Competência final observation: type: string description: Observação contributionType: type: string description: Tipo de contribuição employeeSelectionHistoryCollectiveDTO: description: DTO – Histórico coletivo de código de seleção type: object required: – competenceInitial – selection properties: competenceInitial: type: string format: date description: Competência inicial competenceFinal: type: string format: date description: Competência final selection: type: string description: Código de seleção filterBatchDTO: description: Filtro de batch type: object properties: companies: type: array items: type: string description: Empresas employees: type: array items: type: string description: Colaboradores advancedFilter: type: string maxLength: 36 description: Filtro avançado employeeIdDTO: description: Identificador do colaborador type: object required: – id – code – companyCode properties: id: type: string description: ids do colaborador code: type: integer format: int64 description: Codigo do colaborador companyCode: type: integer format: int64 description: Código da empresa lookupItem: description: Resultado de consulta de lookup type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro employeeDependentCompanyTransferData: description: Dados dos dependentes do colaborador transferido type: object required: – previousEmployeeDependent – newEmployeeDependent properties: previousEmployeeDependent: type: string maxLength: 36 description: Colaborador origem newEmployeeDependent: type: string maxLength: 36 description: Colaborador destino employeeDependentBank: description: Dependentes – Dados bancários type: object required: – employeeDependent – bankBranch – bankAccountType – bankAccount – bankAccountDigit – percentageAccount properties: id: type: string format: uuid description: Identificador único employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente bankBranch: type: object allOf: – #/definitions/e030age description: Agência bankAccountType: type: string allOf: – #/definitions/accountType description: Tipo Conta bankAccount: type: string description: Conta bancária bankAccountDigit: type: string description: Dígito conta percentageAccount: type: number format: double description: Percentual conta minimum: 0.01 maximum: 100 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeDependentBank: type: object required: – id allOf: – #/definitions/employeeDependentBank employeeAdditionalContractHistory: description: Histórico de adicionais por Colaborador type: object required: – employee – competenceInitial – insalubrityAdditionalPercentage – hazardAdditionalPercentage properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador competenceInitial: type: string format: date description: Competência inicial competenceFinal: type: string format: date description: Competência final insalubrityAdditionalPercentage: type: number format: double description: % Adicional insalubridade maximum: 999.99 specialRetirement: type: string allOf: – #/definitions/specialRetirementType description: Aposentadoria especial hazardAdditionalPercentage: type: number format: double description: % Adicional periculosidade maximum: 999.99 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeAdditionalContractHistory: type: object required: – id allOf: – #/definitions/employeeAdditionalContractHistory employeeDependentFamilySalary: description: Dependentes salário família type: object required: – employeeDependent – noAgeLimitFamilySalary – startDate – endDate properties: id: type: string format: uuid description: Identificador único employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente noAgeLimitFamilySalary: type: boolean description: Dependente sem limite de idade startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeDependentFamilySalary: type: object required: – id allOf: – #/definitions/employeeDependentFamilySalary employeeDependentIrrf: description: Dependentes IRRF type: object required: – employeeDependent – startDate – endDate properties: id: type: string format: uuid description: Identificador único employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente noAgeLimitIRRF: type: boolean description: Dependente sem limite de idade default: false ageLimitIRRF: type: integer format: int64 description: Idade limite IRRF startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeDependentIrrf: type: object required: – id allOf: – #/definitions/employeeDependentIrrf employeeOppositionDiscountSyndicateHistory: description: Histórico de oposições de descontos sindicais type: object required: – employee – contributionType – competenceInitial properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador contributionType: type: object allOf: – #/definitions/contributionType description: Tipo de contribuição competenceInitial: type: string format: date description: Competência inicial competenceFinal: type: string format: date description: Competência final observation: type: string description: Observação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeOppositionDiscountSyndicateHistory: type: object required: – id allOf: – #/definitions/employeeOppositionDiscountSyndicateHistory employeeDiscountAuthorizationSyndicateHistory: description: Histórico de autorizações de descontos sindicais type: object required: – employee – competenceInitial – contributionType properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador competenceInitial: type: string format: date description: Competência inicial competenceFinal: type: string format: date description: Competência final contributionType: type: object allOf: – #/definitions/contributionType description: Tipo de contribuição discountInitialCompetency: type: boolean description: Efetuar desconto na competência de início default: false observation: type: string description: Observação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeDiscountAuthorizationSyndicateHistory: type: object required: – id allOf: – #/definitions/employeeDiscountAuthorizationSyndicateHistory employeeDiscountAuthorizationSyndicateHistoryAttachment: description: Anexo do histórico de autorizações de descontos sindicais type: object required: – employeeDiscountAuthorizationSyndicateHistory – name – idBlobService – version properties: id: type: string format: uuid description: Identificador único employeeDiscountAuthorizationSyndicateHistory: type: object allOf: – #/definitions/employeeDiscountAuthorizationSyndicateHistory description: Histórico de autorizações de descontos sindicais name: type: string description: Nome idBlobService: type: string description: Id Blob Service 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: editEmployeeDiscountAuthorizationSyndicateHistoryAttachment: type: object required: – id allOf: – #/definitions/employeeDiscountAuthorizationSyndicateHistoryAttachment employeeOppositionDiscountSyndicateHistoryAttachment: description: Anexo do histórico de oposições de descontos sindicais type: object required: – employeeOppositionDiscountSyndicateHistory – name – idBlobService – version properties: id: type: string format: uuid description: Identificador único employeeOppositionDiscountSyndicateHistory: type: object allOf: – #/definitions/employeeOppositionDiscountSyndicateHistory description: Histórico de oposições de descontos sindicais name: type: string description: Nome idBlobService: type: string description: Id Blob Service 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: editEmployeeOppositionDiscountSyndicateHistoryAttachment: type: object required: – id allOf: – #/definitions/employeeOppositionDiscountSyndicateHistoryAttachment employeeDependentConcessionBasesMonthAlimony: description: Base de cálculo mensal – pensão judicial type: object required: – employeeDependentConcession – operatorType – originType – basesType properties: id: type: string format: uuid description: Identificador único employeeDependentConcession: type: object allOf: – #/definitions/employeeDependentConcession description: Dependente concessão operatorType: type: string allOf: – #/definitions/operatorType description: Tipo da operação originType: type: string allOf: – #/definitions/originType description: Origem wageType: type: object allOf: – #/definitions/wageType description: Evento accumulators: type: object allOf: – #/definitions/accumulators description: Acumulador totalizer: type: object allOf: – #/definitions/totalizer description: Totalizador basesType: type: string allOf: – #/definitions/basesType description: Tipo de base createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeDependentConcessionBasesMonthAlimony: type: object required: – id allOf: – #/definitions/employeeDependentConcessionBasesMonthAlimony employeeDependentConcessionBasesThirteenthAlimony: description: Bases de cálculo 13º – pensão judicial type: object required: – employeeDependentConcession – operatorType – originType – basesType properties: id: type: string format: uuid description: Identificador único employeeDependentConcession: type: object allOf: – #/definitions/employeeDependentConcession description: Dependente concessão operatorType: type: string allOf: – #/definitions/operatorType description: Tipo da operação originType: type: string allOf: – #/definitions/originType description: Origem wageType: type: object allOf: – #/definitions/wageType description: Evento accumulators: type: object allOf: – #/definitions/accumulators description: Acumulador totalizer: type: object allOf: – #/definitions/totalizer description: Totalizador basesType: type: string allOf: – #/definitions/basesType description: Tipo de base createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeDependentConcessionBasesThirteenthAlimony: type: object required: – id allOf: – #/definitions/employeeDependentConcessionBasesThirteenthAlimony employeeDependentAlimonyPayee: description: Alimentando – Pensão judicial type: object required: – competence – employeeDependent – percentageValue properties: id: type: string format: uuid description: Identificador único competence: type: string format: date description: Competência employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente percentageValue: type: number format: double description: Percentual minimum: 0.0 maximum: 100.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeDependentAlimonyPayee: type: object required: – id allOf: – #/definitions/employeeDependentAlimonyPayee employeeDependentConcessionBasesVacationAlimony: description: Bases de cálculo férias – Pensão judicial type: object required: – employeeDependentConcession – operatorType – originType – basesType properties: id: type: string format: uuid description: Identificador único employeeDependentConcession: type: object allOf: – #/definitions/employeeDependentConcession description: Dependente concessão operatorType: type: string allOf: – #/definitions/operatorType description: Tipo da operação originType: type: string allOf: – #/definitions/originType description: Origem wageType: type: object allOf: – #/definitions/wageType description: Evento accumulator: type: object allOf: – #/definitions/accumulators description: Acumulador totalizer: type: object allOf: – #/definitions/totalizer description: Totalizador basesType: type: string allOf: – #/definitions/basesType description: Tipo de base createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeDependentConcessionBasesVacationAlimony: type: object required: – id allOf: – #/definitions/employeeDependentConcessionBasesVacationAlimony employeeSelectionHistory: description: Histórico de código de seleção por colaborador type: object required: – employee – selection – competenceInitial properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador selection: type: object allOf: – #/definitions/selection description: Código de seleção competenceInitial: type: string format: date description: Competência inicial competenceFinal: type: string format: date description: Competência final createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeSelectionHistory: type: object required: – id allOf: – #/definitions/employeeSelectionHistory employeeRemoteWorkHistory: description: Histórico de teletrabalho type: object required: – employee – startDate – remoteWorkModalityType – eSocialAnnotationType – employeeResponsability – workExpenseAllowanceType 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 remoteWorkModalityType: type: string allOf: – #/definitions/remoteWorkModalityType description: Modalidade de teletrabalho remoteWorkModalityDaysOrHours: type: string description: Especificar dias ou horário do teletrabalho eSocialAnnotationType: type: string allOf: – #/definitions/eSocialAnnotationType description: Tipo de anotação para o eSocial employeeResponsability: type: string description: Responsabilidades do colaborador workExpenseAllowanceType: type: string allOf: – #/definitions/workExpenseAllowanceType description: Custos de comparecimento allowanceCost: type: string description: Valor da ajuda de custo minimum: 0 detailAllowanceCost: type: string description: Detalhamento da ajuda de custo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeRemoteWorkHistory: type: object required: – id allOf: – #/definitions/employeeRemoteWorkHistory employeeDependentTypeHistory: description: Histórico de tipo de dependente type: object required: – employeeDependent – dependentType – startDate – sendToEsocial properties: id: type: string format: uuid description: Identificador único employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente dependentType: type: string allOf: – #/definitions/dependentType description: Tipo de dependente dependencyDescription: type: string maxLength: 100 description: Descrição da dependência startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final sendToEsocial: type: boolean description: Enviar para o eSocial incapableToWork: type: boolean description: Incapaz para o trabalho default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeDependentTypeHistory: type: object required: – id allOf: – #/definitions/employeeDependentTypeHistory employee: description: Colaborador type: object required: – hireDate – code properties: id: type: string format: uuid description: Identificador único employer: type: object allOf: – #/definitions/e070emp description: Empresa que o contratou employmentRelationship: type: object allOf: – #/definitions/employmentRelationship description: Vínculo empregatício person: type: object allOf: – #/definitions/e001pes description: Pessoa hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de desligamento registrationNumber: type: integer format: int64 description: Ficha registro do colaborador code: type: integer format: int64 description: Cadastro eSocialRegistration: type: string description: Matrícula do eSocial admissionType: type: string allOf: – #/definitions/admissionType description: Tipo de admissão eSocial admissionOriginType: type: string allOf: – #/definitions/admissionOriginType description: Indicativo de admissão processNumber: type: string maxLength: 20 description: Número do processo employeeSnapshot: type: object allOf: – #/definitions/employeeSnapshot description: Históricos correntes do colaborador internshipNatureType: type: string allOf: – #/definitions/internshipNatureType description: Natureza do Estágio internshipGradeType: type: string allOf: – #/definitions/internshipGradeType description: Nível internshipActing: type: string maxLength: 100 description: Área de atuação internshipInsurancePolicy: type: string maxLength: 30 description: Apólice de seguro internshipEstimatedTermination: type: string format: date description: Previsão de término email: type: string maxLength: 255 description: Email companyTransferDate: type: string format: date description: Data de transferência deleted: 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: e001pes: description: Pessoa type: object required: – codPes – nomPes properties: id: type: string format: uuid description: Identificador único codPes: type: integer format: int64 description: Código nomPes: type: string maxLength: 100 description: Nome numNis: type: string maxLength: 11 description: Número de inscrição do segurado (NIS, NIT e PIS/PASEP) datNas: type: string format: date description: Data nascimento cnpCpf: type: string maxLength: 14 description: CNPJ/CPF 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: 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 companyIndications: type: object allOf: – #/definitions/companyIndications description: Assinalamentos 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: companyIndications: description: Assinalamentos da empresa type: object properties: id: type: string format: uuid description: Identificador único wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Tabela de eventos company: type: object allOf: – #/definitions/e070emp description: Empresa deleted: 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: string description: Código name: type: string description: Nome x-i18n: true contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato deleted: 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: 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. employmentRelationshipPayroll: description: Vínculo empregatício – Definições da folha type: object required: – employmentRelationship properties: id: type: string format: uuid description: Identificador único employmentRelationship: type: object allOf: – #/definitions/employmentRelationship description: Vínculo remoteWork: type: boolean description: Teletrabalho default: false deleted: 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: employeeDependent: description: Dependentes do colaborador type: object properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador dependent: type: object allOf: – #/definitions/e001pes description: Dependente deleted: 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: contributionType: description: Tipos de contribuições sindicais 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 deleted: 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: e030age: description: Agência type: object required: – codAge – nomAge – abrAge properties: id: type: string format: uuid description: Id da entidade e030ban: type: object allOf: – #/definitions/e030ban description: Banco codAge: type: string maxLength: 7 description: Agência nomAge: type: string maxLength: 30 description: Nome abrAge: type: string maxLength: 10 description: Abreviatura deleted: 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: e030ban: description: Banco type: object required: – codBan – nomBan – abrBan properties: id: type: string format: uuid description: Id da entidade codBan: type: string maxLength: 3 description: Banco nomBan: type: string maxLength: 100 description: Nome abrBan: type: string maxLength: 10 description: Abreviatura deleted: 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: employeeDependentConcession: description: Concessão pensão judicial type: object required: – employeeDependent – concessionInitial – sequence – calculationBasisType – advanceSalaryType properties: id: type: string format: uuid description: Identificador único employeeDependent: type: object allOf: – #/definitions/employeeDependent description: Dependente concessionInitial: type: string format: date description: Início da concessão concessionFinal: type: string format: date description: Fim da concessão sequence: type: integer format: int64 description: Sequência calculationBasisType: type: string allOf: – #/definitions/calculationBasisType description: Base de cálculo standardValue: type: string description: Valor fixo minimum: 0.01 thirteenthSalaryType: type: string allOf: – #/definitions/thirteenthSalaryType description: 13º salário vacationType: type: string allOf: – #/definitions/vacationType description: Férias plrSalaryType: type: string allOf: – #/definitions/plrSalaryType description: Participação dos lucros advanceSalaryType: type: string allOf: – #/definitions/advanceSalaryType description: Adiantamento salarial alimonyFgtsType: type: string allOf: – #/definitions/alimonyFgtsType description: Tipo pensão FGTS minimumValue: type: string description: Valor mínimo default: 0.00 percentageMonthly: type: number format: double description: % Pensão mensal maximum: 100.00 percentageVacation: type: number format: double description: % Pensão férias maximum: 100.00 percentageThirteenth: type: number format: double description: % Pensão 13º maximum: 100.00 percentagePlr: type: number format: double description: % Pensão PLR maximum: 100.00 percentageFgts: type: number format: double description: % Pensão FGTS maximum: 100.00 default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEmployeeDependentConcession: type: object required: – id allOf: – #/definitions/employeeDependentConcession wageTypeTable: description: Tabela de eventos 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: Descrição x-i18n: true deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o 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. wageType: description: Evento type: object required: – code – shortName properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código shortName: type: string maxLength: 30 description: Nome reduzido x-i18n: true validityStart: type: string format: date description: Competência de início da validade validityEnd: type: string format: date description: Competência de término da validade wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Tabela de eventos deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o 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: shortName: type: string maxLength: 30 example: pt-BR: shortName: Exemplo de texto usando locale pt-BR. en-US: shortName: Text example using en-US locale. totalizer: description: Totalizadores type: object required: – code – description – totalizerType properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código description: type: string description: Descrição totalizerType: type: string allOf: – #/definitions/totalizerType description: Tipo do totalizador deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o 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: accumulators: description: Acumuladores da Folha de Pagamento type: object required: – code – description – calculationAccumulatorsType properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Acumulador description: type: string description: Descrição x-i18n: true calculationAccumulatorsType: type: string allOf: – #/definitions/calculationAccumulatorsType description: Tipo do acumulador de cálculo deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação translations: type: object properties: locale: type: object properties: description: type: string example: pt-BR: description: Exemplo de texto usando locale pt-BR. en-US: description: Text example using en-US locale. selection: description: Códigos de seleção type: object required: – code – description properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código description: type: string maxLength: 255 description: Descrição wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Tabela de eventos deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o 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: 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 company: type: string format: uuid description: Empresa corrente do colaborador companyCode: type: integer format: int64 description: Código da empresa corrente do colaborador companyBranch: type: string format: uuid description: Filial corrente do colaborador companyBranchCode: type: integer format: int64 description: Código da filial corrente do colaborador companyBranchName: type: string description: Nome da filial employmentRelationship: type: string format: uuid description: Vínculo empregatício corrente do colaborador employmentRelationshipCode: type: string description: Código do vínculo empregatício corrente do colaborador employmentRelationshipContractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato vínculo empregatício corrente do colaborador jobPosition: type: string format: uuid description: Cargo corrente do colaborador jobPositionCode: type: integer format: int64 description: Código do cargo corrente do colaborador position: type: string format: uuid description: Posição corrente do colaborador positionCode: type: integer format: int64 description: Código da posição corrente do colaborador salaryHistorySalaryType: type: string allOf: – #/definitions/salaryType description: Tipo de salário corrente do colaborador syndicate: type: string format: uuid description: Sindicato corrente do colaborador syndicateCode: type: integer format: int64 description: Código do sindicato corrente do colaborador workshift: type: string format: uuid description: Escala corrente do colaborador workshiftCode: type: integer format: int64 description: Código da escala corrente do colaborador workshiftTimeShiftType: type: string allOf: – #/definitions/timeShiftType description: Turno do horário corrente do colaborador workshiftGroup: type: string format: uuid description: Turma da escala corrente do colaborador workshiftGroupCode: type: integer format: int64 description: Código da turma da escala corrente do colaborador costCenter: type: string format: uuid description: Centro de custo corrente do colaborador costCenterCode: type: string maxLength: 9 description: Código do centro de custo corrente do colaborador location: type: string format: uuid description: Local corrente do colaborador locationCode: type: integer format: int64 description: Código do local corrente do colaborador deleted: type: boolean description: Indicativo de exclusão do registro extIntSts: type: string maxLength: 100 description: Indica o 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: employeeModule: description: Módulos do colaborador type: object required: – employee – moduleType properties: id: type: string format: uuid description: Identificador employee: type: object allOf: – #/definitions/employee description: Colaborador moduleType: type: string maxLength: 6 description: Tipo do módulo deleted: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica o 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: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage