2.0info: 2.0.0 analytics_payroll description: Serviço do produto Análise da Folha de Pagamento. x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: analytics_payroll contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /analytics_payroll/queries/autocompleteCompanyBranchQuery: post: description: Busca as informações de filiais clientes para configuração tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/generalFilterEntryInfo responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/companyResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações de filiais clientes para configuração tags: – Queries x-senior-visibility: PRIVATE parameters: – name: company description: Identificador único da empresa in: query type: string – name: page description: Página a ser buscada in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: q description: Termo para filtrar in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/companyResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteCompanyQuery: post: description: Busca as informações de empresas clientes para configuração tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/generalFilterEntryInfo responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/companyResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações de empresas clientes para configuração tags: – Queries x-senior-visibility: PRIVATE parameters: – name: company description: Identificador único da empresa in: query type: string – name: page description: Página a ser buscada in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: q description: Termo para filtrar in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/companyResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteCostCentersQuery: post: description: Busca as informações de centro de custo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/generalFilterEntryInfo responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/generalFilterResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações de centro de custo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: company description: Identificador único da empresa in: query type: string – name: page description: Página a ser buscada in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: q description: Termo para filtrar in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/generalFilterResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteJobpositionsQuery: post: description: Busca as informações de cargos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/generalFilterEntryInfo responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/jobPositionResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações de cargos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: company description: Identificador único da empresa in: query type: string – name: page description: Página a ser buscada in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: q description: Termo para filtrar in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/jobPositionResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteDepartmentsQuery: post: description: Busca as informações de locais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/generalFilterEntryInfo responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/generalFilterResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações de locais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: company description: Identificador único da empresa in: query type: string – name: page description: Página a ser buscada in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: q description: Termo para filtrar in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/generalFilterResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteShiftsQuery: post: description: Retorna a lista de turnos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/generalFilterShifts minimum: 1 description: Resultado da busca dos turnos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de turnos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/generalFilterShifts minimum: 1 description: Resultado da busca dos turnos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteEmployeesQuery: post: description: Busca as informações de colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: company: type: string description: Empresa branch: type: array items: type: string description: Empresa Filial shifts: type: array items: type: string description: Turno do colaborador costcenter: type: array items: type: string description: Centro de custo do colaborador department: type: array items: type: string description: Departamento do colaborador gender: type: string description: Gênero do Colaborador leaders: type: array items: type: string description: Lideres descendants: type: string description: Indica se a busca vai ser somente para liderados diretos ou todos. jobposition: type: array items: type: string description: Cargo do colaborador contracttypes: type: array items: type: string description: Tipo de contrato startReferenceDate: type: string format: date description: Data de início da busca endReferenceDate: type: string format: date description: Data de fim da busca page: type: integer format: int64 description: Pagina a ser buscada minimum: 0 default: 0 size: type: integer format: int64 description: Tamanho da página minimum: 1 maximum: 100 default: 100 q: type: string description: Filtro por nome do colaborador. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/generalFilterResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteContractTypesQuery: post: description: Retorna a lista de tipos de contrato tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/contractTypesDTO minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de tipos de contrato tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/contractTypesDTO minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteLeadersQuery: post: description: Retorna a lista de liderados que são gestores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: company: type: string description: Identificador único da empresa branch: type: array items: type: string description: Identificador único da filial q: type: string description: Termo para filtrar responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/leadersResultInfo minimum: 1 description: Resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/migrate: post: description: Realiza a migração da base de dados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – errorMessage properties: status: type: boolean description: Status da migração errorMessage: type: string description: Mensagem de erro da migração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza a migração da base de dados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – errorMessage properties: status: type: boolean description: Status da migração errorMessage: type: string description: Mensagem de erro da migração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/employeeAbsenteeismListQuery: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domain – service – onlyEmployeesWithAbsenceHours – page properties: domain: type: string description: Domínio do serviço service: type: string description: Nome do serviço ticket: type: string description: Ticket de filtro employeeSearch: type: string description: Nome do colaborador onlyEmployeesWithAbsenceHours: type: boolean description: Considerar apenas colaboradores com horas de ausência em algum mês do ano de referência page: type: object allOf: – #/definitions/pagination description: Paginação responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/pagedEmployeeAbsenteeismListQuery description: Retorno da Consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/iassistEmployeeAbsenteeismListQuery: post: description: Consulta uma lista de ausências filtrando pelos liderados diretos nos últimos 6 meses. utilizado apenas para interação com o IAssist. Não reutilizar. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – perEmployeeAbsenteeismData properties: perEmployeeAbsenteeismData: type: array items: type: object allOf: – #/definitions/iassistEmployeeAbsenteeismIndexData minimum: 1 description: Resultado com a lista de de informações de absenteísmos dos liderados diretos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta uma lista de ausências filtrando pelos liderados diretos nos últimos 6 meses. utilizado apenas para interação com o IAssist. Não reutilizar. tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – perEmployeeAbsenteeismData properties: perEmployeeAbsenteeismData: type: array items: type: object allOf: – #/definitions/iassistEmployeeAbsenteeismIndexData minimum: 1 description: Resultado com a lista de de informações de absenteísmos dos liderados diretos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/absenteeismTotalizerQuery: post: description: Consulta uma lista de ausências não planejads com paginação e filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: Domínio do serviço service: type: string description: Nome do serviço ticket: type: string description: Ticket de filtro responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/absenteeismTotalizerData description: Retorno da Consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta uma lista de ausências não planejads com paginação e filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domain description: Domínio do serviço in: query required: true type: string – name: service description: Nome do serviço in: query required: true type: string – name: ticket description: Ticket de filtro in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/absenteeismTotalizerData description: Retorno da Consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/iassistAbsenteeismTotalizerQuery: post: description: Consulta uma lista de ausências não planejads com paginação e filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/absenteeismTotalizerDataIAssist description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta uma lista de ausências não planejads com paginação e filtros tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/absenteeismTotalizerDataIAssist description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/totalAbsenceHoursListQuery: post: description: Consulta uma lista de ausências por mês, planejadas ou não planejadas, com paginação e filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domain – service – isPlannedAbsence – page properties: domain: type: string description: Domínio do serviço service: type: string description: Nome do serviço ticket: type: string description: Ticket de filtro isPlannedAbsence: type: boolean description: Ausência planejada page: type: object allOf: – #/definitions/pagination description: Paginação responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/pagedTotalAbsenceHoursListQuery description: Retorno da Consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/iassistTotalAbsenceHoursListQuery: post: description: Consulta uma lista de ausências por mês, planejadas ou não planejadas, com paginação e filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/iassistTotalAbsenceHoursData minimum: 1 description: Retorno da Consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta uma lista de ausências por mês, planejadas ou não planejadas, com paginação e filtros tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/iassistTotalAbsenceHoursData minimum: 1 description: Retorno da Consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteFilterCompany: post: description: Primitiva para obtenção de informações referente empresas a serem consumidas pelos Filtros de Abrangências tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para obtenção de informações referente empresas a serem consumidas pelos Filtros de Abrangências tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteFilterCompanyBranch: post: description: Primitiva para obtenção de informações referente filiais a serem consumidas pelos Filtros de Abrangências tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro parameters: type: array items: type: object allOf: – #/definitions/keyValue description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteFilterDepartment: post: description: Primitiva para obtenção de informações referente departamentos a serem consumidos pelos Filtros de Abrangências tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para obtenção de informações referente departamentos a serem consumidos pelos Filtros de Abrangências tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteFilterJobPosition: post: description: Primitiva para obtenção de informações consumidas pelo campo de lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para obtenção de informações consumidas pelo campo de lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/autocompleteFilterCostCenter: post: description: Primitiva para obtenção de informações consumidas pelo campo de lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para obtenção de informações consumidas pelo campo de lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/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 /analytics_payroll/queries/exportCompany: 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 /analytics_payroll/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 /analytics_payroll/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 /analytics_payroll/queries/exportAbsenceType: 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 /analytics_payroll/queries/exportEmployeeWorkedHoursByCompetence: 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 /analytics_payroll/queries/exportEmployeeAbsenceHoursByCompetenceAndType: 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 /analytics_payroll/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 /analytics_payroll/queries/exportPerson: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/exportJobposition: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/exportDepartment: 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 /analytics_payroll/queries/exportAttachment: 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 /analytics_payroll/queries/exportCostcenter: 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 /analytics_payroll/queries/exportWorkshift: 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 /analytics_payroll/queries/exportMeta: 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 /analytics_payroll/queries/exportHierarchyitem: 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 /analytics_payroll/queries/exportHierarchy: 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 /analytics_payroll/queries/exportCompanyhierarchy: 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 /analytics_payroll/queries/exportOrganizationalchart: 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 /analytics_payroll/queries/exportOrganizationalchartitem: 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 /analytics_payroll/queries/exportWorkstationgroupstructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/exportWorkstationgroup: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/queries/exportWorkstation: 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 /analytics_payroll/queries/exportHistoricalWorkstation: 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 /analytics_payroll/queries/exportActingtype: 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 /analytics_payroll/queries/exportCompanyjobpositionstructure: 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 /analytics_payroll/queries/exportJobpositionstructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/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 /analytics_payroll/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 /analytics_payroll/actions/blobServiceRequestAccess: post: description: Solicitação para acessar um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: Colaborador 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 thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser retornado seu Thumbnail(128X128px) default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/blobServiceRequestAccessData description: Retorno do acesso do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/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 /analytics_payroll/actions/importCompany: 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 /analytics_payroll/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 /analytics_payroll/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 /analytics_payroll/actions/importAbsenceType: 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 /analytics_payroll/actions/importEmployeeWorkedHoursByCompetence: 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 /analytics_payroll/actions/importEmployeeAbsenceHoursByCompetenceAndType: 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 /analytics_payroll/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 /analytics_payroll/actions/importPerson: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/actions/importJobposition: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/actions/importDepartment: 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 /analytics_payroll/actions/importAttachment: 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 /analytics_payroll/actions/importCostcenter: 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 /analytics_payroll/actions/importWorkshift: 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 /analytics_payroll/actions/importMeta: 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 /analytics_payroll/actions/importHierarchyitem: 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 /analytics_payroll/actions/importHierarchy: 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 /analytics_payroll/actions/importCompanyhierarchy: 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 /analytics_payroll/actions/importOrganizationalchart: 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 /analytics_payroll/actions/importOrganizationalchartitem: 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 /analytics_payroll/actions/importWorkstationgroupstructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/actions/importWorkstationgroup: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/actions/importWorkstation: 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 /analytics_payroll/actions/importHistoricalWorkstation: 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 /analytics_payroll/actions/importActingtype: 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 /analytics_payroll/actions/importCompanyjobpositionstructure: 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 /analytics_payroll/actions/importJobpositionstructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/events/importCompanyEvent: 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 /analytics_payroll/events/exportCompanyEvent: 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 /analytics_payroll/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 /analytics_payroll/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 /analytics_payroll/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 /analytics_payroll/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 /analytics_payroll/events/importAbsenceTypeEvent: 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 /analytics_payroll/events/exportAbsenceTypeEvent: 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 /analytics_payroll/events/importEmployeeWorkedHoursByCompetenceEvent: 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 /analytics_payroll/events/exportEmployeeWorkedHoursByCompetenceEvent: 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 /analytics_payroll/events/importEmployeeAbsenceHoursByCompetenceAndTypeEvent: 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 /analytics_payroll/events/exportEmployeeAbsenceHoursByCompetenceAndTypeEvent: 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 /analytics_payroll/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 /analytics_payroll/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 /analytics_payroll/events/importPersonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics_payroll/events/exportPersonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics_payroll/events/importJobpositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics_payroll/events/exportJobpositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics_payroll/events/importDepartmentEvent: 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 /analytics_payroll/events/exportDepartmentEvent: 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 /analytics_payroll/events/importAttachmentEvent: 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 /analytics_payroll/events/exportAttachmentEvent: 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 /analytics_payroll/events/importCostcenterEvent: 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 /analytics_payroll/events/exportCostcenterEvent: 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 /analytics_payroll/events/importWorkshiftEvent: 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 /analytics_payroll/events/exportWorkshiftEvent: 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 /analytics_payroll/events/importMetaEvent: 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 /analytics_payroll/events/exportMetaEvent: 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 /analytics_payroll/events/importHierarchyitemEvent: 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 /analytics_payroll/events/exportHierarchyitemEvent: 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 /analytics_payroll/events/importHierarchyEvent: 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 /analytics_payroll/events/exportHierarchyEvent: 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 /analytics_payroll/events/importCompanyhierarchyEvent: 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 /analytics_payroll/events/exportCompanyhierarchyEvent: 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 /analytics_payroll/events/importOrganizationalchartEvent: 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 /analytics_payroll/events/exportOrganizationalchartEvent: 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 /analytics_payroll/events/importOrganizationalchartitemEvent: 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 /analytics_payroll/events/exportOrganizationalchartitemEvent: 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 /analytics_payroll/events/importWorkstationgroupstructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics_payroll/events/exportWorkstationgroupstructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics_payroll/events/importWorkstationgroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics_payroll/events/exportWorkstationgroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics_payroll/events/importWorkstationEvent: 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 /analytics_payroll/events/exportWorkstationEvent: 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 /analytics_payroll/events/importHistoricalWorkstationEvent: 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 /analytics_payroll/events/exportHistoricalWorkstationEvent: 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 /analytics_payroll/events/importActingtypeEvent: 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 /analytics_payroll/events/exportActingtypeEvent: 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 /analytics_payroll/events/importCompanyjobpositionstructureEvent: 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 /analytics_payroll/events/exportCompanyjobpositionstructureEvent: 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 /analytics_payroll/events/importJobpositionstructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics_payroll/events/exportJobpositionstructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/company: 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/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/wageTypeTable: 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/wageTypeTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/wagetype: 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/wagetype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/absenceType: 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/absenceType responses: 200: description: The created resource schema: #/definitions/absenceType 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/absenceType responses: 200: description: The created resource schema: #/definitions/absenceType 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/absenceType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/absenceType/{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/editAbsenceType responses: 200: description: Ok schema: #/definitions/editAbsenceType 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/absenceType responses: 200: description: Ok schema: #/definitions/absenceType 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/absenceType 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 /analytics_payroll/entities/absenceType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/absenceType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/employeeWorkedHoursByCompetence: 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/employeeWorkedHoursByCompetence responses: 200: description: The created resource schema: #/definitions/employeeWorkedHoursByCompetence 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/employeeWorkedHoursByCompetence responses: 200: description: The created resource schema: #/definitions/employeeWorkedHoursByCompetence 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/employeeWorkedHoursByCompetence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/employeeWorkedHoursByCompetence/{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/editEmployeeWorkedHoursByCompetence responses: 200: description: Ok schema: #/definitions/editEmployeeWorkedHoursByCompetence 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/employeeWorkedHoursByCompetence responses: 200: description: Ok schema: #/definitions/employeeWorkedHoursByCompetence 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/employeeWorkedHoursByCompetence 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 /analytics_payroll/entities/employeeWorkedHoursByCompetence/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeWorkedHoursByCompetence responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/employeeAbsenceHoursByCompetenceAndType: 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/employeeAbsenceHoursByCompetenceAndType responses: 200: description: The created resource schema: #/definitions/employeeAbsenceHoursByCompetenceAndType 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/employeeAbsenceHoursByCompetenceAndType responses: 200: description: The created resource schema: #/definitions/employeeAbsenceHoursByCompetenceAndType 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/employeeAbsenceHoursByCompetenceAndType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/employeeAbsenceHoursByCompetenceAndType/{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/editEmployeeAbsenceHoursByCompetenceAndType responses: 200: description: Ok schema: #/definitions/editEmployeeAbsenceHoursByCompetenceAndType 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/employeeAbsenceHoursByCompetenceAndType responses: 200: description: Ok schema: #/definitions/employeeAbsenceHoursByCompetenceAndType 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/employeeAbsenceHoursByCompetenceAndType 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 /analytics_payroll/entities/employeeAbsenceHoursByCompetenceAndType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeAbsenceHoursByCompetenceAndType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/employee: 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/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/person: 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/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/jobposition: 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/jobposition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/department: 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/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/attachment: 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/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/costcenter: 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/costcenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/workshift: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/workshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/meta: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/meta responses: 200: description: The created resource schema: #/definitions/meta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/meta responses: 200: description: The created resource schema: #/definitions/meta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/meta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/meta/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editMeta responses: 200: description: Ok schema: #/definitions/editMeta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/meta responses: 200: description: Ok schema: #/definitions/meta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/meta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /analytics_payroll/entities/meta/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/meta responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/hierarchy: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/hierarchy responses: 200: description: The created resource schema: #/definitions/hierarchy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/hierarchy responses: 200: description: The created resource schema: #/definitions/hierarchy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/hierarchy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/hierarchy/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHierarchy responses: 200: description: Ok schema: #/definitions/editHierarchy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hierarchy responses: 200: description: Ok schema: #/definitions/hierarchy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/hierarchy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /analytics_payroll/entities/hierarchy/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/hierarchy responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/workstationgroupstructure: 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/workstationgroupstructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/workstationgroup: 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/workstationgroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/workstation: 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/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/historicalWorkstation: 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/historicalWorkstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics_payroll/entities/actingtype: 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/actingtype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: wageValueType: type: string enum: – VALUE – HOUR description: Tipo de valor do evento: * `VALUE` – Valor * `HOUR` – Hora wageTypeCategory: type: string enum: – PROCEEDS – DEDUCTION – INFORMATIVE – ADVANTAGE – OTHER_PROCEEDS – OTHER_DEDUCTION description: Tipo do evento: * `PROCEEDS` – Provento * `DEDUCTION` – Desconto * `INFORMATIVE` – Outros * `ADVANTAGE` – Vantagem * `OTHER_PROCEEDS` – Outros Env.Provento * `OTHER_DEDUCTION` – Outros Env.Desconto genderType: type: string enum: – Male – Female description: Gênero da pessoa: * `Male` – Masculino * `Female` – Feminino maritalStatus: type: string enum: – Single – Married – Divorced – Widower – Concubinage – Separated – StableUnion – Others description: Estado civil: * `Single` – Solteiro * `Married` – Casado * `Divorced` – Divorciado * `Widower` – Viúvo * `Concubinage` – Concubinato * `Separated` – Separado * `StableUnion` – União estável * `Others` – Outros employeeType: type: string enum: – NULL – EMPLOYEE – THIRD – PARTNER description: Tipo do colaborador: * `NULL` – 0 – Nulo * `EMPLOYEE` – 1 – Colaborador * `THIRD` – 2 – Terceiro * `PARTNER` – 3 – Parceiro employeeContractType: type: string enum: – Employee – Manager – FarmWorker – Retired – Trainee – Apprentice – FixedDueDate – RetiredManager – PublicAgent – Teacher – CooperativeWorker – DomesticWorker – TeacherFixedDueDate – ThirdParty description: Tipos de contrato de trabalho: * `Employee` – Empregado * `Manager` – Diretor * `FarmWorker` – Trabalhador rural * `Retired` – Aposentado * `Trainee` – Estagiário * `Apprentice` – Aprendiz * `FixedDueDate` – Prazo determinado * `RetiredManager` – Diretor aposentado * `PublicAgent` – Agente público * `Teacher` – Professor * `CooperativeWorker` – Cooperado * `DomesticWorker` – Trabalhador domestico * `TeacherFixedDueDate` – Professor, prazo determinado * `ThirdParty` – Terceiro hireType: type: string enum: – EMPTY – FIRSTJOB – REEMPREGO – TRANSFERWITHONUS – TRANSFERWITHOUTONUS – INCORPORATION – REINTEGRATION – RECONSTRUCTION – REVERSAL – PROVISIONAL – REQUEST – REDISTRIBUTION – DECENTRALIZED – REMOVAL – READAPTATION description: Tipo de admissão do colaborador: * `EMPTY` – Vazio * `FIRSTJOB` – Primeiro Emprego * `REEMPREGO` – Reemprego * `TRANSFERWITHONUS` – Transferência com ônus * `TRANSFERWITHOUTONUS` – Transferência sem ônus * `INCORPORATION` – Incorporação/Fusão/Cisão/Outros * `REINTEGRATION` – Reintegração * `RECONSTRUCTION` – Recondução (Servidor Público) * `REVERSAL` – Reversão (Servidor Público) * `PROVISIONAL` – Provisório de servidor do mesmo órgão/entidade * `REQUEST` – Requisição * `REDISTRIBUTION` – Redistribuição (Servidor Público) * `DECENTRALIZED` – Descentralizado de servidor do mesmo órgão/entidade * `REMOVAL` – Remoção (Servidor Público) * `READAPTATION` – Readaptação (Servidor Público) companyType: type: string enum: – BRANCH_OFFICE – HEAD_OFFICE – WORK – TEMPORARY – WORK_COOPERATIVELY – DOMESTIC_WORKER – EMPLOYER_ESOCIAL description: Tipo da empresa: * `BRANCH_OFFICE` – Filial * `HEAD_OFFICE` – Matriz * `WORK` – Obra * `TEMPORARY` – Temporário * `WORK_COOPERATIVELY` – Cooperativa de trabalho * `DOMESTIC_WORKER` – Trabalhador doméstico * `EMPLOYER_ESOCIAL` – Empregador eSocial subscriptionType: type: string enum: – EMPTY – CNPJ – CEI – CPF – INCRA – CAEPF – CNO – NIT description: Tipo da inscrição: * `EMPTY` – Vazio * `CNPJ` – CNPJ * `CEI` – CEI * `CPF` – CPF * `INCRA` – INCRA * `CAEPF` – CAEPF * `CNO` – CNO * `NIT` – NIT – Número de Identificación Tributária (Colômbia) ActiveType: type: string enum: – ALL – ACTIVE – INACTIVE description: Ativo/Inativo: * `ALL` – Todos * `ACTIVE` – Ativo * `INACTIVE` – Inativo shiftType: type: string enum: – FIRST_TURN – SECOND_TURN – THIRD_TURN – FOURTH_TURN – MIST – GENERAL description: Turnos Remuneração: * `FIRST_TURN` – Primeiro turno. * `SECOND_TURN` – Segundo turno. * `THIRD_TURN` – Terceiro turno. * `FOURTH_TURN` – Quarto turno. * `MIST` – Turno misto. * `GENERAL` – Turno geral directionType: type: string enum: – ASC – DESC description: Tipo de ordenação: * `ASC` – Ascendente * `DESC` – Descendente descendantType: type: string enum: – ALL – DIRECT description: Tipo de liderado: * `ALL` – Todos * `DIRECT` – Diretos 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 healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim resultBaseData: description: Retorno base para os endpoints discriminator: _discriminator type: object required: – ok – _discriminator properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta default: false message: type: string description: Mensagem de retorno default: _discriminator: type: string description: blobServiceRequestAccessData: description: Dados de retorno do acesso do arquivo allOf: – #/definitions/resultBaseData – type: object required: – locationURI properties: locationURI: type: string description: URI onde o arquivo está disponível para download generalFilterEntryInfo: description: DTO genérico de entrada para os dados do filtro type: object properties: company: type: string description: Identificador único da empresa page: type: integer format: int64 description: Página a ser buscada default: 0 size: type: integer format: int64 description: Tamanho da página maximum: 100 default: 10 q: type: string description: Termo para filtrar generalFilterResultInfo: description: DTO genérico para o retorno dos dados do filtro discriminator: _discriminator type: object required: – name – code – id – metaId – idAux – metaIdAux – _discriminator properties: name: type: string description: nome do objeto code: type: string description: código do objeto id: type: string description: Id do objeto metaId: type: string description: Id do objeto na G5 idAux: type: string description: Id do objeto auxiliar metaIdAux: type: string description: Id do objeto na G5 auxiliar _discriminator: type: string description: companyResultInfo: description: Busca de empresas. allOf: – #/definitions/generalFilterResultInfo – type: object required: – tradingName properties: tradingName: type: string description: Nome fantasia jobPositionResultInfo: description: Busca de cargos. allOf: – #/definitions/generalFilterResultInfo – type: object required: – jobPositionStructureId properties: jobPositionStructureId: type: string description: Identificador da estrutura do cargo generalFilterShifts: description: DTO para o retorno dos turnos dos liderados para o filtro geral type: object required: – translationKey – enumOrdinal – enumName properties: translationKey: type: string description: Chave de tradução do item de enumeração enumOrdinal: type: string description: Valor da enumeração enumName: type: string description: Nome da enumeração contractTypesDTO: description: DTO para o retorno dos tipos de contrato type: object required: – translationKey – enumOrdinal – enumName properties: translationKey: type: string description: Chave de tradução do item de enumeração enumOrdinal: type: string description: Valor da enumeração enumName: type: string description: Nome da enumeração leadersResultInfo: description: Busca de Lideres allOf: – #/definitions/generalFilterResultInfo – type: object getEmployeesInput: description: type: object properties: company: type: string description: Empresa branches: type: array items: type: string description: Empresa Filial shifts: type: array items: type: integer format: int64 description: Turno do colaborador costcenters: type: array items: type: string description: Centro de custo do colaborador departments: type: array items: type: string description: Departamento do colaborador gender: type: string allOf: – #/definitions/genderType description: Gênero do Colaborador leaders: type: array items: type: string description: Lideres descendants: type: string description: Indica se a busca vai ser somente para liderados diretos ou todos. jobpositions: type: array items: type: string description: Cargo do colaborador contracttypes: type: array items: type: string allOf: – #/definitions/employeeContractType description: Tipo de contrato startReferenceDate: type: string format: date description: Data de início da busca endReferenceDate: type: string format: date description: Data de fim da busca page: type: integer format: int64 description: Pagina a ser buscada size: type: integer format: int64 description: Tamanho da página q: type: string description: Filtro por nome do colaborador. pagedEmployeeAbsenteeismListQuery: description: Dados de retorno paginado da consulta de absenteísmo allOf: – #/definitions/paged – type: object required: – employeeAbsenteeismIndexes properties: employeeAbsenteeismIndexes: type: array items: type: object allOf: – #/definitions/employeeAbsenteeismIndexData minimum: 1 description: Índices de absenteísmo do colaborador absenceHoursByCompetenceData: description: Dados de retorno de horas por competência (mês/ano) type: object required: – absenceHours – competence properties: absenceHours: type: string description: Horas de ausência competence: type: string description: Competência (mês/ano) employeeAbsenteeismIndexData: description: Dados da consulta de absenteísmo type: object required: – employeeId – personName – jobpositionCode – jobpositionName – startDate – endDate – absenceHours – totalAbsenceHours – absenteeismIndex properties: employeeId: type: string description: Id do Colaborador personName: type: string description: Nome da Pessoa jobpositionCode: type: string description: Código do Cargo jobpositionName: type: string description: Nome do Cargo startDate: type: string description: Início do intervalo compreendido endDate: type: string description: Fim do intervalo compreendido absenceHours: type: array items: type: object allOf: – #/definitions/absenceHoursByCompetenceData minimum: 1 description: Horas de ausência por competência totalAbsenceHours: type: string description: Total de horas de ausência do colaborador no ano absenteeismIndex: type: number format: double description: Índice de absenteísmo do colaborador iassistEmployeeAbsenteeismIndexData: description: Dados da consulta de absenteísmo utilizados na integração com o IAssit (cuidado para não quebrar contrato). Não reutilizar esse dto para outras finalidades type: object required: – employeeId – personName – jobpositionCode – jobpositionName – startDate – endDate – absenceHours – totalAbsenceHours – absenteeismIndex properties: employeeId: type: string description: Id do Colaborador personName: type: string description: Nome do Colaborador jobpositionCode: type: string description: Código do Cargo jobpositionName: type: string description: Nome do Cargo startDate: type: string description: Início do intervalo compreendido endDate: type: string description: Fim do intervalo compreendido absenceHours: type: string description: Horas de ausência por competência totalAbsenceHours: type: string description: Total de horas de ausência do colaborador no ano absenteeismIndex: type: number format: double description: Índice de absenteísmo do colaborador dateRange: description: Range/Período entre datas, contendo início e fim type: object properties: start: type: string description: Data de início end: type: string description: Data de fim autocompleteData: description: DTO com os dados selecionados do autocomplete type: object required: – tableId properties: tableId: type: string description: Id da tabela name: type: string description: Descrição da tabela pagination: description: Dados da paginação type: object required: – current – size properties: current: type: integer format: int64 description: Página atual, inicia em 1 minimum: 1 size: type: integer format: int64 description: Quantidade de páginas, inicia em 1 minimum: 1 maximum: 100 orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Ordenar por ordination: description: Dados da ordenação type: object required: – field properties: field: type: string description: Campo que será ordenado direction: type: string allOf: – #/definitions/directionType description: Tipo da ordenação paged: description: Retorno paginado discriminator: _discriminator type: object required: – countResult – numberPages – _discriminator properties: countResult: type: integer format: int64 description: Quantidade de registros encontrados numberPages: type: integer format: int64 description: Quantidade de páginas da consulta (incluindo a atual) _discriminator: type: string description: pagedTotalAbsenceHoursListQuery: description: Dados de retorno paginado da consulta de totais de horas de ausências allOf: – #/definitions/paged – type: object required: – totalAbsenceHours properties: totalAbsenceHours: type: array items: type: object allOf: – #/definitions/totalAbsenceHoursData minimum: 1 description: Totais de horas de ausências totalAbsenceHoursData: description: Dados da consulta de totais de horas de ausências type: object required: – absenceType – startDate – endDate – absenceHours – totalAbsenceHoursInYear – absenceTypePercentage properties: absenceType: type: string description: Tipo de ausência startDate: type: string description: Início do intervalo compreendido endDate: type: string description: Fim do intervalo compreendido absenceHours: type: array items: type: object allOf: – #/definitions/absenceHoursByCompetenceData minimum: 1 description: Horas de ausência por competência totalAbsenceHoursInYear: type: string description: Total de horas de ausências dos colaboradores no ano absenceTypePercentage: type: string description: Percentual do tipo de ausência iassistTotalAbsenceHoursData: description: Dados da consulta de totais de horas de ausências. Utilizar esse DTO apenas para integração com o IAssist. type: object required: – absenceType – startDate – endDate – absenceHours – totalAbsenceHours – absenceTypePercentage – isPlanned properties: absenceType: type: string description: Tipo de ausência startDate: type: string description: Início do intervalo compreendido endDate: type: string description: Fim do intervalo compreendido absenceHours: type: string description: Horas de ausência por competência totalAbsenceHours: type: string description: Total de horas de ausências dos colaboradores no ano absenceTypePercentage: type: string description: Percentual do tipo de ausência isPlanned: type: boolean description: Se a ausência é planejada (true) ou não (false) absenteeismTotalizerDataIAssist: description: type: object required: – absenteeismIndex – totalWorkedHours – totalAbsenceHours properties: absenteeismIndex: type: number format: double description: Índice de absenteísmo totalWorkedHours: type: string description: Total de horas de trabalhadas totalAbsenceHours: type: string description: Total de horas de ausência absenteeismTotalizerData: description: Dados da consulta de totalizadores de absenteísmo type: object required: – absenteeismIndex – totalWorkedHours – totalAbsenceHours properties: absenteeismIndex: type: number format: double description: Índice de absenteísmo totalWorkedHours: type: string description: Total de horas de trabalhadas totalAbsenceHours: type: string description: Total de horas de ausência autocompleteFilter: description: DTO com informações do lookup type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro keyValue: description: Objeto chave valor para map type: object required: – key – value properties: key: type: string description: Nome do campo filtro que está sendo enviado como parâmetro value: type: string description: Valor do campo filtro que está sendo enviado como parâmetro company: description: type: object required: – id – cnpj – subscriptionType – companyname – companytype properties: id: type: string maxLength: 32 description: Id da empresa code: type: integer format: int64 description: Código da empresa cnpj: type: string description: Cnpj da empresa subscriptionType: type: string allOf: – #/definitions/subscriptionType description: Tipo de Inscrição companyname: type: string description: Nome da empresa headquarter: type: string description: Relacionamento com a sede da empresa companytype: type: string allOf: – #/definitions/companyType description: Tipo da empresa tradingname: type: string description: Nome fantasia da empresa startDate: type: string format: date description: Início das atividades endDate: type: string format: date description: Encerramento das atividades deleted: type: boolean description: Se a empresa foi excluída wageTypeTable: description: Tabela de evento da folha de pagamento type: object required: – code – name – validity properties: id: type: string maxLength: 32 description: Id da tabela de evento code: type: integer format: int64 description: Código da tabela de evento name: type: string description: Descrição da tabela de evento validity: type: string description: Indicador de validade wagetype: description: Evento da folha de pagamento type: object required: – id – wageTypeTable – code – name – wageValueType – type properties: id: type: string description: Id do evento wageTypeTable: type: object allOf: – #/definitions/wageTypeTable description: Relacionamento com tabelas de eventos code: type: integer format: int64 description: Código do evento name: type: string description: Descrição do evento wageValueType: type: string allOf: – #/definitions/wageValueType description: Tipo de valor do evento type: type: string allOf: – #/definitions/wageTypeCategory description: Tipo do evento creationdate: type: string format: date description: Data de criação expirationdate: type: string format: date description: Data de extinção syndicate: type: string maxLength: 32 description: Identificador do sindicato do da contribuição sindical externalId: type: string description: Id externo absenceType: description: Tipo de ausência (Fechamento de Indicadores do Analytics SST) type: object required: – id – code – name – isPlannedAbsence properties: id: type: string maxLength: 32 description: Id company: type: object allOf: – #/definitions/company description: Empresa code: type: integer format: int64 description: Código do tipo da ausência name: type: string description: Descrição do tipo de ausência x-i18n: true isPlannedAbsence: type: boolean description: Ausência planejada externalId: type: string description: Id externo 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. editAbsenceType: type: object required: – id allOf: – #/definitions/absenceType employeeWorkedHoursByCompetence: description: Horas de jornada por colaborador/competência (Fechamento de Indicadores do Analytics SST) type: object required: – id – employee – referenceCompetence – monthTotalMinutes properties: id: type: string maxLength: 32 description: Id employee: type: object allOf: – #/definitions/employee description: Colaborador referenceCompetence: type: string format: date description: Competência de referência monthTotalMinutes: type: integer format: int64 description: Total de minutos no mês externalId: type: string description: Id externo editEmployeeWorkedHoursByCompetence: type: object required: – id allOf: – #/definitions/employeeWorkedHoursByCompetence employeeAbsenceHoursByCompetenceAndType: description: Horas de ausência do colaborador/competência/tipo (Fechamento de Indicadores do Analytics SST) type: object required: – id – employee – referenceCompetence – absenceType – absenceMinutesAmount properties: id: type: string maxLength: 32 description: Id employee: type: object allOf: – #/definitions/employee description: Colaborador referenceCompetence: type: string format: date description: Competência de referência absenceType: type: object allOf: – #/definitions/absenceType description: Código do tipo de ausência absenceMinutesAmount: type: integer format: int64 description: Quantidade de minutos de ausência externalId: type: string description: Id externo editEmployeeAbsenceHoursByCompetenceAndType: type: object required: – id allOf: – #/definitions/employeeAbsenceHoursByCompetenceAndType employee: description: Colaborador type: object required: – id – registernumber – employeetype – hiredate – contracttype – hireType – person – department – jobposition – employer – companynumber properties: id: type: string maxLength: 32 description: Id registernumber: type: integer format: int64 description: Número de registro employeetype: type: string allOf: – #/definitions/employeeType description: Tipo de colaborador hiredate: type: string format: date description: Data de admissão dismissaldate: type: string format: date description: Data de demissão contracttype: type: string allOf: – #/definitions/employeeContractType description: Tipo de contrato hireType: type: string allOf: – #/definitions/hireType description: Tipo de admissão person: type: object allOf: – #/definitions/person description: Pessoa department: type: object allOf: – #/definitions/department description: Departamento jobposition: type: object allOf: – #/definitions/jobposition description: Cargo employer: type: object allOf: – #/definitions/company description: Empresa companynumber: type: integer format: int64 description: Código da empresa workshift: type: object allOf: – #/definitions/workshift description: Escala costcenter: type: object allOf: – #/definitions/costcenter description: Centro de Custo attachment: type: object allOf: – #/definitions/attachment description: Foto do colaborador person: description: Pessoa type: object required: – id – firstname – lastname – cpf – birthday – gender properties: id: type: string maxLength: 32 description: Id firstname: type: string description: Primeiro nome middlename: type: string description: Nome do meio lastname: type: string description: Último nome cpf: type: string maxLength: 11 description: CPF da pessoa birthday: type: string format: date description: Data de nascimento da pessoa educationdegree: type: string description: Escolaridade da pessoa gender: type: string allOf: – #/definitions/genderType description: Gênero da pessoa maritalstatus: type: string allOf: – #/definitions/maritalStatus description: Estado civil fullname: type: string description: Nome completo username: type: string description: Nome de usuário jobposition: description: Cargo type: object required: – id – code – name – jobpositionstructure properties: id: type: string maxLength: 32 description: Id do cargo code: type: string description: Código do cargo name: type: string description: Nome do cargo x-i18n: true cbo: type: string description: CBO do cargo jobpositionstructure: type: string description: Id da estrutura de cargos creationDate: type: string format: date description: Data de criação do cargo expirationDate: type: string format: date description: Data de extinção do cargo shortname: type: string description: Nome curto do cargo x-i18n: true translations: type: object properties: locale: type: object properties: name: type: string shortname: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR.shortname: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale.shortname: Text example using en-US locale. department: description: Local de trabalho type: object required: – id – code – name – position – tablecode – creationdate – expirationdate properties: id: type: string maxLength: 32 description: Id do local code: type: string description: Código do local name: type: string description: Nome do local x-i18n: true position: type: string description: Posição tablecode: type: integer format: int64 description: Código da tabela creationdate: type: string format: date description: Data de criação expirationdate: type: string format: date description: Data de extinção externalId: type: string description: Id de sistema externo 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. attachment: description: Anexo type: object required: – name properties: id: type: string maxLength: 32 description: Identificador name: type: string description: Nome do arquivo type: string description: Versão do arquivo temporário permanentUrl: type: string description: Caminho permanente do arquivo person: type: object allOf: – #/definitions/person description: Pessoa sourceId: type: string description: Identificador do anexo costcenter: description: Centro de custo type: object required: – id – name properties: id: type: string description: Identificador único do centro de custo company: type: string description: Empresa name: type: string description: Nome do centro de custo x-i18n: true code: type: string description: Código do centro de custo expirationDate: type: string format: date description: Data de expiração do centro de custo externalId: type: string description: Id externo de Centro de Custo 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. workshift: description: Turno de trabalho type: object required: – id – description – monthminutes – weekminutes – shift – dsrminutes – code – workshiftType properties: id: type: string description: Identificador único description: type: string description: Descrição monthminutes: type: integer format: int64 description: Minutos do mês weekminutes: type: integer format: int64 description: Minutos da semana shift: type: integer format: int64 description: Turno dsrminutes: type: integer format: int64 description: DSR Minutes code: type: integer format: int64 description: Código workshiftType: type: integer format: int64 description: Tipo de turno meta: description: Tabela de registro das integrações com a G5 type: object required: – id – metaGroup – metaKey – metaValue properties: id: type: string description: Identificador único metaGroup: type: string description: Grupo metaKey: type: string description: Chave metaValue: type: string description: Valor editMeta: type: object required: – id allOf: – #/definitions/meta hierarchyitem: description: Item da hierarquia type: object required: – id – hierarchy – parent – workstation – position properties: id: type: string description: Identificador único do item da hierarquia hierarchy: type: object allOf: – #/definitions/hierarchy description: Hierarquia a qual este item pertence parent: type: string description: Identificador único do item pai do item em questão (Superior imediato na hierarquia) workstation: type: object allOf: – #/definitions/workstation description: Posto de trabalho ligada ao item da hierarquia em questão position: type: string description: Posição deste item na hierarquia hierarchy: description: Hierarquia type: object required: – id – name – description properties: id: type: string description: Identificador único da hierarquia name: type: string description: Nome da hierarquia description: type: string description: Descrição da hierarquia editHierarchy: type: object required: – id allOf: – #/definitions/hierarchy companyhierarchy: description: Hierarquia da empresa type: object required: – id – company – hierarchy – startdate properties: id: type: string description: Identificador único da hierarquia da empresa company: type: object allOf: – #/definitions/company description: Empresa hierarchy: type: object allOf: – #/definitions/hierarchy description: Hierarquia startdate: type: string format: date description: Data de início organizationalchart: description: Organograma da empresa type: object required: – id – description – name – companyId properties: id: type: string description: Identificador único do organograma description: type: string description: Descrição do organograma name: type: string description: Nome do organograma companyId: type: object allOf: – #/definitions/company description: Empresa organizationalchartitem: description: Locais do organograma type: object required: – id – name – departament – organizationalchart properties: id: type: string description: Identificador único do item name: type: string description: Nome do local no organograma departament: type: object allOf: – #/definitions/department description: Local do nível do organograma organizationalchart: type: object allOf: – #/definitions/organizationalchart description: Organograma ao qual o local pertence workstationgroupstructure: description: Estrutura do posto de trabalho type: object required: – code properties: id: type: string maxLength: 32 description: Id da estrutura name: type: string description: Nome da estrutura code: type: integer format: int64 description: Código da estrutura minimum: 1 maximum: 999 workstationgroup: description: Posto de trabalho type: object required: – id – name – contractType – headoffice – creationDate – workstationgroupstructure properties: id: type: string maxLength: 32 description: Id do posto de trabalho code: type: string description: Código do posto de trabalho name: type: string description: Nome do posto de trabalho contractType: type: string allOf: – #/definitions/employeeContractType description: Tipo do contrato headoffice: type: object allOf: – #/definitions/company description: Empresa branchoffice: type: object allOf: – #/definitions/company description: Filial department: type: object allOf: – #/definitions/department description: Local creationDate: type: string format: date description: Data de criação do posto de trabalho expirationDate: type: string format: date description: Data de expiração do posto de trabalho workstationgroupstructure: type: object allOf: – #/definitions/workstationgroupstructure description: Estrutura do posto de trabalho workstation: description: Posto de trabalho do colaborador type: object required: – id – company – occupant – workstationgroup properties: id: type: string maxLength: 32 description: Id do posto de trabalho company: type: object allOf: – #/definitions/company description: Empresa occupant: type: object allOf: – #/definitions/employee description: Relacionamento com o colaborador workstationgroup: type: object allOf: – #/definitions/workstationgroup description: Relacionamento com o posto de trabalho historicalWorkstation: description: Histórico de posto de trabalho type: object required: – id – dateWhen – employee – workstationGroupId properties: id: type: string maxLength: 32 description: Id do histórico dateWhen: type: string format: date description: Data do histórico endDate: type: string format: date description: Data de término employee: type: object allOf: – #/definitions/employee description: Id do colaborador workstationGroupId: type: object allOf: – #/definitions/workstationgroup description: Id do posto de trabalho actingType: type: object allOf: – #/definitions/actingtype description: Tipo da atuação actingtype: description: Tipos de Atuação type: object required: – id – code – name – mainhistory properties: id: type: string maxLength: 32 description: Id do tipo de atuação code: type: integer format: int64 description: Código do tipo de atuação name: type: string description: Descrição do tipo de atuação x-i18n: true mainhistory: type: boolean description: Histórico principal? 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. companyjobpositionstructure: description: Estrutura do cargo – Empresa type: object required: – company – jobpositionstructure properties: id: type: string maxLength: 32 description: Id company: type: object allOf: – #/definitions/company description: Empresa jobpositionstructure: type: object allOf: – #/definitions/jobpositionstructure description: Id da estrutura de cargos startdate: type: string format: date description: Data em que a estrutura de cargo entrou em vigor na empresa jobpositionstructure: description: Estrutura do cargo type: object required: – name – code properties: id: type: string maxLength: 32 description: Id da estrutura name: type: string description: Descrição da estrutura code: type: integer format: int64 description: Código da estrutura de cargos minimum: 1 maximum: 9999 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status 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