Gestão de Pessoas (hcm)

Gestão de férias (vacationmanagement)

299 views 02/07/2019 21/11/2020 integrador 0

2.0info: 2.1.0 Gestão de férias description: Gestão de férias x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: vacationmanagement 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: /vacationmanagement/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/queries/ post: description: Retorna informações sobre a versão tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – properties properties: properties: type: array items: type: object allOf: – #/definitions/vacationPolicyMap minimum: 1 description: Propriedades da versão default: description: Error response schema: #/definitions/genericError get: description: Retorna informações sobre a versão tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – properties properties: properties: type: array items: type: object allOf: – #/definitions/vacationPolicyMap minimum: 1 description: Propriedades da versão default: description: Error response schema: #/definitions/genericError /vacationmanagement/queries/vacationPolicyWithCompaniesCount: post: description: Busca as políticas de férias juntamente com a quantidade de empresas e filiais que as usam tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page properties: page: type: object allOf: – #/definitions/pagination description: Paginação dos dados orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Ordenação dos campos e tipo filter: type: array items: type: object allOf: – #/definitions/vacationPolicyMap description: Filtro por nome da política, nome da empresa e/ou nome da filial responses: 200: description: Ok schema: type: object allOf: – #/definitions/vacationPoliciesWithCompanyCountPaged 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/queries/vacationPoliciesName: post: description: Busca o nome das políticas de férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: exclusions: type: array items: type: string description: Id das políticas de férias que não devem ser retornadas responses: 200: description: Ok schema: type: object required: – vacationPolicies properties: vacationPolicies: type: array items: type: object allOf: – #/definitions/vacationPolicyName minimum: 1 description: Lista das políticas de férias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o nome das políticas de férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: exclusions description: Id das políticas de férias que não devem ser retornadas in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – vacationPolicies properties: vacationPolicies: type: array items: type: object allOf: – #/definitions/vacationPolicyName minimum: 1 description: Lista das políticas de férias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/queries/companiesWithCompanyBranchesCountByVacationPolicyId: post: description: Busca as empresas e a quantidade de filiais que utilizam uma determinada política de férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationPolicyId – page properties: vacationPolicyId: type: string description: Id da política da qual serão retornados empresas e filiais page: type: object allOf: – #/definitions/pagination description: Paginação dos dados orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Ordenação dos campos e tipo filter: type: array items: type: object allOf: – #/definitions/vacationPolicyMap description: Filtro por nome da empresa e/ou nome da filial responses: 200: description: Ok schema: type: object allOf: – #/definitions/companiesWithCompanyBranchCountPaged 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/queries/companiesWithCompanyBranchesCount: post: description: Busca as empresas e a quantidade de filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page properties: vacationPolicyId: type: string description: Id da política da qual serão retornados empresas e filiais page: type: object allOf: – #/definitions/pagination description: Paginação dos dados orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Ordenação dos campos e tipo filter: type: array items: type: object allOf: – #/definitions/vacationPolicyMap description: Filtro por nome da empresa e/ou nome da filial responses: 200: description: Ok schema: type: object allOf: – #/definitions/companiesWithCompanyBranchCountPaged 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/queries/companyBranchesWithCurrentVacationPolicyStatusByCompanyId: post: description: Buscar as filiais baseado em uma empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – page properties: companyId: type: string description: ID da empresa para filtrar as filiais vacationPolicyId: type: string description: ID da política de férias atual, se existir page: type: object allOf: – #/definitions/pagination description: Paginação dos dados orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Ordenação dos campos e tipo filter: type: array items: type: object allOf: – #/definitions/vacationPolicyMap description: Filtro por nome da empresa e/ou nome da filial responses: 200: description: Ok schema: type: object allOf: – #/definitions/companyBranchWithCurrentVacationPolicyStatusPaged 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/queries/companyBranchesByCompanyAndVacationPolicyId: post: description: Buscar as filiais baseado em uma política e uma empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationPolicyId – companyId – page properties: vacationPolicyId: type: string description: ID da política para filtrar as filiais companyId: type: string description: ID da empresa para filtrar as filiais page: type: object allOf: – #/definitions/pagination description: Paginação dos dados orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Ordenação dos campos e tipo filter: type: array items: type: object allOf: – #/definitions/vacationPolicyMap description: Filtro por nome da empresa e/ou nome da filial responses: 200: description: Ok schema: type: object allOf: – #/definitions/companyBranchSummarizedPaged 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/queries/validateVacationSchedule: post: description: Realiza a validação da solicitação de férias com base na política de férias. A política de férias utilizada na validação será a definida para a filial do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationSchedules properties: vacationSchedules: type: array items: type: object allOf: – #/definitions/vacationSchedule minimum: 1 description: Solicitações de férias responses: 200: description: Ok schema: type: object required: – vacationScheduleMessages properties: vacationScheduleMessages: type: array items: type: object allOf: – #/definitions/vacationScheduleMessage minimum: 1 description: Mensagem com o erro, caso tenha ocorrido problema de validação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/queries/validateVacationScheduleChange: post: description: Realiza a validação da alteração das férias com base na política de férias. A política de férias utilizada na validação será a definida para a filial do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationSchedules properties: vacationSchedules: type: array items: type: object allOf: – #/definitions/vacationScheduleChange minimum: 1 description: Solicitações de férias responses: 200: description: Ok schema: type: object required: – vacationScheduleMessages properties: vacationScheduleMessages: type: array items: type: object allOf: – #/definitions/vacationScheduleChangeMessage minimum: 1 description: Mensagem com o erro, caso tenha ocorrido problema de validação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/queries/validateVacationScheduleCancellation: post: description: Realiza a validação do cancelamento das férias com base na política de férias. A política de férias utilizada na validação será a definida para a filial do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationSchedules properties: vacationSchedules: type: array items: type: object allOf: – #/definitions/vacationScheduleCancellation minimum: 1 description: Solicitações de férias responses: 200: description: Ok schema: type: object required: – vacationScheduleMessages properties: vacationScheduleMessages: type: array items: type: object allOf: – #/definitions/vacationScheduleCancellationMessage minimum: 1 description: Mensagem com o erro, caso tenha ocorrido problema de validação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/queries/getVacationPolicyByEmployee: post: description: Busca a política de férias do colaborador através do id do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: Id do colaborador responses: 200: description: Ok schema: type: object required: – vacationPolicy properties: vacationPolicy: type: object allOf: – #/definitions/vacationPolicy description: Política de férias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca a política de férias do colaborador através do id do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Id do colaborador in: query required: true type: string responses: 200: description: Ok schema: type: object required: – vacationPolicy properties: vacationPolicy: type: object allOf: – #/definitions/vacationPolicy description: Política de férias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/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 /vacationmanagement/queries/exportVacationPolicy: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /vacationmanagement/queries/exportCompany: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /vacationmanagement/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /vacationmanagement/queries/exportVacationperiod: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /vacationmanagement/queries/exportVacationreceipt: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /vacationmanagement/queries/exportIndividualvacationschedule: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /vacationmanagement/queries/exportVacationrequestupdate: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /vacationmanagement/queries/exportPersonrequestupdate: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /vacationmanagement/queries/exportCompanyhierarchy: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /vacationmanagement/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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 /vacationmanagement/actions/saveOrUpdateVacationPolicy: post: description: Salva ou atualiza um política de férias e define suas empresas/filiais tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationPolicy properties: vacationPolicy: type: object allOf: – #/definitions/vacationPolicy description: Política de férias newVacationPolicyIdForUnselections: type: string description: Id da política de férias que será definida para as filiais que foram removidas da seleção durante a edição companies: type: array items: type: object allOf: – #/definitions/vacationPolicyCompanySelection description: Lista das empresas e suas filiais selecionadas fractioningTypes: type: array items: type: string allOf: – #/definitions/fractioningType description: Lista de fracionamentos responses: 200: description: Ok schema: type: object allOf: – #/definitions/vacationPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/actions/removeVacationPolicy: post: description: Remove uma política de férias tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacationPolicyId – newVacationPolicyId properties: vacationPolicyId: type: string description: ID da política para remover newVacationPolicyId: type: string description: ID da nova política que será utilizada pelas empresas e filias da política excluída responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/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 /vacationmanagement/actions/importVacationPolicy: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /vacationmanagement/actions/importCompany: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /vacationmanagement/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /vacationmanagement/actions/importVacationperiod: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /vacationmanagement/actions/importVacationreceipt: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /vacationmanagement/actions/importIndividualvacationschedule: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /vacationmanagement/actions/importVacationrequestupdate: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /vacationmanagement/actions/importPersonrequestupdate: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /vacationmanagement/actions/importCompanyhierarchy: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /vacationmanagement/entities/vacationPolicy: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationPolicy responses: 200: description: The created resource schema: #/definitions/vacationPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationPolicy responses: 200: description: The created resource schema: #/definitions/vacationPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/vacationPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationPolicy/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationPolicy responses: 200: description: Ok schema: #/definitions/vacationPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationPolicy responses: 200: description: Ok schema: #/definitions/vacationPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vacationPolicy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /vacationmanagement/entities/vacationPolicy/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vacationPolicy responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationPolicyFractioning: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationPolicyFractioning responses: 200: description: The created resource schema: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationPolicyFractioning responses: 200: description: The created resource schema: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationPolicyFractioning/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationPolicyFractioning responses: 200: description: Ok schema: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationPolicyFractioning responses: 200: description: Ok schema: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /vacationmanagement/entities/vacationPolicy/{parentId}/fractioningTypes: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/vacationPolicyFractioning responses: 200: description: The created resources schema: type: array items: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/vacationPolicyFractioning responses: 200: description: The created resources schema: type: array items: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationPolicy/{parentId}/fractioningTypes/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationPolicyFractioning responses: 200: description: Ok schema: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationPolicyFractioning responses: 200: description: Ok schema: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vacationPolicyFractioning 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationPolicyFractioning/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vacationPolicyFractioning responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/company: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/company/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /vacationmanagement/entities/company/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/employee: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationperiod: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationperiod responses: 200: description: The created resource schema: #/definitions/vacationperiod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationperiod responses: 200: description: The created resource schema: #/definitions/vacationperiod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/vacationperiod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationperiod/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationperiod responses: 200: description: Ok schema: #/definitions/vacationperiod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationperiod responses: 200: description: Ok schema: #/definitions/vacationperiod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vacationperiod 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationperiod/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vacationperiod responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationreceipt: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationreceipt responses: 200: description: The created resource schema: #/definitions/vacationreceipt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationreceipt responses: 200: description: The created resource schema: #/definitions/vacationreceipt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/vacationreceipt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationreceipt/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationreceipt responses: 200: description: Ok schema: #/definitions/vacationreceipt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationreceipt responses: 200: description: Ok schema: #/definitions/vacationreceipt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vacationreceipt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationreceipt/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vacationreceipt responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/individualvacationschedule: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/individualvacationschedule responses: 200: description: The created resource schema: #/definitions/individualvacationschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/individualvacationschedule responses: 200: description: The created resource schema: #/definitions/individualvacationschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/individualvacationschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/individualvacationschedule/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/individualvacationschedule responses: 200: description: Ok schema: #/definitions/individualvacationschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/individualvacationschedule responses: 200: description: Ok schema: #/definitions/individualvacationschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/individualvacationschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/individualvacationschedule/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/individualvacationschedule responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationrequestupdate: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vacationrequestupdate responses: 200: description: The created resource schema: #/definitions/vacationrequestupdate 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/vacationrequestupdate responses: 200: description: The created resource schema: #/definitions/vacationrequestupdate 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 responses: 200: description: Ok schema: type: array items: #/definitions/vacationrequestupdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/vacationrequestupdate/{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/vacationrequestupdate responses: 200: description: Ok schema: #/definitions/vacationrequestupdate 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/vacationrequestupdate responses: 200: description: Ok schema: #/definitions/vacationrequestupdate 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/vacationrequestupdate 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 /vacationmanagement/entities/vacationrequestupdate/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vacationrequestupdate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/personrequestupdate: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/personrequestupdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /vacationmanagement/entities/companyhierarchy: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/companyhierarchy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN month: description: Mês type: string enum: – JANUARY – FEBRUARY – MARCH – APRIL – MAY – JUNE – JULY – AUGUST – SEPTEMBER – OCTOBER – NOVEMBER – DECEMBER vacationBonusType: description: Tipo de Abono type: string enum: – UNTIL_TEN_DAYS – TEN_DAYS – ONE_THIRD_OF_REQUESTED_DAYS fractioningType: description: Tipos de fracionamento type: string enum: – ONE_PART – TWO_PARTS – THREE_PARTS – TWENTY_TEN – FIFTEEN_FIFTEEN – EIGHTEEN_TWELVE – FOURTEEN_TEN_SIX – FOURTEEN_EIGHT_EIGHT directionType: description: Tipo de ordenação type: string enum: – ASC – DESC companySelectionType: description: Tipo de seleção durante o processo de seleção de empresas/filiais no cadastro da política de férias type: string enum: – ALL – NONE – SOME vacationPeriodSituation: description: Tipo de período de férias do colaborador type: string enum: – OPENED – PAID validationMessageType: description: Tipo de mensagem de erro type: string enum: – TYPE_1_VACATION_SCHEDULING_IN_ADVANCE – TYPE_2_THIRTEENTH_SALARY_ADVANCE_TIME_INTERVAL – TYPE_3_THIRTEENTH_SALARY_ADVANCE_DISABLED – TYPE_4_VACATION_BONUS_TIME_INTERVAL – TYPE_5_VACATION_BONUS_DISABLED – TYPE_6_VACATION_BONUS_DAYS – TYPE_7_VACATION_BONUS_DAYS_WITHOUT_BONUS_BALANCE – TYPE_8_VACATION_BONUS_DAYS_GREATER_THAN_VACATION_BALANCE – TYPE_9_PREVIOUS_VACATION_PERIOD_OPENED – TYPE_10_START_VACATION_ON_WEEKLY_PAID_REST – TYPE_11_START_VACATION_ON_DAY_OFF – TYPE_12_START_VACATION_ON_COMPENSATED_DAY – TYPE_13_FRACTIONING_NOT_COMPATIBLE – TYPE_14_VACATION_PERIOD_NOT_OPEN – TYPE_15_START_DATE_BEFORE_VACATION_PERIOD_START_DATE – TYPE_16_START_DATE_BEFORE_VACATION_PERIOD_END_DATE – TYPE_17_REQUESTED_VACATION_DAYS_GREATER_THAN_VACATION_BALANCE – TYPE_18_EMPLOYEE_ABSENCE_SCHEDULED_ON_START_DATE – TYPE_19_VACATION_DOUBLE – TYPE_20_VACATION_SCHEDULED_ON_HOLIDAY – TYPE_21_VACATION_CHANGING_IN_ADVANCE – TYPE_22_VACATION_CANCELLATION_IN_ADVANCE vacationScheduleOperationType: description: Indica a ação de inserir, alterar ou cancelar uma solicitação de férias type: string enum: – INSERT – CHANGE – CANCEL userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status companiesWithCompanyBranchCountPaged: description: Retorno das empresas/filiais da política allOf: – #/definitions/paged – type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/companyWithBranchCount minimum: 1 description: Lista de registros que representa uma empresa e que possui a quantidade de filiais que utilizam uma determinada política companyWithBranchCount: description: Registro que representa uma empresa e que possui a quantidade de filiais que utilizam uma determinada política type: object required: – id – name – tradingName – companyBranchCount properties: id: type: string description: ID da empresa name: type: string description: Nome da empresa tradingName: type: string description: Nome fantasia companyBranchCount: type: integer format: int64 description: Quantidade de filiais da empresa que utilizam a política companyBranchSummarizedPaged: description: Lista das filiais da política allOf: – #/definitions/paged – type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/companyBranchSummarized minimum: 1 description: Lista de filiais que utilizam uma determinada política companyBranchSummarized: description: Registro para a listagem de filiais, onde exibe apenas o nome type: object required: – id – name – tradingName properties: id: type: string description: ID da filial name: type: string description: Nome da filial tradingName: type: string description: Nome fantasia companyBranchWithCurrentVacationPolicyStatusPaged: description: Lista das filiais com nome, id se usa a política de férias atual allOf: – #/definitions/paged – type: object required: – companyBranchs properties: companyBranchs: type: array items: type: object allOf: – #/definitions/companyBranchWithCurrentVacationPolicyStatus minimum: 1 description: Lista de filiais e suas políticas companyBranchWithCurrentVacationPolicyStatus: description: Registro para a listagem de filiais com nome, id se usa a política de férias atual type: object required: – id – name – isOnCurrentVacationPolicy – tradingName properties: id: type: string description: ID da filial name: type: string description: Nome da filial isOnCurrentVacationPolicy: type: boolean description: Define se a filial utiliza a política de férias atual tradingName: type: string description: Nome fantasia vacationPoliciesWithCompanyCountPaged: description: Lista de registros que representam as políticas de férias e as empresas e filiais que a utilizam. Paginado allOf: – #/definitions/paged – type: object required: – vacationPolicies properties: vacationPolicies: type: array items: type: object allOf: – #/definitions/vacationPolicyWithCompanyCount minimum: 1 description: Lista de registros que representam as políticas de férias e as empresas e filiais que a utilizam vacationPolicyWithCompanyCount: description: Registro que representa uma política de férias e as empresas e filiais que a utilizam type: object required: – id – policyName – defaultPolicy – companyCount – companyBranchCount properties: id: type: string description: ID da política de férias policyName: type: string description: Nome da política de férias defaultPolicy: type: boolean description: Indica se é a política padrão companyCount: type: integer format: int64 description: Quantidade de empresas que utilizam a política de férias companyBranchCount: type: integer format: int64 description: Quantidade de filiais que utilizam a política de férias paged: description: Retorno paginado discriminator: _discriminator type: object required: – totalElements – numberPages – _discriminator properties: totalElements: type: integer format: int64 description: Indica quantos registros foram encontrados numberPages: type: integer format: int64 description: Indica o número de páginas da consulta (incluindo a atual) _discriminator: type: string description: pagination: description: Dados da paginação type: object required: – offset – size properties: offset: type: integer format: int64 description: Página de inicio size: type: integer format: int64 description: Quantidade de registros por página ordination: description: Dados da ordenação type: object required: – field properties: field: type: string description: Campo que será ordenado order: type: string allOf: – #/definitions/directionType description: Tipo da ordenação vacationPolicyMap: description: Mapa genérico de dados type: object required: – key – value properties: key: type: string description: Chave value: type: string description: Valor vacationPolicyCompanySelection: description: Seleção das filiais de um empresa durante o processo de seleção de empresas/filiais na criação/edição de políticas de férias type: object required: – companyId – selectionType properties: companyId: type: string description: ID da empresa selectionType: type: string allOf: – #/definitions/companySelectionType description: Tipo de seleção durante o processo de seleção de empresas/filiais no cadastro da política de férias selectionExceptions: type: array items: type: string description: Filiais que são exceção ao selecionar ALL ou NONE. As filiais informadas aqui não serão alteradas someCompanyBranches: type: object allOf: – #/definitions/vacationPolicyCompanySelectionSome description: Representa a seleção de algumas filiais especificas vacationPolicyCompanySelectionSome: description: Representa a seleção de algumas filiais especificas type: object properties: newCompanyBranchesSelectionIds: type: array items: type: string description: Lista de filiais que foram selecionadas newCompanyBranchesUnselectionIds: type: array items: type: string description: Lista de filiais quem foram desmarcadas vacationPolicyName: description: Representa o nome de uma política de férias type: object required: – id – name properties: id: type: string description: Id da política de férias name: type: string description: Nome da política de férias vacationSchedule: description: Representa uma solicitação de férias type: object required: – employeeId – vacationPeriodId – startDate – vacationDays – vacationBonusDays – has13thSalaryAdvance properties: employeeId: type: string description: Id do colaborador vacationPeriodId: type: string description: Id do período de férias startDate: type: string format: date description: Data inicial das férias vacationDays: type: integer format: int64 description: Quantidade de dias de férias vacationBonusDays: type: integer format: int64 description: Dias de abono has13thSalaryAdvance: type: boolean description: Tem adiantamento do 13º salário vacationScheduleChange: description: Representa uma solicitação de férias a ser alterada type: object required: – vacationId properties: vacationId: type: string description: Id da solicitação startDate: type: string format: date description: Data inicial das férias vacationDays: type: integer format: int64 description: Quantidade de dias de férias vacationBonusDays: type: integer format: int64 description: Dias de abono has13thSalaryAdvance: type: boolean description: Tem adiantamento do 13º salário vacationScheduleCancellation: description: Representa uma solicitação de férias a ser cancelada type: object required: – vacationId properties: vacationId: type: string description: Id da solicitação vacationScheduleData: description: Objeto genérico com todos os dados possíveis de uma solicitação de férias type: object required: – employeeId – vacationPeriodId – startDate – vacationDays – vacationBonusDays – has13thSalaryAdvance – vacationId properties: employeeId: type: string description: Id do colaborador vacationPeriodId: type: string description: Id do período de férias startDate: type: string format: date description: Data inicial das férias vacationDays: type: integer format: int64 description: Quantidade de dias de férias vacationBonusDays: type: integer format: int64 description: Dias de abono has13thSalaryAdvance: type: boolean description: Tem adiantamento do 13º salário vacationId: type: string description: Id da solicitação vacationScheduleMessage: description: Mensagem com o erro, caso tenha ocorrido problema de validação de inserção type: object required: – employeeId – vacationPeriodId – startDate – validationMessages properties: employeeId: type: string description: Id do colaborador vacationPeriodId: type: string description: Id do período de férias startDate: type: string format: date description: Data inicial das férias validationMessages: type: array items: type: object allOf: – #/definitions/validationMessage minimum: 1 description: Mensagens de erro vacationScheduleChangeMessage: description: Mensagem com o erro, caso tenha ocorrido problema de validação de alteração type: object required: – vacationId – employeeId – vacationPeriodId – startDate – validationMessages properties: vacationId: type: string description: Id da solicitação employeeId: type: string description: Id do colaborador vacationPeriodId: type: string description: Id do período de férias startDate: type: string format: date description: Data inicial das férias validationMessages: type: array items: type: object allOf: – #/definitions/validationMessage minimum: 1 description: Mensagens de erro vacationScheduleCancellationMessage: description: Mensagem com o erro, caso tenha ocorrido problema de validação de cancelamento type: object required: – vacationId – validationMessages properties: vacationId: type: string description: Id da solicitação validationMessages: type: array items: type: object allOf: – #/definitions/validationMessage minimum: 1 description: Mensagens de erro validationMessage: description: Mensagem de erro contendo o enum do tipo de erro e a mensagem type: object required: – type – message properties: type: type: string allOf: – #/definitions/validationMessageType description: Tipo de mensagem de erro message: type: string description: Mensagem de erro vacationPolicy: description: Política de férias type: object required: – policyName – vacationSchedulingInAdvanceMinDays – vacationChangeMinDays – vacationCancellationMinDays properties: id: type: string format: uuid description: Id da política policyName: type: string maxLength: 255 description: Nome da política x-i18n: true allowThirteenthSalaryAnticipation: type: boolean description: Permitir solicitar o adiantamento do 13º salário default: false thirteenthSalaryAnticipationBegin: type: string allOf: – #/definitions/month description: Mês de início da permissão de antecipação do 13º thirteenthSalaryAnticipationEnd: type: string allOf: – #/definitions/month description: Mês de fim da permissão de antecipação do 13º allowVacationBonus: type: boolean description: Permitir o abono de férias aos colaboradores, respeitando a quantidade máxima (10 dias) ou 1/3 do período de férias solicitado default: false vacationBonusBegin: type: string allOf: – #/definitions/month description: Mês início da permissão de abono de férias vacationBonusEnd: type: string allOf: – #/definitions/month description: Mês fim da permissão de abono de férias vacationBonusType: type: string allOf: – #/definitions/vacationBonusType description: Tipo de abono permitido vacationSchedulingInAdvanceMinDays: type: integer format: int64 description: Quantidade mínima de dias de antecedência da solicitação de férias minimum: 2 maximum: 999 allowFractioning: type: boolean description: Permite o fracionamento de férias default: false fractioningTypes: type: array items: type: object allOf: – #/definitions/vacationPolicyFractioning description: Tipos de fracionamento permitidos allowBeforeConcessivePeriod: type: boolean description: Permite que o colaborador solicite férias com início anterior ao período concessivo default: false allowOverVacationBalance: type: boolean description: Permite que o colaborador solicite férias superiores ao saldo do período aquisitivo em curso default: false companies: type: array items: type: object allOf: – #/definitions/company description: Lista de empresas e filiais que utilizam a política defaultPolicy: type: boolean description: Indica se é a política padrão default: false readOnly: true vacationChangeMinDays: type: integer format: int64 description: Quantidade mínima de dias de alteração da solicitação de férias minimum: 0 maximum: 999 vacationCancellationMinDays: type: integer format: int64 description: Quantidade mínima de dias de cancelamento da solicitação de férias minimum: 0 maximum: 999 translations: type: object properties: locale: type: object properties: policyName: type: string maxLength: 255 example: pt-BR: policyName: Exemplo de texto usando locale pt-BR. en-US: policyName: Text example using en-US locale. vacationPolicyFractioning: description: Fracionamento de férias type: object required: – fractioningType properties: id: type: string format: uuid description: Id vacationPolicy: type: object allOf: – #/definitions/vacationPolicy description: Política de férias fractioningType: type: string allOf: – #/definitions/fractioningType description: Tipo de fracionamento company: description: Empresa type: object required: – companyname – domainEntityId – tradingname properties: id: type: string format: uuid description: Id da empresa companyname: type: string description: Nome da empresa headquarter: type: object allOf: – #/definitions/company description: Relacionamento com a sede da empresa vacationPolicy: type: object allOf: – #/definitions/vacationPolicy description: Política da empresa companyBranches: type: array items: type: object allOf: – #/definitions/company description: Filiais da empresa domainEntityId: type: string maxLength: 32 description: Id do colaborador no módulo responsável tradingname: type: string maxLength: 40 description: Nome fantasia employee: description: Colaborador type: object properties: id: type: string description: Id do colaborador vacationperiod: description: Período de férias type: object required: – employee – startdate – enddate – situation properties: id: type: string description: Id do período de férias employee: type: string description: Colaborador startdate: type: string format: date description: Data inicial enddate: type: string format: date description: Data final situation: type: string allOf: – #/definitions/vacationPeriodSituation description: Situação do período individualvacationschedules: type: array items: type: object allOf: – #/definitions/individualvacationschedule description: Agendamentos de férias vacationrequestupdates: type: array items: type: object allOf: – #/definitions/vacationrequestupdate description: Solicitações de férias vacationreceipts: type: array items: type: object allOf: – #/definitions/vacationreceipt description: Recibos de férias vacationreceipt: description: Recibo de férias type: object required: – employee – vacationperiod – vacationdays – vacationbonusdays – vacationstart – has13thsalaryadvance properties: id: type: string description: Id do recibo de férias employee: type: string description: Colaborador vacationperiod: type: object allOf: – #/definitions/vacationperiod description: Período de férias vacationdays: type: number format: double description: Dias de férias vacationbonusdays: type: number format: double description: Dias de abono vacationstart: type: string format: date description: Data de início das férias has13thsalaryadvance: type: boolean description: Tem adiantamento do 13º salário individualvacationschedule: description: Agendamento de férias type: object required: – vacationperiod – vacationdays – vacationbonusdays – startdate – has13thsalaryadvance properties: id: type: string description: Id do agendamento de férias vacationperiod: type: object allOf: – #/definitions/vacationperiod description: Período de férias vacationdays: type: number format: double description: Dias de férias vacationbonusdays: type: number format: double description: Dias de abono startdate: type: string format: date description: Data de início das férias has13thsalaryadvance: type: boolean description: Tem adiantamento do 13° salário vacationrequestupdate: description: Solicitação de férias type: object required: – vacationperiod – vacationdays – vacationbonusdays – personrequestupdate – has13thsalaryadvance – startdate properties: id: type: string description: Id do solicitação de férias vacationperiod: type: object allOf: – #/definitions/vacationperiod description: Período de férias vacationdays: type: number format: double description: Dias de férias vacationbonusdays: type: number format: double description: Dias de abono personrequestupdate: type: string description: Detalhes da requisição has13thsalaryadvance: type: boolean description: Tem adiantamento do 13º salário startdate: type: string format: date description: Data inicial das férias personrequestupdate: description: Detalhes da requisição type: object required: – requestStatus – dateRequest properties: id: type: string description: Id do Detalhes da requisição requestStatus: type: integer format: int64 description: Status da requisição dateRequest: type: string format: date-time description: Data/hora da requisição companyhierarchy: description: Hierarquia das empresas type: object properties: id: type: string description: id company: type: string description: Empresa notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment