2.0info: 3.65.1 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: api.senior.com.br /hcm/vacationmanagementsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /entities/vacationperiod: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/vacationperiod responses: 200: description: The created resource schema: #/definitions/vacationperiod default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/vacationperiod responses: 200: description: The created resource schema: #/definitions/vacationperiod default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/vacationperiod default: description: Error response schema: #/definitions/genericError /entities/vacationperiod/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationperiod responses: 200: description: Ok schema: #/definitions/vacationperiod default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationperiod responses: 200: description: Ok schema: #/definitions/vacationperiod default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vacationperiod default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/vacationperiod/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/vacationperiod responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/vacationreceipt: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/vacationreceipt responses: 200: description: The created resource schema: #/definitions/vacationreceipt default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/vacationreceipt responses: 200: description: The created resource schema: #/definitions/vacationreceipt default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/vacationreceipt default: description: Error response schema: #/definitions/genericError /entities/vacationreceipt/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationreceipt responses: 200: description: Ok schema: #/definitions/vacationreceipt default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vacationreceipt responses: 200: description: Ok schema: #/definitions/vacationreceipt default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vacationreceipt default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/vacationreceipt/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/vacationreceipt responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/collectivevacationschedule: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/collectivevacationschedule responses: 200: description: The created resource schema: #/definitions/collectivevacationschedule default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/collectivevacationschedule responses: 200: description: The created resource schema: #/definitions/collectivevacationschedule default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/collectivevacationschedule default: description: Error response schema: #/definitions/genericError /entities/collectivevacationschedule/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/collectivevacationschedule responses: 200: description: Ok schema: #/definitions/collectivevacationschedule default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/collectivevacationschedule responses: 200: description: Ok schema: #/definitions/collectivevacationschedule default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/collectivevacationschedule default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/collectivevacationschedule/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/collectivevacationschedule responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/workflowSettings: get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/workflowSettings default: description: Error response schema: #/definitions/genericError /entities/individualvacationschedule: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/individualvacationschedule responses: 200: description: The created resource schema: #/definitions/individualvacationschedule default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/individualvacationschedule responses: 200: description: The created resource schema: #/definitions/individualvacationschedule default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/individualvacationschedule default: description: Error response schema: #/definitions/genericError /entities/individualvacationschedule/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/individualvacationschedule responses: 200: description: Ok schema: #/definitions/individualvacationschedule default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/individualvacationschedule responses: 200: description: Ok schema: #/definitions/individualvacationschedule default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/individualvacationschedule default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/individualvacationschedule/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/individualvacationschedule responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: vacationPeriodSituation: type: string enum: – OPENED – PAID vacationperiod: 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 description: Data inicial format: date enddate: type: string description: Data final format: date situation: #/definitions/vacationPeriodSituation limitdate: type: string description: Data limite format: date leavebalance: type: number description: Saldo de férias format: double individualvacationschedules: type: array items: #/definitions/individualvacationschedule description: Agendamentos de férias vacationrequestupdates: type: array items: #/definitions/vacationrequestupdate description: Solicitações de férias vacationreceipts: type: array items: #/definitions/vacationreceipt description: Recibos de férias individualvacationschedule: type: object required: – vacationperiod – vacationdays – vacationbonusdays – startdate – enddate – has13thsalaryadvance properties: id: type: string description: Id do agendamento de férias vacationperiod: #/definitions/vacationperiod vacationdays: type: number description: Dias de férias format: double vacationbonusdays: type: number description: Dias de abono format: double startdate: type: string description: Data de início das férias format: date enddate: type: string description: Data de fim das férias format: date has13thsalaryadvance: type: boolean description: Tem adiantamento do 13° salário ext: type: string description: Campos customizados vacationrequestupdate: type: object required: – vacationperiod – vacationdays – vacationbonusdays – personrequestupdate – has13thsalaryadvance – startdate properties: id: type: string description: Id do solicitação de férias vacationperiod: #/definitions/vacationperiod vacationdays: type: number description: Dias de férias format: double vacationbonusdays: type: number description: Dias de abono format: double personrequestupdate: #/definitions/personrequestupdate has13thsalaryadvance: type: boolean description: Tem adiantamento do 13º salário startdate: type: string description: Data inicial das férias format: date wantinstallmentofvacationdiscount: type: boolean description: Deseja parcelar o desconto de férias vacationdiscountinstallments: type: number description: Quantidade de parcelas do desconto format: double personrequestupdate: type: object required: – requestStatus – dateRequest properties: id: type: string description: Id do Detalhes da requisição requestStatus: type: integer description: Status da requisição dateRequest: type: string description: Data/hora da requisição format: date-time vacationreceipt: type: object required: – employee – vacationperiod – vacationdays – vacationbonusdays – vacationstart – has13thsalaryadvance – externalId properties: id: type: string description: Id do recibo de férias employee: type: string description: Colaborador vacationperiod: #/definitions/vacationperiod vacationdays: type: number description: Dias de férias format: double vacationbonusdays: type: number description: Dias de abono format: double vacationstart: type: string description: Data de início das férias format: date has13thsalaryadvance: type: boolean description: Tem adiantamento do 13º salário externalId: type: string description: Id referente a g5 collectivevacationschedule: type: object required: – employee – startdate – enddate – vacationdays – vacationbonusdays – workreturndate – vacationpaymentdate – has13thsalaryadvance properties: id: type: string description: Id do agendamento de férias coletivas employee: #/definitions/employee startdate: type: string description: Data de início das férias format: date enddate: type: string description: Data de fim das férias format: date vacationdays: type: number description: Dias de férias format: double vacationbonusdays: type: number description: Dias de abono format: double workreturndate: type: string description: Data de retorno format: date vacationpaymentdate: type: string description: Data de pagamento das férias format: date has13thsalaryadvance: type: boolean description: Tem adiantamento do 13° salário ext: type: string description: Campos customizados employee: type: object required: – employeetype – registernumber – companynumber – department – costcenter – dismissaldate – employer properties: id: type: string description: Id do colaborador employeetype: type: integer description: Tipo de colaborador registernumber: type: integer description: Número de registro companynumber: type: integer description: Número da empresa department: type: string description: Departamento costcenter: type: string description: Centro de Custo dismissaldate: type: string description: Data de demissão format: date person: type: string description: Id da pessoa employer: #/definitions/companyLegacy companyLegacy: type: object required: – id – companyname – code – cnpj – digitalSignature properties: id: type: string description: Id da empresa headquarter: #/definitions/companyLegacy companyname: type: string description: Nome da empresa code: type: integer description: Código da empresa cnpj: type: string description: CNPJ da empresa digitalSignature: type: string description: Assinatura digital do RH workflowSettings: type: object required: – workflowItem – needManagerApproval properties: id: type: string description: ID das configurações do fluxo de trabalho workflowItem: type: integer description: Item do fluxo de trabalho needManagerApproval: type: boolean description: Necessário aprovação do gestor 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