HCM – Payroll Entry General (general)

2.0info: 5.4.0 HCM – Payroll Entry General description: HCM – Payroll Entry General x-senior-domain: HCM – Payroll Entry General x-senior-domain-path: hcm_payroll_entry 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_entrysecurityDefinitions: 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/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/listEntryMaintenance: post: description: Listar os lançamentos tela de manunteção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – page properties: filter: type: object allOf: – #/definitions/entryMaintenanceFilter description: page: type: object allOf: – #/definitions/pageDTO description: Páginação orderBy: type: string description: Ordenação de campos do objeto de retorno.\nOs campos aceitos são os seguintes:\n- calculationDefinition.competence,\n- calculationDefinition.code,\n- event.code,\n- employee.code,\n- reference,\n- value,\nA direção de ordenação pode ser definida de modo ascendente ou descendente.\nEx.:\n- Ascendente: employee.code+asc ou apenas employee.code\n- Descendente: employee.code+desc\n responses: 200: description: Ok schema: type: object required: – entryMaintenance – totalElements – totalPages properties: entryMaintenance: type: array items: type: object allOf: – #/definitions/entryMaintenanceDTO minimum: 1 description: Lançamentos totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listVariableEntries: post: description: Listar os lançamentos variáveis com incidente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page properties: filter: type: object allOf: – #/definitions/variableEntryFilter description: page: type: object allOf: – #/definitions/pageDTO description: Páginação orderBy: type: string description: Ordenação de campos do objeto de retorno.\nOs campos aceitos são os seguintes:\n- calculationDefinition.competence,\n- calculationDefinition.code,\n- event.code,\n- employee.code,\n- reference,\n- value,\nA direção de ordenação pode ser definida de modo ascendente ou descendente.\nEx.:\n- Ascendente: employee.code+asc ou apenas employee.code\n- Descendente: employee.code+desc\n responses: 200: description: Ok schema: type: object required: – variableEntryWithIdentificationType – totalElements – totalPages properties: variableEntryWithIdentificationType: type: array items: type: object allOf: – #/definitions/variableEntryWithIdentificationTypeDTO minimum: 1 description: Laçamentos variáveis com tipo de identificação totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listFixedEntries: post: description: Lista os lançamentos fixos com o campo incidente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagination properties: filter: type: object allOf: – #/definitions/fixedEntryFilter description: Filtro pagination: type: object allOf: – #/definitions/pageDTO description: Paginação orderBy: type: array items: type: object allOf: – #/definitions/order description: Ordenação responses: 200: description: Ok schema: type: object required: – fixedEntries – totalElements – totalPages properties: fixedEntries: type: array items: type: object allOf: – #/definitions/fixedEntryListDto minimum: 1 description: Lançamentos fixos totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listWageTypeExportLayout: post: description: Listar layout de exportação de eventos para folha tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – page properties: filter: type: object allOf: – #/definitions/wageTypeExportLayoutFilter description: Filtro page: type: object allOf: – #/definitions/pageDTO description: Páginação orderBy: type: string description: Ordenação de campos do objeto de retorno.\nOs campos aceitos são os seguintes:\n- name,\n- code\nA direção de ordenação pode ser definida de modo ascendente ou descendente.\nEx.:\n- Ascendente: code+asc ou apenas code\n- Descendente: code+desc\n responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/wageTypeExportLayout minimum: 1 description: Layouts de exportação de eventos totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getWageTypeExportLayoutDetails: post: description: Detalhes layout de exportação de eventos para folha tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wageTypeExportLayoutId properties: wageTypeExportLayoutId: type: string maxLength: 36 description: Id do layout de exportação de eventos responses: 200: description: Ok schema: type: object required: – wageTypeExportLayout – wageTypeExportLayoutField properties: wageTypeExportLayout: type: object allOf: – #/definitions/wageTypeExportLayout description: Layout de exportação de eventos wageTypeExportLayoutField: type: array items: type: object allOf: – #/definitions/wageTypeExportLayoutField minimum: 1 description: Campos do layout de exportação de eventos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Detalhes layout de exportação de eventos para folha tags: – Queries x-senior-visibility: PRIVATE parameters: – name: wageTypeExportLayoutId description: Id do layout de exportação de eventos in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – wageTypeExportLayout – wageTypeExportLayoutField properties: wageTypeExportLayout: type: object allOf: – #/definitions/wageTypeExportLayout description: Layout de exportação de eventos wageTypeExportLayoutField: type: array items: type: object allOf: – #/definitions/wageTypeExportLayoutField minimum: 1 description: Campos do layout de exportação de eventos 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/exportFixedEntry: 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/exportVariableEntry: 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/exportCompensatoryOperation: 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/exportPostponedIntegrationOperation: 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/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/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/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/exportCalculationDefinition: 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/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/exportWageTypePayroll: 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/exportCharacteristics: 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/exportRules: 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/exportWageTypeExportLayout: 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/exportWageTypeExportLayoutField: 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/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: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/saveVariableEntries: post: description: Salva os lançamentos variáveis informados na tela de demonstrativo de pagamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId – calculationDefinitionId properties: employeeId: type: string description: Identificador único do colaborador calculationDefinitionId: type: string description: Identificador único da definição de cálculo variableEntries: type: array items: type: object allOf: – #/definitions/variableEntrySaveDto description: Dto com as informaçoes dos lançamentos variáveis responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteNextCalculationEntryInBatch: post: description: Deleta os lançamentos da próxima definição de cálculo pelo id da definição de cálculo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – calculationDefinitionId properties: calculationDefinitionId: type: string description: Identificador único da definição de cálculo employeeIds: type: array items: type: string description: Lista de identificador único de colaboradores responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteNextCalculation: post: description: Exclusão do lançamento da próxima definição de cálculo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee – calculationDefinition properties: employee: type: string maxLength: 36 description: Colaborador calculationDefinition: type: string maxLength: 36 description: Definição de cálculo responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso da exclusão 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 dos lançamentos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – previousCompany – newCompany – previousEmployee – newEmployee properties: processId: type: string maxLength: 36 description: Identificador do processo previousCompany: type: string maxLength: 36 description: Empresa origem newCompany: type: string maxLength: 36 description: Empresa destino previousEmployee: type: string maxLength: 36 description: Colaborador origem newEmployee: 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/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 responses: 200: description: Ok schema: type: object 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/entryFileUploadRequest: 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/entryFileCommitUploadedFile: 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/createWageTypeExportLayout: post: description: Criar layout de exportação de eventos para folha tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wageTypeExportLayout properties: wageTypeExportLayout: type: object allOf: – #/definitions/wageTypeExportLayout description: Layout de exportação de eventos para ser criado/atualizado wageTypeExportLayoutField: type: array items: type: object allOf: – #/definitions/wageTypeExportLayoutField description: Campos do layout de exportação de eventos para serem criados/atualizados responses: 200: description: Ok schema: type: object required: – savedWageTypeExportLayout – savedWageTypeExportLayoutField properties: savedWageTypeExportLayout: type: object allOf: – #/definitions/wageTypeExportLayout description: Layout de exportação de eventos criado/atualizado savedWageTypeExportLayoutField: type: array items: type: object allOf: – #/definitions/wageTypeExportLayoutField minimum: 1 description: Campos do layout de exportação de eventos criados/atualizados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/deleteWageTypeExportLayout: post: description: Excluir layout de exportação de eventos para folha tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wageTypeExportLayoutId properties: wageTypeExportLayoutId: type: string maxLength: 36 description: Id do layout de exportação de eventos que será excluido 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/importFixedEntry: 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/importVariableEntry: 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/importCompensatoryOperation: 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/importPostponedIntegrationOperation: 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/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/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/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/importCalculationDefinition: 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/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/importWageTypePayroll: 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/importCharacteristics: 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/importRules: 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/actions/importWageTypeExportLayout: 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/importWageTypeExportLayoutField: 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/completeDistributedTransaction: post: description: Completa uma transação distribuída (Saga), executando as operações pendentes. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – transactionId properties: transactionId: type: string maxLength: 255 description: Identificador da transação (Saga) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/compensateSaveClockingEventEvents: post: description: Inicia a compensação de lançamentos de eventos gerados pelo ponto. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – batchId properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote employeeIds: type: array items: type: string description: Lista de identificadores dos colaboradores a serem compensados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/saveClockingEventEvents: post: description: Salva os eventos gerados pelo ponto tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – clockingEventEventsBatchInfo properties: clockingEventEventsBatchInfo: type: object allOf: – #/definitions/clockingEventEventsBatchInfo description: Informações sobre o bloco e o processo employeeEvents: type: array items: type: object allOf: – #/definitions/employeeEventDTO description: Colaboradores com seus eventos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/fixedEntryImport: post: description: Processa a importação dos lançamentos fixos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – definitionType – file properties: definitionType: type: string allOf: – #/definitions/definitionType description: Tipo da definição file: type: object allOf: – #/definitions/fileDTO description: Informações do arquivo a ser importado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/variableEntryImport: post: description: Processa a importação dos lançamentos variáveis tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – file properties: definitionType: type: string allOf: – #/definitions/definitionType description: Tipo da definição file: type: object allOf: – #/definitions/fileDTO description: Informações do arquivo a ser importado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/finishedProcess: 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 – processTypeDescription – startDate – startedBy – unit properties: processId: type: string description: Identificador único do processo processType: type: string description: Tipo de processo processTypeDescription: type: string description: Descrição do tipo do Processo. startDate: type: string format: date-time description: Data de Início do Processo endDate: type: string format: date-time description: Data de Término do Processo total: type: integer format: int64 description: Quantidade total de registros a serem processados default: 0 processed: type: integer format: int64 description: Quantidade total de registros processados processedWithError: type: integer format: int64 description: Quantidade de registros processados com erro default: 0 successfullyProcessed: type: integer format: int64 description: Quantidade de registros processados com sucesso default: 0 unprocessed: type: integer format: int64 description: Quantidade de registros não processados default: 0 startedBy: type: string description: Usuário que iniciou o processo unit: type: string description: Unidade dos itens que estão sendo processados (colaboradores, apurações, etc.) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/events/calculationExclusionFinished: post: description: Notifica que a exclusão dos lançamentos futuros foi finalizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – company – calculationDefinitionData – batchDescription properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote de colaboradores company: type: object allOf: – #/definitions/companyData description: Informações referentes à empresa calculationDefinitionData: type: object allOf: – #/definitions/calculationDefinitionData description: Informações referentes ao código de cálculo batchDescription: type: string description: Descrição logDebugEnabled: type: boolean description: Log de depuração habilitado default: false monitorEnabled: type: boolean description: Monitor habilitado default: false responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/legacyEntityChanged: post: description: Evento genérico de mudança numa entidade que possui integração de volta para o HCM x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/legacyEntityOperation responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/legacyVariableEntryChanged: post: description: Evento de mudança do lançamento variável para a integração de volta para o HCM x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – operation – details properties: operation: type: object allOf: – #/definitions/legacyEntityOperation description: Operação realizada details: type: object allOf: – #/definitions/variableEntry description: Detalhes da operação realizada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/saveClockingEventEventsFailed: post: description: Informa os colaboradores que tiveram falhas no salvamento de eventos gerados pelo ponto. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId properties: processId: type: string description: Id do processo batchId: type: string description: Id do lote de colaboradores. employeesFailed: type: array items: type: object allOf: – #/definitions/employeeFailedDTO description: Informações dos colaboradores com falha responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/saveClockingEventEventsFinished: post: description: Notifica a conclusão do salvamente de eventos gerados pelo ponto, para orquestração. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId properties: processId: type: string description: Id do processo batchId: type: string description: Id do lote de colaboradores. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/compensateSaveClockingEventEventsFinished: post: description: Notifica a conclusão da compensação de eventos gerados pelo ponto x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId properties: processId: type: string maxLength: 36 description: Id do processo batchId: type: string maxLength: 36 description: Id do lote responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importFixedEntryEvent: 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/exportFixedEntryEvent: 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/importVariableEntryEvent: 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/exportVariableEntryEvent: 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/importCompensatoryOperationEvent: 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/exportCompensatoryOperationEvent: 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/importPostponedIntegrationOperationEvent: 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/exportPostponedIntegrationOperationEvent: 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/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/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/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/importCalculationDefinitionEvent: 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/exportCalculationDefinitionEvent: 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/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/importWageTypePayrollEvent: 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/exportWageTypePayrollEvent: 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/importCharacteristicsEvent: 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/exportCharacteristicsEvent: 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/importRulesEvent: 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/exportRulesEvent: 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/events/importWageTypeExportLayoutEvent: 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/exportWageTypeExportLayoutEvent: 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/importWageTypeExportLayoutFieldEvent: 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/exportWageTypeExportLayoutFieldEvent: 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/fixedEntry: 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/fixedEntry responses: 200: description: The created resource schema: #/definitions/fixedEntry 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/fixedEntry responses: 200: description: The created resource schema: #/definitions/fixedEntry 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/fixedEntry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/fixedEntry/{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/editFixedEntry responses: 200: description: Ok schema: #/definitions/editFixedEntry 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/fixedEntry responses: 200: description: Ok schema: #/definitions/fixedEntry 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/fixedEntry 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/fixedEntry/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/fixedEntry responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/variableEntry: 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/variableEntry responses: 200: description: The created resource schema: #/definitions/variableEntry 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/variableEntry responses: 200: description: The created resource schema: #/definitions/variableEntry 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/variableEntry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/variableEntry/{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/editVariableEntry responses: 200: description: Ok schema: #/definitions/editVariableEntry 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/variableEntry responses: 200: description: Ok schema: #/definitions/variableEntry 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/variableEntry 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/variableEntry/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/variableEntry 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 originType: type: string enum: – TYPED – IMPORTED – CLOCKINGEVENT description: Origem: * `TYPED` – Digitado * `IMPORTED` – Importado * `CLOCKINGEVENT` – Ponto calculationType: type: string enum: – MONTHLY_PAYROLL – ADVANCE_SALARY – THIRTEENTH_SALARY – ADVANCE_THIRTEENTH_SALARY – INDIVIDUAL_VACATION – COLLECTIVE_VACATION – DISMISSAL – SUPPLEMENTARY_PAYROLL – SUPPLEMENTARY_LABOR_AGREEMENT – SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL – SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION – SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS – SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL – THIRD_PARTY_PAYMENT description: Tipo de cálculo: * `MONTHLY_PAYROLL` – Folha mensal * `ADVANCE_SALARY` – Adiantamento salarial * `THIRTEENTH_SALARY` – 13º salário integral * `ADVANCE_THIRTEENTH_SALARY` – Adiantamento 13º salário * `INDIVIDUAL_VACATION` – Férias individuais * `COLLECTIVE_VACATION` – Férias coletivas * `DISMISSAL` – Rescisão individual * `SUPPLEMENTARY_PAYROLL` – Folha complementar * `SUPPLEMENTARY_LABOR_AGREEMENT` – Dissídio complementar * `SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL` – Folha de pagamento de dissídio * `SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION` – Rescisão complementar – Erro ou omissão * `SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS` – Rescisão complementar – Comissões pendentes * `SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL` – Rescisão complementar – Dissídio * `THIRD_PARTY_PAYMENT` – Cálculo de RPA valueType: type: string enum: – MONTH_OVERFLOW – MONTH_REFUND description: Tipo do valor: * `MONTH_OVERFLOW` – Estouro do mês * `MONTH_REFUND` – Troco do mês 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 timeShiftType: type: string enum: – FIRSTSHIFT – SECONDSHIFT – THIRDSHIFT – FOURTHSHIFT – MIXEDDAYTIME – MIXEDNIGHTTIME – GENERAL description: Turno da escala: * `FIRSTSHIFT` – 1º Turno * `SECONDSHIFT` – 2º Turno * `THIRDSHIFT` – 3º Turno * `FOURTHSHIFT` – 4º Turno * `MIXEDDAYTIME` – Misto predominante diurno * `MIXEDNIGHTTIME` – Misto predominante noturno * `GENERAL` – Geral identificationType: type: string enum: – SALARY_PROCEEDS_OR_ALLOWANCE – DEDUCTION – INFORMATIVE – DEDUCTIVE_INFORMATIVE description: Tipo Evento: * `SALARY_PROCEEDS_OR_ALLOWANCE` – Vencimento, provento ou pensão devida * `DEDUCTION` – Desconto * `INFORMATIVE` – Informativa * `DEDUCTIVE_INFORMATIVE` – Informativa dedutora orderType: type: string enum: – ASC – DESC description: Direção da ordenação: * `ASC` – Ascendente * `DESC` – Descendente referenceType: type: string enum: – HOUR – DECIMAL description: Tipo de referência: * `HOUR` – Hora * `DECIMAL` – Decimal operationType: type: string enum: – INSERT – UPDATE – DELETE description: Tipo de operação: * `INSERT` – Inserção * `UPDATE` – Atualização * `DELETE` – Exclusão doubleType: type: string enum: – DESPISE – KEEP description: Eventos duplos: * `DESPISE` – Desprezar * `KEEP` – Manter definitionType: type: string enum: – KEEP_WAGETYPE – REPLACE_WAGETYPE – ADD_WAGETYPE description: Tipo da definição do comportamento da importação de lançamentos: * `KEEP_WAGETYPE` – Manter o evento existente * `REPLACE_WAGETYPE` – Substituir o evento existente * `ADD_WAGETYPE` – Somar ao evento existente wageTypeExportLayoutFormat: type: string enum: – CSV – TXT description: Formato do layout da exportação de eventos para a folha: * `CSV` – Formato csv * `TXT` – Formato txt wageTypeExportLayoutFieldType: type: string enum: – FIXED – VARIABLE description: Tipo do campo do layout da exportação de eventos para a folha: * `FIXED` – Valor fixo * `VARIABLE` – Variável wageTypeExportLayoutFieldVariable: type: string enum: – COMPANY – EMPLOYEE_TYPE – EMPLOYEE_CODE – CALCULATION_DEFINITION – COMPETENCE – WAGE_TYPE_TABLE – WAGE_TYPE – EXTERNAL_WAGE_TYPE – WAGE_TYPE_SEQUENCE – ORIGIN – REFERENCE – COMPETENCE_YEAR – COMPETENCE_MONTH – REFERENCE_INTEGER – REFERENCE_DECIMAL description: Variável do campo do layout da exportação de eventos para a folha: * `COMPANY` – Empresa * `EMPLOYEE_TYPE` – Tipo do colaborador * `EMPLOYEE_CODE` – Cadastro do colaborador * `CALCULATION_DEFINITION` – Código de cálculo * `COMPETENCE` – Competência * `WAGE_TYPE_TABLE` – Tabela de eventos * `WAGE_TYPE` – Evento * `EXTERNAL_WAGE_TYPE` – Evento externo * `WAGE_TYPE_SEQUENCE` – Sequencia do eventos * `ORIGIN` – Origem * `REFERENCE` – Referência * `COMPETENCE_YEAR` – Ano da competência * `COMPETENCE_MONTH` – Mês da competência * `REFERENCE_INTEGER` – Referência (parte inteira) * `REFERENCE_DECIMAL` – Referência (parte decimal) characteristicType: type: string enum: – NORMAL_DAYTIME_HOURS – DSR_DAYTIME_HOURS – OVERTIME_DAYTIME – DSR_OVERTIME – IRRF – FGTS – INSS – FAMILY_SALARY – ADDITIONAL_NIGHT – NORMAL_NIGHT_HOURS – DSR_NIGHT_HOURS – DAYTIME_MEDICAL_LEAVE – NIGHTTIME_MEDICAL_LEAVE – DAYTIME_WORK_ACCIDENT_LEAVE – NIGHTTIME_WORK_ACCIDENT_LEAVE – DAYTIME_ABSENCE – DAYTIME_LOST_DSR – NIGHTTIME_ABSENCE – NIGHTTIME_LOST_DSR – DAYTIME_MATERNITY_LEAVE – NIGHTTIME_MATERNITY_LEAVE – DAYTIME_MATERNITY_LEAVE_NONCRIMINAL_ABORTION – NIGHTTIME_MATERNITY_LEAVE_NONCRIMINAL_ABORTION – DAYTIME_MATERNITY_LEAVE_ANTICIPATION_EXTENSION – NIGHTTIME_MATERNITY_LEAVE_ANTICIPATION_EXTENSION – DAYTIME_ILLNESS_AID – NIGHTTIME_ILLNESS_AID – DAYTIME_LABOR_ACCIDENT – NIGHTTIME_LABOR_ACCIDENT – DAYTIME_MILITARY_SERVICE – NIGHTTIME_MILITARY_SERVICE – DAYTIME_PAID_LEAVE – NIGHTTIME_PAID_LEAVE – DAYTIME_LEAVE_WITHOUT_COMPENSATION – NIGHTTIME_LEAVE_WITHOUT_COMPENSATION – DAYTIME_PATERNITY_LEAVE – NIGHTTIME_PATERNITY_LEAVE – DAYTIME_PATERNITY_LEAVE_CITIZEN_COMPANY – NIGHTTIME_PATERNITY_LEAVE_CITIZEN_COMPANY – DAYTIME_CITIZEN_COMPANY_MATERNITY – NIGHTTIME_CITIZEN_COMPANY_MATERNITY – DAYTIME_MEDICAL_LEAVE_WITHOUT_INSS – NIGHTTIME_MEDICAL_LEAVE_WITHOUT_INSS – DAYTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS – NIGHTTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS – DAYTIME_INSS_MATERNITY_LEAVE – NIGHTTIME_INSS_MATERNITY_LEAVE – HAZARD – OVERTIME_NIGHTTIME – ADDITIONAL_HOURS_ENTRY – INSALUBRITY – ALLOWANCE – TRAVEL_EXPENSE_UP_TO_FIFTY_PERCENTAGE_COMPENSATION – TRANSPORTATION_VOUCHER – MEDICAL_EXPENSES – TIPS – PREMIUMS – DAY_CARE_REIMBURSEMENT – NANNY_REIMBURSEMENT – TRAVEL_EXPENSE_OVER_FIFTY_PERCENTAGE_COMPENSATION – OTHER_PROCEEDS – OTHER_DEDUCTIONS – TRANSPORTATION_VOUCHER_MEAL_TICKET_REIMBURSEMENT – EXCEEDING_FOOD_VOUCHER_MEAL_TICKET – PRECAUTION_HOURS – CORPORATE_OFFICER_WAGE – JUDICIAL_ALIMONY_MONTH – COMMISSIONS – DSR_COMMISSIONS – COMPLEMENT_SALARY – DAYTIME_OVERTIME_COMMISSION – NIGHTTIME_OVERTIME_COMMISSION – MONTH_OVERFLOW – PREVIOUS_MONTH_OVERFLOW – MONTH_REFUND – PREVIOUS_MONTH_REFUND – SYNDICATE_CONTRIBUTIONS – DAYTIME_RETIREMENT_DUE_TO_DISABILITY – NIGHTTIME_RETIREMENT_DUE_TO_DISABILITY – DAYTIME_OTHERS – NIGHTTIME_OTHERS – ADVANCE_THIRTEENTH_SALARY – DISCOUNT_ADVANCE_THIRTEENTH_SALARY – JUDICIAL_ALIMONY_THIRTEENTH_SALARY – ALIMONY_ADVANCE_THIRTEENTH_SALARY – DISCOUNT_ALIMONY_ADVANCE_THIRTEENTH_SALARY – THIRTEENTH_SALARY – MATERNITY_THIRTEENTH_SALARY – MATERNITY_INSS_THIRTEENTH_SALARY – BASE_WORK_ACCIDENT_THIRTEENTH_SALARY – BASE_MILITARY_SERVICE_THIRTEENTH_SALARY – AVERAGE_OVERTIME_ADVANCE_THIRTEENTH_SALARY – AVERAGE_VARIABLE_VALUES_ADVANCE_THIRTEENTH_SALARY – ADDITIONAL_ADVANCE_THIRTEENTH_SALARY – AVERAGE_OVERTIME_THIRTEENTH_SALARY – AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY – ADDITIONAL_THIRTEENTH_SALARY – FGTS_THIRTEENTH_SALARY – COMPLEMENTARY_THIRTEENTH_SALARY – RETURN_COMPLEMENTARY_THIRTEENTH_SALARY – RETURN_MATERNITY_THIRTEENTH_SALARY – RETURN_MATERNITY_INSS_THIRTEENTH_SALARY – RETURN_INSS_THIRTEENTH_SALARY – IRRF_ADVANCE_SALARY – SALARY_ADVANCE_DISCOUNT – INSS_THIRTEENTH_SALARY – IRRF_THIRTEENTH_SALARY – DAYTIME_VACATION_HOURS – NIGHTTIME_VACATION_HOURS – THIRD_OF_VACATION – THIRD_OF_VACATION_PREMIUM – DOUBLE_VACATION_FINE – DOUBLE_VACATION_PREMIUM_FINE – VACATION_PREMIUM – INSS_VACATION_PAY – JUDICIAL_ALIMONY_VACATION – IRRF_VACATION_PAY – AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY_COMPENSATED – AVERAGE_VARIABLE_VALUES_VACATION – AVERAGE_VARIABLE_VALUES_PREMIUM – AVERAGE_VARIABLE_VALUES_PRIOR_NOTICE_COMPENSATED – AVERAGE_VARIABLE_VALUES_PRIOR_NOTICE_NOT_FULLFILLED – AVERAGE_VARIABLE_VALUES_COMPENSATED_PREVIOUS_MONTH_BASE_DATE – AVERAGE_VARIABLE_VALUES_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY – AVERAGE_VARIABLE_VALUES_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE – AVERAGE_VARIABLE_VALUES_VACATION_COMPENSATED_DISMISSAL – AVERAGE_VARIABLE_VALUES_MATERNITY_LEAVE – AVERAGE_VARIABLE_VALUES_INSS_MATERNITY_LEAVE – AVERAGE_VARIABLE_VALUES_CITIZEN_MATERNITY – AVERAGE_OVERTIME_VACATION – AVERAGE_OVERTIME_PREMIUM – AVERAGE_OVERTIME_VACATION_COMPENSATED_DISMISSAL – AVERAGE_OVERTIME_THIRTEENTH_SALARY_COMPENSATED – AVERAGE_OVERTIME_COMPENSATED_PRIOR_NOTICE_COMPENSATED – AVERAGE_OVERTIME_COMPENSATED_PRIOR_NOTICE_NOT_FULLFILLED – AVERAGE_OVERTIME_COMPENSATED_PREVIOUS_MONTH_BASE_DATE – AVERAGE_OVERTIME_STABILITY_DISMISSAL – AVERAGE_OVERTIME_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE – AVERAGE_OVERTIME_THIRTEENTH_SALARY_PROPORTIONAL – AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY_PROPORTIONAL – AVERAGE_VARIABLE_VALUES_STABILITY_DISMISSAL – ADDITIONAL_MATERNITY_SALARY – ADDITIONAL_INSS_MATERNITY_SALARY – ADDITIONAL_THIRTEENTH_SALARY_PROPORTIONAL – ADDITIONAL_PREMIUM – ADDITIONAL_CITIZEN_MATERNITY – ADDITIONAL_PRIOR_NOTICE_COMPENSATED – ADDITIONAL_PRIOR_NOTICE_NOT_FULLFILLED – ADDITIONAL_VACATION_COMPENSATED_DISMISSAL – ADDITIONAL_THIRTEENTH_SALARY_COMPENSATED – ADDITIONAL_COMPENSATED_PREVIOUS_MONTH_BASE_DATE – ADDITIONAL_STABILITY_DISMISSAL – ADDITIONAL_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY – ADDITIONAL_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE – VACATION_PREMIUM_DIFFERENCE – VACATION_DIFFERENCE – VACATION_ADVANCE_DISCOUNT – NEGATIVE_VACATION_DIFFERENCE – NEGATIVE_VACATION_PREMIUM_DIFFERENCE – JUDICIAL_ALIMONY_VACATION_DIFFERENCE – IRRF_VACATION_DIFFERENCE – IRRF_VACATION_DISCOUNT_MONTH_PROPORTIONAL – INSS_VACATION_DIFFERENCE – INSS_VACATION_RETURN – AVERAGE_OVERTIME_MATERNITY_LEAVE – AVERAGE_OVERTIME_INSS_MATERNITY_LEAVE – AVERAGE_OVERTIME_CITIZEN_COMPANY_MATERNITY – PRIOR_NOTICE_COMPENSATED – PRIOR_NOTICE_NOT_FULLFILLED – THIRTEENTH_SALARY_PROPORTIONAL – MATERNITY_THIRTEENTH_SALARY_PROPORTIONAL – THIRTEENTH_SALARY_COMPENSATED – FGTS_DISMISSAL_THIRTEENTH_SALARY_DEPOSITED – FGTS_DISMISSAL_DEPOSITED – VACATION_OVERDUE_DISMISSAL – THIRD_OF_VACATION_OVERDUE_DISMISSAL – DOUBLE_VACATION_OVERDUE_DISMISSAL – VACATION_PROPORTIONAL_DISMISSAL – VACATION_COMPENSATED_DISMISSAL – DISMISSAL_STABILITY – ADDITIONAL_NIGHT_VACATION – AVERAGE_INSALUBRITY_VACATION – AVERAGE_HAZARD_VACATION – COMPENSATED_PREVIOUS_MONTH_BASE_DATE – THIRD_OF_VACATION_COMPENSATED_DISMISSAL – DOUBLE_VACATION_COMPENSATED_DISMISSAL – COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY – COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE – AVERAGE_OVERTIME_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY – COMPENSATED_VACATION_END_CONTRACT_ANTICIPATED_COMPANY – COMPENSATED_VACATION_END_CONTRACT_ANTICIPATED_EMPLOYEE – COMPENSATED_THIRTEENTH_SALARY_END_CONTRACT_ANTICIPATED_COMPANY – COMPENSATED_THIRTEENTH_SALARY_END_CONTRACT_ANTICIPATED_EMPLOYEE – THIRD_OF_VACATION_PROPORTIONAL_DISMISSAL – AVERAGE_OVERTIME_VACATION_PROPORTIONAL_DISMISSAL – AVERAGE_VARIABLE_VALUES_VACATION_PROPORTIONAL_DISMISSAL – ADDITIONAL_VACATION_PROPORTIONAL_DISMISSAL – ADDITIONAL_VACATION_OVERDUE_DISMISSAL – DAYTIME_PROFESSIONAL_QUALIFICATION_LEAVE_HOURS – NIGHTTIME_PROFESSIONAL_QUALIFICATION_LEAVE_HOURS – PROFESSIONAL_QUALIFICATION_FINE – BALANCE_OF_SALARY – DSR_BALANCE_OF_SALARY – DAYTIME_PRIOR_NOTICE_HOURS_WORKED – NIGHTTIME_PRIOR_NOTICE_HOURS_WORKED – DAYTIME_JUSTIFIED_HOURS – NIGHTTIME_JUSTIFIED_HOURS – BIRTH_AID – CASH_SHORTAGE_ADDITIONAL – DEDUCTION_ADVANCE_THIRTEENTH_SALARY_DISMISSAL_WITHOUT_THIRTEENTH_SALARY – ABSENCES_AS_DEDUCTION – FGTS_THIRTEENTH_SALARY_PROPORTIONAL_MILITARY_SERVICE – FGTS_THIRTEENTH_SALARY_PROPORTIONAL_WORK_ACCIDENT – FGTS_THIRTEENTH_SALARY_PAID_MONTH – FGTS_COMPENSATED – FGTS_THIRTEENTH_SALARY_COMPENSATED – AVERAGE_OVERTIME_VACATION_OVERDUE_DISMISSAL – AVERAGE_VARIABLE_VALUES_VACATION_OVERDUE_DISMISSAL – FGTS_DISMISSAL_FINE – DISMISSAL_NET – THIRD_OF_NEGATIVE_VACATION_DIFFERENCE – THIRD_OF_NEGATIVE_VACATION_PREMIUM_DIFFERENCE – THIRD_OF_VACATION_DIFFERENCE – THIRD_OF_VACATION_PREMIUM_DIFFERENCE – FINE_FOR_LATE_PAYMENT_TERMINATION – COMPENSATION_AS_DISMISSAL_INCENTIVE – DAYTIME_VACATION_HOURS_PAYROLL – NIGHTTIME_VACATION_HOURS_PAYROLL – AVERAGE_OVERTIME_VACATION_PAYROLL – AVERAGE_VARIABLE_VALUES_VACATION_PAYROLL – ADDITIONAL_NIGHT_VACATION_PAYROLL – AVERAGE_INSALUBRITY_VACATION_PAYROLL – AVERAGE_HAZARD_VACATION_PAYROLL – THIRD_OF_VACATION_PAYROLL – DOUBLE_VACATION_FINE_PAYROLL – VACATION_PREMIUM_PAYROLL – AVERAGE_OVERTIME_PREMIUM_PAYROLL – AVERAGE_VARIABLE_VALUES_PREMIUM_PAYROLL – ADDITIONAL_PREMIUM_PAYROLL – THIRD_OF_VACATION_PREMIUM_PAYROLL – DOUBLE_VACATION_PREMIUM_FINE_PAYROLL – INSS_VACATION_PAY_PAYROLL – JUDICIAL_ALIMONY_VACATION_PAYROLL – INSS_REFUND – JUDICIAL_ALIMONY_CALCULATION_RRA – JUDICIAL_ALIMONY_CALCULATION_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – IRRF_CALCULATION_RRA – INSS_DEDUCTION_RRA – INSS_VACATION_CALCULATION_RRA – INSS_THIRTEENTH_SALARY_CALCULATION_RRA – INSS_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – INSS_THIRTEENTH_SALARY_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – PIS_VALUE_THIRTEENTH_SALARY_MONTHLY_PAYROLL – PIS_MONTHLY_PAYROLL_VALUE – PIS_DISMISSAL_VALUE – INSALUBRITY_PREGNANT_EMPLOYEE_HEALTHY_ENVIRONMENT – PREVIOUS_DISMISSAL_OVERFLOW – INSS_THIRTEENTH_SALARY_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – INSS_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – FGTS_THIRTEENTH_SALARY_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – FGTS_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL – THIRD_PARTY_INCOME – THIRD_PARTY_DEDUCTIONS – THIRD_PARTY_INSS – THIRD_PARTY_IRRF – THIRD_PARTY_SEST – THIRD_PARTY_SENAT – THIRD_PARTY_ISS – THIRD_PARTY_JUDICIAL_ALIMONY – HEALTH_PLAN_HOLDER_COMPANY_MONTHLY_FEE – HEALTH_PLAN_HOLDER_EMPLOYEE_MONTHLY_FEE – HEALTH_PLAN_DEPENDENT_COMPANY_MONTHLY_FEE – HEALTH_PLAN_DEPENDENT_EMPLOYEE_MONTHLY_FEE – HEALTH_PLAN_COPAYMENT_DEDUCTION – WORKER_CREDIT_LOAN – WORKER_CREDIT_LOAN_DIFFERENCE – WORKER_CREDIT_PROVISION_SALARY_ADVANCE – WORKER_CREDIT_PROVISION_VACATION – WORKER_CREDIT_PROVISION_VACATION_PAYROLL description: Característica: * `NORMAL_DAYTIME_HOURS` – Horas Normais Diurnas * `DSR_DAYTIME_HOURS` – Horas DSR Diurnas * `OVERTIME_DAYTIME` – Horas Extras Diurnas * `DSR_OVERTIME` – DSR Horas Extras * `IRRF` – IRRF * `FGTS` – FGTS * `INSS` – INSS * `FAMILY_SALARY` – Salário família * `ADDITIONAL_NIGHT` – Adicional Noturno * `NORMAL_NIGHT_HOURS` – Horas Normais Noturnas * `DSR_NIGHT_HOURS` – Horas Repouso Remunerado Noturnas * `DAYTIME_MEDICAL_LEAVE` – Licença auxílio doença diurna * `NIGHTTIME_MEDICAL_LEAVE` – Licença auxílio doença noturna * `DAYTIME_WORK_ACCIDENT_LEAVE` – Licença acidente de trabalho diurna * `NIGHTTIME_WORK_ACCIDENT_LEAVE` – Licença acidente de trabalho noturna * `DAYTIME_ABSENCE` – Horas faltas diurnas * `DAYTIME_LOST_DSR` – Horas faltas repouso remunerado diurnas * `NIGHTTIME_ABSENCE` – Horas faltas noturnas * `NIGHTTIME_LOST_DSR` – Horas faltas repouso remunerado noturnas * `DAYTIME_MATERNITY_LEAVE` – Horas licença maternidade diurnas * `NIGHTTIME_MATERNITY_LEAVE` – Horas licença maternidade noturnas * `DAYTIME_MATERNITY_LEAVE_NONCRIMINAL_ABORTION` – Licença maternidade – Aborto não criminoso Diurno * `NIGHTTIME_MATERNITY_LEAVE_NONCRIMINAL_ABORTION` – Licença maternidade – Aborto não criminoso Noturno * `DAYTIME_MATERNITY_LEAVE_ANTICIPATION_EXTENSION` – Licença maternidade – Prorrogação mediante atestado médico Diurno * `NIGHTTIME_MATERNITY_LEAVE_ANTICIPATION_EXTENSION` – Licença maternidade – Prorrogação mediante atestado médico Noturno * `DAYTIME_ILLNESS_AID` – Horas auxílio doença diurnas * `NIGHTTIME_ILLNESS_AID` – Horas auxílio doença noturnas * `DAYTIME_LABOR_ACCIDENT` – Horas acidente de trabalho diurnas * `NIGHTTIME_LABOR_ACCIDENT` – Horas acidente de trabalho noturnas * `DAYTIME_MILITARY_SERVICE` – Horas serviço militar diurnas * `NIGHTTIME_MILITARY_SERVICE` – Horas serviço militar noturnas * `DAYTIME_PAID_LEAVE` – Horas licença com remuneração diurnas * `NIGHTTIME_PAID_LEAVE` – Horas licença com remuneração noturnas * `DAYTIME_LEAVE_WITHOUT_COMPENSATION` – Horas licença sem remuneração diurnas * `NIGHTTIME_LEAVE_WITHOUT_COMPENSATION` – Horas licença sem remuneração noturnas * `DAYTIME_PATERNITY_LEAVE` – Horas licença paternidade diurnas * `NIGHTTIME_PATERNITY_LEAVE` – Horas licença paternidade noturnas * `DAYTIME_PATERNITY_LEAVE_CITIZEN_COMPANY` – Licença paternidade – Empresa cidadã diurna * `NIGHTTIME_PATERNITY_LEAVE_CITIZEN_COMPANY` – Licença paternidade – Empresa cidadã noturna * `DAYTIME_CITIZEN_COMPANY_MATERNITY` – Licença maternidade – Empresa cidadã diurna * `NIGHTTIME_CITIZEN_COMPANY_MATERNITY` – Licença maternidade – Empresa cidadã noturna * `DAYTIME_MEDICAL_LEAVE_WITHOUT_INSS` – Horas Atestado sem INSS Diurnas * `NIGHTTIME_MEDICAL_LEAVE_WITHOUT_INSS` – Horas Atestado sem INSS Noturnas * `DAYTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS` – Horas acidente de trabalho sem INSS diurnas * `NIGHTTIME_WORK_ACCIDENT_LEAVE_WITHOUT_INSS` – Horas acidente de trabalho sem INSS noturnas * `DAYTIME_INSS_MATERNITY_LEAVE` – Horas Lic.Maternidade INSS diurnas * `NIGHTTIME_INSS_MATERNITY_LEAVE` – Horas Lic.Maternidade INSS noturnas * `HAZARD` – Periculosidade * `OVERTIME_NIGHTTIME` – Horas extras noturnas * `ADDITIONAL_HOURS_ENTRY` – Adicionais lançados em horas * `INSALUBRITY` – Insalubridade * `ALLOWANCE` – Ajuda de custo * `TRAVEL_EXPENSE_UP_TO_FIFTY_PERCENTAGE_COMPENSATION` – Diárias viagem até 50% remuneração * `TRANSPORTATION_VOUCHER` – Vale transporte * `MEDICAL_EXPENSES` – Despesas médicas * `TIPS` – Gorjetas * `PREMIUMS` – Prêmios * `DAY_CARE_REIMBURSEMENT` – Reembolso creche * `NANNY_REIMBURSEMENT` – Reembolso babá * `TRAVEL_EXPENSE_OVER_FIFTY_PERCENTAGE_COMPENSATION` – Diárias viagem acima 50% remuneração * `OTHER_PROCEEDS` – Proventos diversos * `OTHER_DEDUCTIONS` – Descontos diversos * `TRANSPORTATION_VOUCHER_MEAL_TICKET_REIMBURSEMENT` – Reembolso vale alimentação/transporte * `EXCEEDING_FOOD_VOUCHER_MEAL_TICKET` – Vale alimentação/refeição excedente * `PRECAUTION_HOURS` – Horas de sobreaviso * `CORPORATE_OFFICER_WAGE` – Pró-labore * `JUDICIAL_ALIMONY_MONTH` – Pensão judicial mensal * `COMMISSIONS` – Comissões * `DSR_COMMISSIONS` – Repouso sobre comissões * `COMPLEMENT_SALARY` – Complemento Salarial * `DAYTIME_OVERTIME_COMMISSION` – Hora extra comissão diurna * `NIGHTTIME_OVERTIME_COMMISSION` – Hora extra comissão noturna * `MONTH_OVERFLOW` – Estouro do mês * `PREVIOUS_MONTH_OVERFLOW` – Estouro do mês anterior * `MONTH_REFUND` – Troco do mês * `PREVIOUS_MONTH_REFUND` – Troco do mês anterior * `SYNDICATE_CONTRIBUTIONS` – Contribuições do sindicato * `DAYTIME_RETIREMENT_DUE_TO_DISABILITY` – Horas diurnas – Aposentadoria por invalidez * `NIGHTTIME_RETIREMENT_DUE_TO_DISABILITY` – Horas noturnas – Aposentadoria por invalidez * `DAYTIME_OTHERS` – Outras Horas Diurnas * `NIGHTTIME_OTHERS` – Outras Horas Noturnas * `ADVANCE_THIRTEENTH_SALARY` – Adiantamento 13º salário * `DISCOUNT_ADVANCE_THIRTEENTH_SALARY` – Desconto adiantamento 13º salário * `JUDICIAL_ALIMONY_THIRTEENTH_SALARY` – Pensão judicial sobre 13º salário * `ALIMONY_ADVANCE_THIRTEENTH_SALARY` – Pensão judicial sobre adiantamento do 13º salário * `DISCOUNT_ALIMONY_ADVANCE_THIRTEENTH_SALARY` – Desconto de pensão judicial no adiantamento do 13º salário * `THIRTEENTH_SALARY` – 13º salário integral * `MATERNITY_THIRTEENTH_SALARY` – 13º salário maternidade * `MATERNITY_INSS_THIRTEENTH_SALARY` – 13º salário maternidade INSS * `BASE_WORK_ACCIDENT_THIRTEENTH_SALARY` – Base 13º salário acidente de trabalho * `BASE_MILITARY_SERVICE_THIRTEENTH_SALARY` – Base 13º salário serviço militar * `AVERAGE_OVERTIME_ADVANCE_THIRTEENTH_SALARY` – Média de horas extras adiantamento 13° salário * `AVERAGE_VARIABLE_VALUES_ADVANCE_THIRTEENTH_SALARY` – Média de valores variáveis adiantamento 13° salário * `ADDITIONAL_ADVANCE_THIRTEENTH_SALARY` – Adicionais de adiantamento 13° salário * `AVERAGE_OVERTIME_THIRTEENTH_SALARY` – Média de horas extras 13° salário integral * `AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY` – Média de valores variáveis 13° salário Integral * `ADDITIONAL_THIRTEENTH_SALARY` – Adicionais de 13° salário integral * `FGTS_THIRTEENTH_SALARY` – FGTS sobre 13º salário * `COMPLEMENTARY_THIRTEENTH_SALARY` – 13º salário complementar * `RETURN_COMPLEMENTARY_THIRTEENTH_SALARY` – 13º salário complementar a devolver * `RETURN_MATERNITY_THIRTEENTH_SALARY` – 13º salário maternidade a devolver * `RETURN_MATERNITY_INSS_THIRTEENTH_SALARY` – 13º salário maternidade INSS a devolver * `RETURN_INSS_THIRTEENTH_SALARY` – Devolução INSS 13° salário * `IRRF_ADVANCE_SALARY` – IRRF sobre adiantamento salarial * `SALARY_ADVANCE_DISCOUNT` – Desconto adiantamento salarial * `INSS_THIRTEENTH_SALARY` – INSS sobre 13º salário * `IRRF_THIRTEENTH_SALARY` – IRRF sobre 13º salário * `DAYTIME_VACATION_HOURS` – Horas férias diurnas * `NIGHTTIME_VACATION_HOURS` – Horas férias noturnas * `THIRD_OF_VACATION` – 1/3 sobre férias * `THIRD_OF_VACATION_PREMIUM` – 1/3 sobre abono pecuniário * `DOUBLE_VACATION_FINE` – Multa dobro de férias * `DOUBLE_VACATION_PREMIUM_FINE` – Multa dobro do abono pecuniário * `VACATION_PREMIUM` – Abono pecuniário * `INSS_VACATION_PAY` – INSS sobre recibo de férias * `JUDICIAL_ALIMONY_VACATION` – Pensão judicial sobre férias * `IRRF_VACATION_PAY` – IRRF sobre recibo de férias * `AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY_COMPENSATED` – Média de valores variáveis de 13º salário indenizado * `AVERAGE_VARIABLE_VALUES_VACATION` – Média de valores variáveis de férias * `AVERAGE_VARIABLE_VALUES_PREMIUM` – Média de valores variáveis de abono * `AVERAGE_VARIABLE_VALUES_PRIOR_NOTICE_COMPENSATED` – Média de valores variáveis de aviso prévio indenizado * `AVERAGE_VARIABLE_VALUES_PRIOR_NOTICE_NOT_FULLFILLED` – Média de valores variáveis de aviso prévio reavido * `AVERAGE_VARIABLE_VALUES_COMPENSATED_PREVIOUS_MONTH_BASE_DATE` – Média de valores variáveis indenizados no mês anterior da data-base * `AVERAGE_VARIABLE_VALUES_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY` – Média de valores variáveis indenizados no fim do contrato antecipado pela empresa * `AVERAGE_VARIABLE_VALUES_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Média de valores variáveis indenizados no fim do contrato antecipado pelo colaborador * `AVERAGE_VARIABLE_VALUES_VACATION_COMPENSATED_DISMISSAL` – Média de valores variáveis de férias indenizadas na rescisão * `AVERAGE_VARIABLE_VALUES_MATERNITY_LEAVE` – Média de valores variáveis de salário maternidade * `AVERAGE_VARIABLE_VALUES_INSS_MATERNITY_LEAVE` – Média de valores variáveis de salário maternidade INSS * `AVERAGE_VARIABLE_VALUES_CITIZEN_MATERNITY` – Média de valores variáveis de salário maternidade empresa cidadã * `AVERAGE_OVERTIME_VACATION` – Média de horas extras de férias * `AVERAGE_OVERTIME_PREMIUM` – Média de horas extras de abono * `AVERAGE_OVERTIME_VACATION_COMPENSATED_DISMISSAL` – Média de horas extras de férias indenizadas na rescisão * `AVERAGE_OVERTIME_THIRTEENTH_SALARY_COMPENSATED` – Média de horas extras de 13° salário indenizado * `AVERAGE_OVERTIME_COMPENSATED_PRIOR_NOTICE_COMPENSATED` – Média de horas extras de aviso prévio indenizado * `AVERAGE_OVERTIME_COMPENSATED_PRIOR_NOTICE_NOT_FULLFILLED` – Média de horas extras de aviso prévio reavido * `AVERAGE_OVERTIME_COMPENSATED_PREVIOUS_MONTH_BASE_DATE` – Média de horas extras indenizadas no mês anterior da data-base * `AVERAGE_OVERTIME_STABILITY_DISMISSAL` – Média de horas extras de estabilidade na rescisão * `AVERAGE_OVERTIME_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Média de horas extras indenizadas no fim do contrato antecipado pelo colaborador * `AVERAGE_OVERTIME_THIRTEENTH_SALARY_PROPORTIONAL` – Média de horas extras de 13° salário proporcional * `AVERAGE_VARIABLE_VALUES_THIRTEENTH_SALARY_PROPORTIONAL` – Média de valores variáveis de 13° salário proporcional * `AVERAGE_VARIABLE_VALUES_STABILITY_DISMISSAL` – Média de valores variáveis de estabilidade na rescisão * `ADDITIONAL_MATERNITY_SALARY` – Adicionais de salário maternidade * `ADDITIONAL_INSS_MATERNITY_SALARY` – Adicionais de salário maternidade INSS * `ADDITIONAL_THIRTEENTH_SALARY_PROPORTIONAL` – Adicionais de 13° salário proporcional * `ADDITIONAL_PREMIUM` – Adicionais de abono * `ADDITIONAL_CITIZEN_MATERNITY` – Adicionais de auxílio maternidade – Empresa cidadã * `ADDITIONAL_PRIOR_NOTICE_COMPENSATED` – Adicionais de aviso prévio indenizado * `ADDITIONAL_PRIOR_NOTICE_NOT_FULLFILLED` – Adicionais de aviso prévio reavido * `ADDITIONAL_VACATION_COMPENSATED_DISMISSAL` – Adicionais de férias indenizadas na rescisão * `ADDITIONAL_THIRTEENTH_SALARY_COMPENSATED` – Adicionais de 13° salário indenizado * `ADDITIONAL_COMPENSATED_PREVIOUS_MONTH_BASE_DATE` – Adicionais de indenização no mês anterior da data-base * `ADDITIONAL_STABILITY_DISMISSAL` – Adicionais de estabilidade na rescisão * `ADDITIONAL_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY` – Adicionais de indenização no fim do contrato antecipado pela empresa * `ADDITIONAL_COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Adicionais de indenização no fim do contrato antecipado pelo colaborador * `VACATION_PREMIUM_DIFFERENCE` – Diferença de abono * `VACATION_DIFFERENCE` – Diferença de férias * `VACATION_ADVANCE_DISCOUNT` – Desconto de adiantamento de férias * `NEGATIVE_VACATION_DIFFERENCE` – Diferença negativa de férias * `NEGATIVE_VACATION_PREMIUM_DIFFERENCE` – Diferença negativa do abono * `JUDICIAL_ALIMONY_VACATION_DIFFERENCE` – Diferença de pensão judicial sobre férias * `IRRF_VACATION_DIFFERENCE` – Diferença de IRRF sobre férias * `IRRF_VACATION_DISCOUNT_MONTH_PROPORTIONAL` – IRRF sobre férias com desconto proporcional na folha * `INSS_VACATION_DIFFERENCE` – Diferença de INSS sobre férias * `INSS_VACATION_RETURN` – Devolução de INSS sobre férias * `AVERAGE_OVERTIME_MATERNITY_LEAVE` – Média de horas extras salário maternidade * `AVERAGE_OVERTIME_INSS_MATERNITY_LEAVE` – Média de horas extras salário maternidade INSS * `AVERAGE_OVERTIME_CITIZEN_COMPANY_MATERNITY` – Média de horas extras salário maternidade empresa cidadã * `PRIOR_NOTICE_COMPENSATED` – Aviso prévio indenizado * `PRIOR_NOTICE_NOT_FULLFILLED` – Aviso prévio reavido * `THIRTEENTH_SALARY_PROPORTIONAL` – 13º salário proporcional * `MATERNITY_THIRTEENTH_SALARY_PROPORTIONAL` – 13º salário proporcional maternidade * `THIRTEENTH_SALARY_COMPENSATED` – 13º salário indenizado * `FGTS_DISMISSAL_THIRTEENTH_SALARY_DEPOSITED` – FGTS sobre 13º salário depositado na rescisão * `FGTS_DISMISSAL_DEPOSITED` – FGTS depositado na rescisão * `VACATION_OVERDUE_DISMISSAL` – Férias vencidas na rescisão * `THIRD_OF_VACATION_OVERDUE_DISMISSAL` – 1/3 sobre férias vencidas na rescisão * `DOUBLE_VACATION_OVERDUE_DISMISSAL` – Multa por dobro de férias vencidas na rescisão * `VACATION_PROPORTIONAL_DISMISSAL` – Férias proporcionais na rescisão * `VACATION_COMPENSATED_DISMISSAL` – Férias indenizadas na rescisão * `DISMISSAL_STABILITY` – Estabilidade na rescisão * `ADDITIONAL_NIGHT_VACATION` – Adicional noturno de férias * `AVERAGE_INSALUBRITY_VACATION` – Média de insalubridade de férias * `AVERAGE_HAZARD_VACATION` – Média de periculosidade de férias * `COMPENSATED_PREVIOUS_MONTH_BASE_DATE` – Indenização no mês anterior da data-base * `THIRD_OF_VACATION_COMPENSATED_DISMISSAL` – 1/3 sobre férias indenizadas na rescisão * `DOUBLE_VACATION_COMPENSATED_DISMISSAL` – Multa por dobro de férias indenizadas na rescisão * `COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY` – Indenização no fim do contrato antecipado pela empresa * `COMPENSATED_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Indenização no fim do contrato antecipado pelo colaborador * `AVERAGE_OVERTIME_COMPENSATED_END_CONTRACT_ANTICIPATED_COMPANY` – Média de horas extras indenizadas no fim do contrato antecipado pela empresa * `COMPENSATED_VACATION_END_CONTRACT_ANTICIPATED_COMPANY` – Indenização de férias no fim do contrato antecipado pela empresa * `COMPENSATED_VACATION_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Indenização de férias no fim do contrato antecipado pelo colaborador * `COMPENSATED_THIRTEENTH_SALARY_END_CONTRACT_ANTICIPATED_COMPANY` – Indenização de 13º salário no fim do contrato antecipado pela empresa * `COMPENSATED_THIRTEENTH_SALARY_END_CONTRACT_ANTICIPATED_EMPLOYEE` – Indenização de 13º salário no fim do contrato antecipado pelo colaborador * `THIRD_OF_VACATION_PROPORTIONAL_DISMISSAL` – 1/3 sobre férias proporcionais na rescisão * `AVERAGE_OVERTIME_VACATION_PROPORTIONAL_DISMISSAL` – Média de horas extras de férias proporcionais na rescisão * `AVERAGE_VARIABLE_VALUES_VACATION_PROPORTIONAL_DISMISSAL` – Média de valores variáveis de férias proporcionais na rescisão * `ADDITIONAL_VACATION_PROPORTIONAL_DISMISSAL` – Adicionais de férias proporcionais na rescisão * `ADDITIONAL_VACATION_OVERDUE_DISMISSAL` – Adicionais de férias vencidas na rescisão * `DAYTIME_PROFESSIONAL_QUALIFICATION_LEAVE_HOURS` – Horas diurnas – Afastamento para qualificação profissional * `NIGHTTIME_PROFESSIONAL_QUALIFICATION_LEAVE_HOURS` – Horas noturnas – Afastamento para qualificação profissional * `PROFESSIONAL_QUALIFICATION_FINE` – Multa de qualificação profissional * `BALANCE_OF_SALARY` – Saldo de salário * `DSR_BALANCE_OF_SALARY` – Repouso sobre saldo de salário * `DAYTIME_PRIOR_NOTICE_HOURS_WORKED` – Horas diurnas – Aviso prévio trabalhado * `NIGHTTIME_PRIOR_NOTICE_HOURS_WORKED` – Horas noturnas – Aviso prévio trabalhado * `DAYTIME_JUSTIFIED_HOURS` – Horas diurnas – Justificadas * `NIGHTTIME_JUSTIFIED_HOURS` – Horas noturnas – Justificadas * `BIRTH_AID` – Auxílio natalidade * `CASH_SHORTAGE_ADDITIONAL` – Adicional de quebra de caixa * `DEDUCTION_ADVANCE_THIRTEENTH_SALARY_DISMISSAL_WITHOUT_THIRTEENTH_SALARY` – Desconto de adiantamento de 13° salário e rescisão sem 13° salário pago * `ABSENCES_AS_DEDUCTION` – Faltas como desconto * `FGTS_THIRTEENTH_SALARY_PROPORTIONAL_MILITARY_SERVICE` – FGTS sobre 13º salário proporcional serviço militar * `FGTS_THIRTEENTH_SALARY_PROPORTIONAL_WORK_ACCIDENT` – FGTS sobre 13º salário proporcional acidente de trabalho * `FGTS_THIRTEENTH_SALARY_PAID_MONTH` – FGTS sobre 13º salário pago no mês * `FGTS_COMPENSATED` – FGTS indenizado * `FGTS_THIRTEENTH_SALARY_COMPENSATED` – FGTS sobre 13º indenizado * `AVERAGE_OVERTIME_VACATION_OVERDUE_DISMISSAL` – Média de horas extras de férias vencidas na rescisão * `AVERAGE_VARIABLE_VALUES_VACATION_OVERDUE_DISMISSAL` – Média de valores variáveis de férias vencidas na rescisão * `FGTS_DISMISSAL_FINE` – Multa de FGTS na rescisão * `DISMISSAL_NET` – Líquido da rescisão * `THIRD_OF_NEGATIVE_VACATION_DIFFERENCE` – Diferença negativa de 1/3 sobre férias * `THIRD_OF_NEGATIVE_VACATION_PREMIUM_DIFFERENCE` – Diferença negativa de 1/3 sobre abono * `THIRD_OF_VACATION_DIFFERENCE` – Diferença de 1/3 sobre férias * `THIRD_OF_VACATION_PREMIUM_DIFFERENCE` – Diferença de 1/3 sobre abono * `FINE_FOR_LATE_PAYMENT_TERMINATION` – Multa por pagamento fora do prazo. Art. 477 * `COMPENSATION_AS_DISMISSAL_INCENTIVE` – Indenização a título de incentivo a demissão * `DAYTIME_VACATION_HOURS_PAYROLL` – Horas férias diurnas na folha * `NIGHTTIME_VACATION_HOURS_PAYROLL` – Horas férias noturnas na folha * `AVERAGE_OVERTIME_VACATION_PAYROLL` – Média de horas extras de férias na folha * `AVERAGE_VARIABLE_VALUES_VACATION_PAYROLL` – Média de valores variáveis de férias na folha * `ADDITIONAL_NIGHT_VACATION_PAYROLL` – Adicional noturno de férias na folha * `AVERAGE_INSALUBRITY_VACATION_PAYROLL` – Média de insalubridade de férias na folha * `AVERAGE_HAZARD_VACATION_PAYROLL` – Média de periculosidade de férias na folha * `THIRD_OF_VACATION_PAYROLL` – 1/3 sobre férias na folha * `DOUBLE_VACATION_FINE_PAYROLL` – Multa dobro de férias na folha * `VACATION_PREMIUM_PAYROLL` – Abono pecuniário na folha * `AVERAGE_OVERTIME_PREMIUM_PAYROLL` – Média de horas extras de abono na folha * `AVERAGE_VARIABLE_VALUES_PREMIUM_PAYROLL` – Média de valores variáveis de abono na folha * `ADDITIONAL_PREMIUM_PAYROLL` – Adicionais de abono na folha * `THIRD_OF_VACATION_PREMIUM_PAYROLL` – 1/3 sobre abono pecuniário na folha * `DOUBLE_VACATION_PREMIUM_FINE_PAYROLL` – Multa dobro do abono pecuniário na folha * `INSS_VACATION_PAY_PAYROLL` – INSS sobre férias na folha * `JUDICIAL_ALIMONY_VACATION_PAYROLL` – Pensão judicial sobre férias na folha * `INSS_REFUND` – Devolução de INSS * `JUDICIAL_ALIMONY_CALCULATION_RRA` – Pensão judicial de cálculo RRA * `JUDICIAL_ALIMONY_CALCULATION_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – Pensão judicial de cálculo RRA dissídio coletivo rescisão * `IRRF_CALCULATION_RRA` – IRRF de cálculo RRA * `INSS_DEDUCTION_RRA` – Desconto INSS de RRA * `INSS_VACATION_CALCULATION_RRA` – INSS férias de cálculo RRA * `INSS_THIRTEENTH_SALARY_CALCULATION_RRA` – INSS 13º salário de cálculo RRA * `INSS_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – INSS RRA dissídio coletivo rescisão * `INSS_THIRTEENTH_SALARY_RRA_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – INSS 13º salário RRA dissídio coletivo rescisão * `PIS_VALUE_THIRTEENTH_SALARY_MONTHLY_PAYROLL` – Valor do PIS de 13º salário na folha mensal * `PIS_MONTHLY_PAYROLL_VALUE` – Valor do PIS na folha mensal * `PIS_DISMISSAL_VALUE` – Valor do PIS na rescisão * `INSALUBRITY_PREGNANT_EMPLOYEE_HEALTHY_ENVIRONMENT` – Insalubridade gestante em local salubre * `PREVIOUS_DISMISSAL_OVERFLOW` – Estouro da rescisão anterior * `INSS_THIRTEENTH_SALARY_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – INSS sobre 13º salário no dissídio coletivo na rescisão * `INSS_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – INSS no dissídio coletivo na rescisão * `FGTS_THIRTEENTH_SALARY_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – FGTS sobre 13º salário no dissídio coletivo na rescisão * `FGTS_SUPPLEMENTARY_LABOR_AGREEMENT_DISMISSAL` – FGTS no dissídio coletivo na rescisão * `THIRD_PARTY_INCOME` – Proventos de terceiros * `THIRD_PARTY_DEDUCTIONS` – Descontos de terceiros * `THIRD_PARTY_INSS` – INSS de terceiros * `THIRD_PARTY_IRRF` – IRRF de terceiros * `THIRD_PARTY_SEST` – SEST de terceiros * `THIRD_PARTY_SENAT` – SENAT de terceiros * `THIRD_PARTY_ISS` – ISS de terceiros * `THIRD_PARTY_JUDICIAL_ALIMONY` – Pensão judicial de terceiros * `HEALTH_PLAN_HOLDER_COMPANY_MONTHLY_FEE` – Mensalidade de plano de saúde titular parte empresa * `HEALTH_PLAN_HOLDER_EMPLOYEE_MONTHLY_FEE` – Mensalidade de plano de saúde titular parte colaborador * `HEALTH_PLAN_DEPENDENT_COMPANY_MONTHLY_FEE` – Mensalidade de plano de saúde dependente parte empresa * `HEALTH_PLAN_DEPENDENT_EMPLOYEE_MONTHLY_FEE` – Mensalidade de plano de saúde dependente parte colaborador * `HEALTH_PLAN_COPAYMENT_DEDUCTION` – Desconto de coparticipação de plano de saúde * `WORKER_CREDIT_LOAN` – Empréstimo do crédito do trabalhador * `WORKER_CREDIT_LOAN_DIFFERENCE` – Diferença de empréstimo do crédito do trabalhador * `WORKER_CREDIT_PROVISION_SALARY_ADVANCE` – Provisão de crédito do trabalhador sobre adiantamento salarial * `WORKER_CREDIT_PROVISION_VACATION` – Provisão de desconto do crédito do trabalhador sobre férias * `WORKER_CREDIT_PROVISION_VACATION_PAYROLL` – Provisão de crédito do trabalhador sobre férias na folha ruleType: type: string enum: – HOURS – OVERTIME – DSR_OVERTIME – IRRF – FGTS – INSS – FAMILY_SALARY – ADDITIONAL_NIGHT – HAZARD – CALCULATION_BASIS_INFORMED_VALUE_CALCULATION_VALUE – INSALUBRITY – CALCULATION_VALUE_CALCULATION_BASIS – INFORMED_VALUE_CALCULATION_VALUE – JUDICIAL_ALIMONY_MONTH – COMMISSIONS – DSR_COMMISSIONS – MONTH_OVERFLOW – MONTH_REFUND – SYNDICATE_CONTRIBUTIONS – DISCOUNT_ADVANCE_THIRTEENTH_SALARY – MATERNITY_THIRTEENTH_SALARY – AVERAGE_OVERTIME – AVERAGE_VARIABLE_VALUES – ANNUITIES – COMPLEMENTARY_THIRTEENTH_SALARY – SALARY_ADVANCE – MILITARY_SERVICE_WORK_ACCIDENT_THIRTEENTH_SALARY – DISCOUNT_ALIMONY_ADVANCE_THIRTEENTH_SALARY – THIRD_OF_VACATION_AND_VACATION_PREMIUM – DOUBLE_VACATION_AND_VACATION_PREMIUM_FINE – VACATION_DAYS_AND_DISMISSAL – DISMISSAL_NET – VACATION_DIFFERENCE – THIRD_PARTY_REPORTED_VALUE – THIRD_PARTY_TAXES – HEALTH_PLAN – WORKER_CREDIT_LOAN – WORKER_CREDIT_LOAN_DIFFERENCE description: Regra: * `HOURS` – Horas * `OVERTIME` – Horas extras * `DSR_OVERTIME` – DSR Horas Extras * `IRRF` – Imposto de renda * `FGTS` – FGTS * `INSS` – INSS * `FAMILY_SALARY` – Salário família * `ADDITIONAL_NIGHT` – Adicional Noturno * `HAZARD` – Periculosidade * `CALCULATION_BASIS_INFORMED_VALUE_CALCULATION_VALUE` – Base de cálculo x Valor informado x Valor de cálculo * `INSALUBRITY` – Insalubridade * `CALCULATION_VALUE_CALCULATION_BASIS` – Valor de cálculo x Base de cálculo * `INFORMED_VALUE_CALCULATION_VALUE` – Valor informado x Valor de cálculo * `JUDICIAL_ALIMONY_MONTH` – Pensão judicial mensal * `COMMISSIONS` – Comissões * `DSR_COMMISSIONS` – Repouso sobre comissões * `MONTH_OVERFLOW` – Estouro do mês * `MONTH_REFUND` – Troco do mês * `SYNDICATE_CONTRIBUTIONS` – Contribuições do sindicato * `DISCOUNT_ADVANCE_THIRTEENTH_SALARY` – Desconto adiantamento 13º salário * `MATERNITY_THIRTEENTH_SALARY` – 13º salário maternidade * `AVERAGE_OVERTIME` – Média horas extras * `AVERAGE_VARIABLE_VALUES` – Média valores variáveis * `ANNUITIES` – Anuidades * `COMPLEMENTARY_THIRTEENTH_SALARY` – 13º salário complementar * `SALARY_ADVANCE` – Adiantamento salarial * `MILITARY_SERVICE_WORK_ACCIDENT_THIRTEENTH_SALARY` – Avos de 13º salário acidente de trabalho/serviço militar * `DISCOUNT_ALIMONY_ADVANCE_THIRTEENTH_SALARY` – Desconto de pensão judicial no adiantamento do 13º salário * `THIRD_OF_VACATION_AND_VACATION_PREMIUM` – 1/3 sobre férias e abono pecuniário * `DOUBLE_VACATION_AND_VACATION_PREMIUM_FINE` – Multa por dobro de férias * `VACATION_DAYS_AND_DISMISSAL` – Dias nas férias e rescisões * `DISMISSAL_NET` – Líquido da rescisão * `VACATION_DIFFERENCE` – Diferença de férias * `THIRD_PARTY_REPORTED_VALUE` – Valor informado de terceiros * `THIRD_PARTY_TAXES` – Impostos de terceiros * `HEALTH_PLAN` – Plano de saúde * `WORKER_CREDIT_LOAN` – Empréstimo de crédito do trabalhador * `WORKER_CREDIT_LOAN_DIFFERENCE` – Diferença de empréstimo do crédito do trabalhador compensatoryOperationType: type: string enum: – CREATE – DELETE – UPDATE description: Tipo de operação de compensação: * `CREATE` – Criação * `DELETE` – Exclusão * `UPDATE` – Atualização userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error 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 companyData: description: Dados da empresa type: object required: – id – code – description properties: id: type: string maxLength: 36 description: Id code: type: integer format: int64 description: Código description: type: string description: Nome calculationDefinitionData: description: Dados do código de cálculo type: object required: – id – code – competence – calculationType – paymentDate properties: id: type: string maxLength: 36 description: Id code: type: integer format: int64 description: Código competence: type: string format: date description: Competência calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo paymentDate: type: string format: date description: Data de pagamento startDatePayroll: type: string format: date description: Período da folha inicial endDatePayroll: type: string format: date description: Período da folha final advanceThirteenthSalaryPercentage: type: number format: double description: % adiantamento 13º entryMaintenanceDTO: description: Lançamento type: object required: – id – calculationDefinition – event – employee – reference – value – originType properties: id: type: string description: Identificação calculationDefinition: type: object allOf: – #/definitions/calculationDefinitionDTO description: Definição de código de cálculo event: type: object allOf: – #/definitions/wageTypeDTO description: Evento employee: type: object allOf: – #/definitions/basicDataDTO description: Colaborador reference: type: number format: double description: Referênce minimum: 0.0 value: type: string description: Valor minimum: 0.0 maximum: 99999.99 originType: type: string allOf: – #/definitions/originType description: Origem variableEntryWithIdentificationTypeDTO: description: Lançamento variável com incidente type: object required: – id – calculationDefinition – event – employee – reference – value – originType – identificationType properties: id: type: string description: Identificação calculationDefinition: type: object allOf: – #/definitions/calculationDefinitionDTO description: Definição de código de cálculo event: type: object allOf: – #/definitions/basicDataDTO description: Evento employee: type: object allOf: – #/definitions/basicDataDTO description: Colaborador reference: type: number format: double description: Referênce minimum: 0.0 value: type: string description: Valor minimum: 0.0 maximum: 99999.99 originType: type: string allOf: – #/definitions/originType description: Origem identificationType: type: string allOf: – #/definitions/identificationType description: Incidente basicDataDTO: description: Dados básicos type: object required: – id – code – name properties: id: type: string description: Id code: type: integer format: int64 description: Código name: type: string description: Nome calculationDefinitionDTO: description: Definição de cálculo type: object required: – id – competence – code – calculationType properties: id: type: string description: Id competence: type: string format: date description: Competence code: type: integer format: int64 description: Código do cálculo calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo pageDTO: description: Paginação type: object required: – offset – size properties: offset: type: integer format: int64 description: Offset minimum: 0 size: type: integer format: int64 description: Size minimum: 1 maximum: 100 entryMaintenanceFilter: description: Filtro de manutenção de lançamentos type: object properties: companyId: type: string description: Empresa startCompetence: type: string format: date description: Competência de início endCompetence: type: string format: date description: Competência final entryId: type: string description: Evento employeeId: type: string description: Colaborador calculationDefinitionId: type: string description: Definição de código de cálculo advancedFilterId: type: string description: Identificado do filtro avançado variableEntrySaveDto: description: Informações dos eventos variáveis lançados na tela de demonstrativo de pagamento type: object required: – wageType – reference – value properties: id: type: string description: Identificador único wageType: type: string description: Evento reference: type: number format: double description: Referência minimum: 0.0 maximum: 99999.98 value: type: string description: Valor minimum: 0.0 maximum: 999999999.99 variableEntryFilter: description: Filtro de lançamento variável type: object properties: companyId: type: string description: Empresa startCompetence: type: string format: date description: Competência de início endCompetence: type: string format: date description: Competência final entryId: type: string description: Evento employeeId: type: string description: Colaborador calculationDefinitionId: type: string description: Definição de código de cálculo fixedEntryListDto: description: Dados da listagem dos lançamentos fixos na tela de manutenção type: object required: – id – wageTypeCode – wageTypeShortName – employeeCode – personName – startDate – endDate – wageTypePayrollIdentificationType – reference – value – originType properties: id: type: string description: Identificador único wageTypeCode: type: integer format: int64 description: Código do evento wageTypeShortName: type: string description: Nome do evento employeeCode: type: integer format: int64 description: Código do colaborador personName: type: string description: Nome da pessoa startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final wageTypePayrollIdentificationType: type: string allOf: – #/definitions/identificationType description: Incidente reference: type: number format: double description: Referência value: type: string description: Value originType: type: string allOf: – #/definitions/originType description: Origem fixedEntryFilter: description: Filtros para a listagem dos lançamentos fixos na tela de manutenção type: object properties: company: type: string description: Empresa employee: type: string description: Colaborador startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final wageType: type: string description: Evento order: description: Ordenação da listagem dos lançamentos fixos na tela de manutenção type: object required: – field – direction properties: field: type: string description: Campo direction: type: string allOf: – #/definitions/orderType description: Direção da ordenação wageTypeDTO: description: Dados do evento type: object required: – id – code – name properties: id: type: string description: Id code: type: integer format: int64 description: Código name: type: string description: Nome referenceType: type: string allOf: – #/definitions/referenceType description: Tipo de referência legacyEntityOperation: description: Dados de operação realizada em entidade que possui integração de volta para a base do HCM type: object required: – operationId – entityName – operationType – externalId properties: operationId: type: string description: Identificador único da operação entityName: type: string description: Nome da entidade alterada operationType: type: string allOf: – #/definitions/operationType description: Tipo de operação externalId: type: string description: Identificador externo da entidade alterada clockingEventEventsBatchInfo: description: Informações sobre o bloco e o processo type: object required: – processId – batchId – errorProcessed – doubleEvents – competence properties: processId: type: string description: Identificador do processo batchId: type: string description: Identificador do bloco errorProcessed: type: integer format: int64 description: Quantidade de colaboradores processados com erro doubleEvents: type: string allOf: – #/definitions/doubleType description: Eventos duplos competence: type: string format: date description: Competência dismissalDate: type: string format: date description: Data de demissão resetEvaluationAfterDismissal: type: boolean description: Resetar apuração após a demissão do colaborador employeeEventDTO: description: DTO com o colaborador e seus eventos type: object required: – employeeId – calculationDefinitionId properties: employeeId: type: string description: Identificador do colaborador dismissalDate: type: string format: date description: Data de demissão calculationDefinitionId: type: string description: Identificador da definição de cálculo events: type: array items: type: object allOf: – #/definitions/eventDTO description: Eventos eventDTO: description: DTO do evento type: object required: – quantity – value – eventId properties: quantity: type: integer format: int64 description: Referência do evento value: type: integer format: int64 description: Valor do evento eventId: type: string description: Identificador do evento employeeFailedDTO: description: Informações de falha no processamento do colaborador type: object required: – employeeId – calculationDefinitionId properties: employeeId: type: string description: Identificador do colaborador calculationDefinitionId: type: string description: Identificador da definição de cálculo errorMessage: type: string description: Mensagem de erro fileDTO: description: DTO com informações comuns de um arquivo a ser utilizado no blob-service type: object 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 wageTypeExportLayoutFilter: description: Filtro do layout de exportação de eventos type: object properties: code: type: integer format: int64 description: Código do layout name: type: string description: Nome do layout format: type: string allOf: – #/definitions/wageTypeExportLayoutFormat description: Formato do layout: TXT/CSV fixedEntry: description: Lançamentos Fixos type: object required: – employee – startDate – wageType – reference – value – originType 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 wageType: type: object allOf: – #/definitions/wageType description: Evento reference: type: number format: double description: Referência minimum: 0.0 maximum: 999999999.99 value: type: string description: Valor minimum: 0.0 maximum: 999999999.99 originType: type: string allOf: – #/definitions/originType description: Origem createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editFixedEntry: type: object required: – id allOf: – #/definitions/fixedEntry variableEntry: description: Lançamentos Variáveis type: object required: – employee – calculationDefinition – wageType – reference – value – originType properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador calculationDefinition: type: object allOf: – #/definitions/calculationDefinition description: Código de cálculo wageType: type: object allOf: – #/definitions/wageType description: Evento reference: type: number format: double description: Referência minimum: 0.0 maximum: 999999999.99 value: type: string description: Valor minimum: 0.0 maximum: 999999999.99 originType: type: string allOf: – #/definitions/originType description: Origem externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editVariableEntry: type: object required: – id allOf: – #/definitions/variableEntry compensatoryOperation: description: Operações compensatórias de transações distribuídas type: object required: – transactionId – compensatoryOperation – entityName – entityId – compensationData properties: id: type: string format: uuid description: Identificador único transactionId: type: string maxLength: 255 description: Identificador da transação (Saga) groupId: type: string maxLength: 255 description: Agrupador para compensações parcial, como employeeId por exemplo compensatoryOperation: type: string allOf: – #/definitions/compensatoryOperationType description: Tipo da operação de compensação entityName: type: string maxLength: 255 description: Nome da entidade a ser compensada entityId: type: string format: uuid description: Id do registro a ser compensado compensationData: type: string maxLength: 4000 description: Dados da compensação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: postponedIntegrationOperation: description: Operações de integração postergadas de transações distribuídas type: object required: – transactionId – operationType – entityName – integrationData properties: id: type: string format: uuid description: Identificador único transactionId: type: string maxLength: 255 description: Identificador da transação (Saga) groupId: type: string maxLength: 255 description: Agrupador para compensações parcial, como employeeId por exemplo operationType: type: string allOf: – #/definitions/operationType description: Tipo da operação de persistência entityName: type: string maxLength: 255 description: Nome da entidade associada integrationData: type: string description: Dados da integraçã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 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 externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 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: 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 person: type: object allOf: – #/definitions/e001pes description: Pessoa hireDate: type: string format: date description: Data de admissão code: type: integer format: int64 description: Cadastro employeeSnapshot: type: object allOf: – #/definitions/employeeSnapshot description: Históricos correntes do colaborador 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 companyTransferDate: type: string format: date description: Data da transferência de empresa externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 – referenceType 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 referenceType: type: string allOf: – #/definitions/referenceType description: Tipo de referência externalCode: type: string maxLength: 25 description: Código externo do evento extIntSts: type: string maxLength: 100 description: Indica o status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: 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. calculationDefinition: description: Código de cálculo type: object required: – code – calculationType – competence – paymentDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa code: type: integer format: int64 description: Código do cálculo calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo calculationDefinitionOrigin: type: object allOf: – #/definitions/calculationDefinition description: Definição de cálculo de origem competence: type: string format: date description: Competência paymentDate: type: string format: date description: Data pagamento startDatePayroll: type: string format: date description: Período da folha inicial endDatePayroll: type: string format: date description: Período da folha final 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 externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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: 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 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: 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: wageTypePayroll: description: Evento – Definições Gerais da Folha type: object required: – identificationType properties: id: type: string format: uuid description: Identificador único wageType: type: object allOf: – #/definitions/wageType description: Código do Evento identificationType: type: string allOf: – #/definitions/identificationType description: Tipo Evento characteristic: type: object allOf: – #/definitions/characteristics description: Característica rule: type: object allOf: – #/definitions/rules description: Regra 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: characteristics: description: Características dos eventos da folha type: object required: – description – characteristicType properties: id: type: string format: uuid description: Identificador único description: type: string description: Descrição x-i18n: true characteristicType: type: string allOf: – #/definitions/characteristicType description: Característica 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: description: type: string example: pt-BR: description: Exemplo de texto usando locale pt-BR. en-US: description: Text example using en-US locale. rules: description: Regras dos eventos da folha type: object required: – description – ruleType properties: id: type: string format: uuid description: Identificador único description: type: string description: Descrição x-i18n: true ruleType: type: string allOf: – #/definitions/ruleType description: Regra 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: description: type: string example: pt-BR: description: Exemplo de texto usando locale pt-BR. en-US: description: Text example using en-US locale. 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: wageTypeExportLayout: description: Layout de exportação de eventos para folha type: object required: – code – name – format properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 9999 name: type: string maxLength: 255 description: Nome format: type: string allOf: – #/definitions/wageTypeExportLayoutFormat description: Formato hasHeader: type: boolean description: Listar cabeçalho createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: wageTypeExportLayoutField: description: Campo do layout de exportação de eventos para folha type: object required: – sequenceField – type properties: id: type: string format: uuid description: Identificador único sequenceField: type: integer format: int64 description: Sequencia do campo minimum: 1 maximum: 20 wageTypeExportLayout: type: object allOf: – #/definitions/wageTypeExportLayout description: Layout de exportação de eventos para folha type: type: string allOf: – #/definitions/wageTypeExportLayoutFieldType description: Tipo size: type: integer format: int64 description: Tamanho minimum: 1 maximum: 255 fixedValue: type: string maxLength: 255 description: Valor fixo variable: type: string allOf: – #/definitions/wageTypeExportLayoutFieldVariable description: Variável 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