Gestão de Pessoas (hcm)

2.0info: 6.16.0 Cadastros Organizacionais description: HCM – Cadastros organizacionais x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: organization_register contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /hcm/organization_registersecurityDefinitions: 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/cbo2002: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/cbo2002 responses: 200: description: The created resource schema: #/definitions/cbo2002 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/cbo2002 responses: 200: description: The created resource schema: #/definitions/cbo2002 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/cbo2002 default: description: Error response schema: #/definitions/genericError /entities/cbo2002/{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/cbo2002 responses: 200: description: Ok schema: #/definitions/cbo2002 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/cbo2002 responses: 200: description: Ok schema: #/definitions/cbo2002 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/cbo2002 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/cbo2002/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/cbo2002 responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/wageClass: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/wageClass responses: 200: description: The created resource schema: #/definitions/wageClass 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/wageClass responses: 200: description: The created resource schema: #/definitions/wageClass 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/wageClass default: description: Error response schema: #/definitions/genericError /entities/wageClass/{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/wageClass responses: 200: description: Ok schema: #/definitions/wageClass 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/wageClass responses: 200: description: Ok schema: #/definitions/wageClass 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/wageClass 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/wageClass/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/wageClass responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/jobPositionRequirements: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/jobPositionRequirements responses: 200: description: The created resource schema: #/definitions/jobPositionRequirements 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/jobPositionRequirements responses: 200: description: The created resource schema: #/definitions/jobPositionRequirements 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/jobPositionRequirements default: description: Error response schema: #/definitions/genericError /entities/jobPositionRequirements/{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/jobPositionRequirements responses: 200: description: Ok schema: #/definitions/jobPositionRequirements 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/jobPositionRequirements responses: 200: description: Ok schema: #/definitions/jobPositionRequirements 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/jobPositionRequirements 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/jobPositionRequirements/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/jobPositionRequirements responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/company: 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/company default: description: Error response schema: #/definitions/genericError /entities/jobPositionSalaryInfo: 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/jobPositionSalaryInfo default: description: Error response schema: #/definitions/genericError /entities/jobPositionStructure: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/jobPositionStructure responses: 200: description: The created resource schema: #/definitions/jobPositionStructure 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/jobPositionStructure responses: 200: description: The created resource schema: #/definitions/jobPositionStructure 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/jobPositionStructure default: description: Error response schema: #/definitions/genericError /entities/jobPositionStructure/{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/jobPositionStructure responses: 200: description: Ok schema: #/definitions/jobPositionStructure 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/jobPositionStructure responses: 200: description: Ok schema: #/definitions/jobPositionStructure 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/jobPositionStructure 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/jobPositionStructure/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/jobPositionStructure responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/wageScale: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/wageScale responses: 200: description: The created resource schema: #/definitions/wageScale 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/wageScale responses: 200: description: The created resource schema: #/definitions/wageScale 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/wageScale default: description: Error response schema: #/definitions/genericError /entities/wageScale/{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/wageScale responses: 200: description: Ok schema: #/definitions/wageScale 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/wageScale responses: 200: description: Ok schema: #/definitions/wageScale 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/wageScale 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/wageScale/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/wageScale responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/jobPositionDescription: 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/jobPositionDescription default: description: Error response schema: #/definitions/genericError /entities/jobPositionStructureLevel: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/jobPositionStructureLevel responses: 200: description: The created resource schema: #/definitions/jobPositionStructureLevel 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/jobPositionStructureLevel responses: 200: description: The created resource schema: #/definitions/jobPositionStructureLevel 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/jobPositionStructureLevel default: description: Error response schema: #/definitions/genericError /entities/jobPositionStructureLevel/{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/jobPositionStructureLevel responses: 200: description: Ok schema: #/definitions/jobPositionStructureLevel 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/jobPositionStructureLevel responses: 200: description: Ok schema: #/definitions/jobPositionStructureLevel 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/jobPositionStructureLevel 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/jobPositionStructureLevel/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/jobPositionStructureLevel responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/wageLevel: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/wageLevel responses: 200: description: The created resource schema: #/definitions/wageLevel 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/wageLevel responses: 200: description: The created resource schema: #/definitions/wageLevel 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/wageLevel default: description: Error response schema: #/definitions/genericError /entities/wageLevel/{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/wageLevel responses: 200: description: Ok schema: #/definitions/wageLevel 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/wageLevel responses: 200: description: Ok schema: #/definitions/wageLevel 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/wageLevel 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/wageLevel/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/wageLevel responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/cbo: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/cbo responses: 200: description: The created resource schema: #/definitions/cbo 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/cbo responses: 200: description: The created resource schema: #/definitions/cbo 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/cbo default: description: Error response schema: #/definitions/genericError /entities/cbo/{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/cbo responses: 200: description: Ok schema: #/definitions/cbo 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/cbo responses: 200: description: Ok schema: #/definitions/cbo 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/cbo 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/cbo/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/cbo responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/costcenter: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/costcenter responses: 200: description: The created resource schema: #/definitions/costcenter 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/costcenter responses: 200: description: The created resource schema: #/definitions/costcenter 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/costcenter default: description: Error response schema: #/definitions/genericError /entities/costcenter/{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/costcenter responses: 200: description: Ok schema: #/definitions/costcenter 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/costcenter responses: 200: description: Ok schema: #/definitions/costcenter 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/costcenter 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/costcenter/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/costcenter responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/jobPosition: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/jobPosition responses: 200: description: The created resource schema: #/definitions/jobPosition 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/jobPosition responses: 200: description: The created resource schema: #/definitions/jobPosition 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/jobPosition default: description: Error response schema: #/definitions/genericError /entities/jobPosition/{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/jobPosition responses: 200: description: Ok schema: #/definitions/jobPosition 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/jobPosition responses: 200: description: Ok schema: #/definitions/jobPosition 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/jobPosition 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/jobPosition/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/jobPosition responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/othercompany: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/othercompany responses: 200: description: The created resource schema: #/definitions/othercompany 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/othercompany responses: 200: description: The created resource schema: #/definitions/othercompany 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/othercompany default: description: Error response schema: #/definitions/genericError /entities/othercompany/{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/othercompany responses: 200: description: Ok schema: #/definitions/othercompany 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/othercompany responses: 200: description: Ok schema: #/definitions/othercompany 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/othercompany 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/othercompany/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/othercompany responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/jobPositionSalaryPremium: 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/jobPositionSalaryPremium default: description: Error response schema: #/definitions/genericErrordefinitions: complexityType: type: string enum: – LOW – MEDIUM – HIGH decisionType: type: string enum: – YES – NO driverType: type: string enum: – NOT_APPLICABLE – CARGO_DRIVER – PASSENGER_DRIVER wageScaleRevisionType: type: string enum: – EMPTY – EFFECTIVE – SIMULATED currencyType: type: string enum: – REAL – DOLAR – INDEX salaryType: type: string enum: – HOURLY – DAILY – WEEKLY – FORTNIGHTLY – MONTHLY – TAKERS – DYNAMIC – THIRD_PARTY specialRetirement: type: string enum: – DOES_NOT_HAVE_SPECIAL_RETIREMENT – NO_EXPOSURE_TO_HARMFUL_AGENTS_EMPLOYEE_ALREADY_EXPOSED – SPECIAL_RETIREMENT_AT_FIFTEEN_YEARS_OF_SERVICE – SPECIAL_RETIREMENT_AT_TWENTY_YEARS_OF_SERVICE – SPECIAL_RETIREMENT_AT_TWENTY_FIVE_YEARS_OF_SERVICE cumulativeJobpositionType: type: string enum: – NOT_CUMULATIVE – HEALTH_PROFESSIONAL – TEACHER – TECHNICAL_SCIENTIFIC specialTimeCountType: type: string enum: – NONE – TEACHER – PROFESSOR – RISK_ACTIVITY lawSituationType: type: string enum: – CREATION – EXTINCTION – RESTRUCTURING frameworkType: type: string enum: – GENERAL_FRAMEWORK – SPECIFIC_FRAMEWORK – SPECIAL_FRAMEWORK – DOES_NOT_APPLY subscriptionType: type: string enum: – EMPTY – CNPJ – CEI – CPF publicPlaceType: type: string enum: – TYPE_01 – TYPE_02 – TYPE_03 – TYPE_04 – TYPE_05 – TYPE_06 – TYPE_07 – TYPE_08 – TYPE_09 – TYPE_10 – TYPE_11 – TYPE_12 – TYPE_13 – TYPE_14 – TYPE_15 – TYPE_16 – TYPE_17 – TYPE_18 – TYPE_19 – TYPE_20 – TYPE_21 – TYPE_22 – TYPE_23 – TYPE_24 – TYPE_25 – TYPE_26 – TYPE_27 – TYPE_28 – TYPE_29 – TYPE_30 – TYPE_31 – TYPE_32 – TYPE_33 – TYPE_34 – TYPE_35 – TYPE_36 – TYPE_37 – TYPE_38 – TYPE_39 – TYPE_40 – TYPE_41 – TYPE_42 – TYPE_43 – TYPE_44 – TYPE_45 – TYPE_47 – TYPE_48 – TYPE_49 – TYPE_50 – TYPE_51 – TYPE_52 – TYPE_53 – TYPE_54 – TYPE_55 – TYPE_56 – TYPE_57 – TYPE_58 – TYPE_59 – TYPE_60 – TYPE_61 – TYPE_62 – TYPE_63 – TYPE_64 – TYPE_65 – TYPE_66 – TYPE_67 – TYPE_68 – TYPE_69 – TYPE_70 – TYPE_71 – TYPE_72 – TYPE_73 – TYPE_74 – TYPE_75 – TYPE_76 – TYPE_77 – TYPE_78 – TYPE_79 – TYPE_80 – TYPE_81 – TYPE_82 – TYPE_83 – TYPE_84 – TYPE_85 – TYPE_86 – TYPE_87 – TYPE_88 – TYPE_89 – TYPE_90 – TYPE_91 – TYPE_92 – TYPE_93 – TYPE_94 – TYPE_95 – TYPE_96 – TYPE_97 – TYPE_98 – TYPE_99 – TYPE_100 – TYPE_101 – TYPE_102 – TYPE_103 – TYPE_104 – TYPE_105 – TYPE_106 – TYPE_107 – TYPE_108 – TYPE_109 – TYPE_110 – TYPE_111 – TYPE_112 – TYPE_113 – TYPE_114 – TYPE_115 – TYPE_116 – TYPE_117 – TYPE_118 – TYPE_119 – TYPE_120 – TYPE_121 – TYPE_122 – TYPE_123 – TYPE_124 – TYPE_125 – TYPE_126 – TYPE_127 – TYPE_128 – TYPE_129 – TYPE_130 – TYPE_131 – TYPE_132 – TYPE_133 – TYPE_134 – TYPE_135 – TYPE_136 – TYPE_137 – TYPE_138 – TYPE_139 – TYPE_140 – TYPE_141 – TYPE_142 – TYPE_143 – TYPE_144 – TYPE_145 – TYPE_146 – TYPE_147 – TYPE_148 – TYPE_149 – TYPE_150 – TYPE_151 – TYPE_152 – TYPE_153 – TYPE_154 – TYPE_155 – TYPE_156 – TYPE_157 – TYPE_158 – TYPE_159 – TYPE_160 – TYPE_161 – TYPE_162 – TYPE_163 – TYPE_164 – TYPE_165 – TYPE_166 – TYPE_167 – TYPE_168 – TYPE_169 – TYPE_170 – TYPE_171 – TYPE_172 – TYPE_173 – TYPE_174 – TYPE_175 – TYPE_176 – TYPE_177 – TYPE_178 – TYPE_179 – TYPE_180 genderType: type: string enum: – MALE – FEMALE – INDEPENDENT maritalStatus: type: string enum: – SINGLE – MARRIED – DIVORCED – WIDOWER – CONCUBINAGE – SEPARATED – STABLE_UNION – OTHER degreeInstructionType: type: string enum: – Illiterate – ElementarySchoolIncomplete – ElementarySchoolComplete – MiddleSchoolIncomplete – MiddleSchoolComplete – HighSchoolIncomplete – HighSchoolComplete – BachelorIncomplete – BachelorComplete – Postgraduate – Master – Doctoral workShiftType: type: string enum: – FIRST – SECOND – THIRD – FOURTH – MIXED – GENERAL workIndicativeType: type: string enum: – TYPE_01 – TYPE_02 – TYPE_03 – TYPE_04 – TYPE_05 ownerRegistrationType: type: string enum: – CNPJ – CPF usingType: type: string enum: – TYPE_1 – TYPE_2 – TYPE_3 – TYPE_4 – TYPE_6 – TYPE_7 – TYPE_8 – TYPE_9 – TYPE_10 – TYPE_11 – TYPE_12 – TYPE_14 – TYPE_15 – TYPE_16 – TYPE_17 – TYPE_18 – TYPE_19 – TYPE_20 – TYPE_21 – TYPE_13 NifType: type: string enum: – NIF_BENEFICIARY – BENIFICIARY_EXEMPTED_NIF – COUNTRY_NOT_REQUIRE_NIF payerSourceRelationshipType: type: string enum: – TYPE_500 – TYPE_510 – TYPE_520 – TYPE_530 – TYPE_540 – TYPE_550 – TYPE_560 – TYPE_570 – TYPE_900 costcenter: type: object required: – company – name – code properties: id: type: string description: Id do centro de custo company: #/definitions/company name: type: string description: Nome do centro de custo code: type: string description: Código do centro de custo creationDate: type: string description: Data de criação do centro de custo format: date expirationDate: type: string description: Data de extinção do centro de custo format: date gpsCompanyBranch: #/definitions/company accountingBranch: type: integer description: Filial contábil apportionment: #/definitions/apportionment budgetCompanyBranch: #/definitions/company descriptionCode: type: string description: Código Texto C.Custo p/ Exportação externalId: type: string description: Id externo company: type: object required: – code – companyname properties: id: type: string description: Id da empresa code: type: integer description: Código da empresa companyname: type: string description: Nome da empresa headquarter: #/definitions/company apportionment: type: object required: – code – name properties: id: type: string description: Id do rateio code: type: integer description: Código do rateio name: type: string description: Descrição jobPositionStructure: type: object required: – code – name properties: id: type: string description: Id da estrutura de cargos code: type: integer description: Código da estrutura de cargos name: type: string description: Descrição employeeRegistrationLevel: type: integer description: Nível de colaboradores salarySearchLevel: type: integer description: Nível da pesquisa qlLevel: type: integer description: Nível QL exhibitionLevel: type: integer description: Nível de exibição levels: type: array items: #/definitions/jobPositionStructureLevel description: Lista de níveis de estrutura de cargos externalId: type: string description: Id de sistema externo jobPositionStructureLevel: type: object required: – description – positions properties: id: type: string description: Id do nível da estrutura de cargo jobPositionStructure: #/definitions/jobPositionStructure structureLevel: type: integer description: Nível do Cargo description: type: string description: Descrição do nível de cargo positions: type: integer description: Quantidade de posições cbo: type: object required: – code – name properties: id: type: string description: Id do CBO external_id: type: string description: Id de domínio do CBO code: type: string description: Código do CBO name: type: string description: Descrição do CBO jobPositionDescription: type: object properties: id: type: string description: Id da descrição de cargos jobPosition: #/definitions/jobPosition jobPosition: type: object required: – jobPositionStructure – code – shortname – name – jobPositionLevel properties: id: type: string description: Id do cargo jobPositionStructure: #/definitions/jobPositionStructure code: type: string description: Código cargo shortname: type: string description: Título reduzido do cargo name: type: string description: Título do cargo cbo: #/definitions/cbo cbo2002: #/definitions/cbo2002 creationDate: type: string description: Data de criação format: date expirationDate: type: string description: Data de expiração format: date complexity: #/definitions/complexityType bossJobposition: #/definitions/jobPosition commandJobposition: #/definitions/decisionType hierarchyOffice: #/definitions/hierarchyoffice expenseNature: #/definitions/expenseNature occupationArea: #/definitions/occupationarea additionalPercentageFunction: type: number description: Percentual adicional de função format: double driverType: #/definitions/driverType requiredDriversLicense: #/definitions/decisionType requiredProfessionalCouncil: #/definitions/decisionType professionalBoardAcronym: #/definitions/professionalBoardAcronym summaryDescription: type: string description: Descrição sumária jobPositionLevel: type: integer description: Nível do cargo jobPositionSalaryInfoRevisions: type: array items: #/definitions/jobPositionSalaryInfo description: Informações salariais jobPositionSalaryPremiumRevisions: type: array items: #/definitions/jobPositionSalaryPremium description: Adicionais salariais jobPositionPublicBodyRevisions: type: array items: #/definitions/jobPositionPublicBody description: Órgão Público jobPositionDescriptions: type: array items: #/definitions/jobPositionDescription description: Descrição do Cargo jobPositionAttachments: type: array items: #/definitions/jobPositionAttachment description: Anexos externalId: type: string description: Id externo do cargo cbo2002: type: object required: – code – name properties: id: type: string description: Id do CBO 2002 externalId: type: string description: Id externo do CBO 2002 code: type: string description: CBO 2002 name: type: string description: Descrição hierarchyoffice: type: object required: – name properties: id: type: string description: Identificador. externalId: type: string description: Id Externo code: type: string description: Hierarquia name: type: string description: Descrição da Hierarquia expenseNature: type: object required: – code – name properties: id: type: string description: Identificador. code: type: integer description: Código da Natureza de Despesa. name: type: string description: Descrição da Natureza de Despesa. occupationarea: type: object required: – name properties: id: type: string description: Id da Área de Atuação code: type: integer description: Código da Área de Atuação externalId: type: string description: Id externo da área de atuação name: type: string description: Descrição da Área de Atuação professionalBoardAcronym: type: object required: – code – name properties: id: type: string description: Identificador. code: type: string description: Código da Sigla Conselho Profissional. name: type: string description: Descrição Sigla Conselho Profissional. jobPositionSalaryInfo: type: object required: – startdate – startDate – salaryType properties: id: type: string description: Identificador único da entidade jobPosition: #/definitions/jobPosition startdate: type: string description: Data de início (Com timezone) format: date-time startDate: type: string description: Data de início (Sem timezone) format: date-time wageScale: #/definitions/wageScale nameWageClassStart: type: string description: Descrição da classe inicial nameWageClassEnd: type: string description: Descrição da classe final wageLevelStart: #/definitions/wageLevel wageLevelEnd: #/definitions/wageLevel nameWageLevelStart: type: string description: Descrição da faixa inicial nameWageLevelEnd: type: string description: Descrição da faixa final salaryType: #/definitions/salaryType score: type: integer description: Quantidade de pontos wageScale: type: object properties: id: type: string description: Identificador único da classe da estrutura salarial name: type: string description: Nome da estrutura salarial wageLevel: type: object required: – name – sequence – initialsalaryCrypto – currency properties: id: type: string description: Identificador único do nível da tabela salarial name: type: string description: Nome do nível wageClass: #/definitions/wageClass sequence: type: integer description: Sequência initialsalaryCrypto: type: string description: Salário do nível. (Criptografado) currency: #/definitions/currencyType wageClass: type: object required: – sequence properties: id: type: string description: Identificador único da classe da tabela salarial name: type: string description: Nome da classe wageScaleRevision: #/definitions/wageScaleRevision sequence: type: integer description: Sequência wageScaleRevision: type: object properties: id: type: string description: Identificador da revisão de estrutura salarial startDate: type: string description: Data de início da revisão format: date endDate: type: string description: Data de término da revisão format: date wageScale: #/definitions/wageScale reason: type: string description: Motivo da revisão type: #/definitions/wageScaleRevisionType jobPositionSalaryPremium: type: object required: – startDate – company – insalubrityPercentage – hazardPercentage – factorServiceTimeMen – factorServiceTimeWoman – specialRetirement properties: id: type: string description: Identificador único da entidade jobPosition: #/definitions/jobPosition startDate: type: string description: Data de alteração format: date company: #/definitions/company insalubrityPercentage: type: number description: Porcentagem de insalubridade format: double hazardPercentage: type: number description: Porcentagem de periculosidade format: double factorServiceTimeMen: type: number description: Fator de tempo de serviço – Homens format: double factorServiceTimeWoman: type: number description: Fator de tempo de serviço – Mulheres format: double specialRetirement: #/definitions/specialRetirement endDate: type: string description: Competencia Término format: date jobPositionPublicBody: type: object required: – startdate properties: id: type: string description: Identificador único da entidade jobPosition: #/definitions/jobPosition startdate: type: string description: Data de alteração format: date cumulativeJobposition: #/definitions/cumulativeJobpositionType specialTimeCount: #/definitions/specialTimeCountType exclusiveDedication: #/definitions/decisionType lawNumber: type: string description: Número da lei para o cargo lawDate: type: string description: Data da lei format: date lawSituation: #/definitions/lawSituationType framework: #/definitions/frameworkType externalId: type: string description: Id de sistema externo jobPositionAttachment: type: object required: – sequence – attachmentId – attachmentSize properties: id: type: string description: Identificador único da entidade jobPosition: #/definitions/jobPosition sequence: type: integer description: Sequência de inclusão dos anexos attachmentId: type: string description: Identificador do arquivo no servidor de armazenamento attachmentSize: type: integer description: Tamanho do arquivo othercompany: type: object required: – name – pulicCompany – considerSefip properties: id: type: string description: Id da empresa code: type: integer description: Código outra empresa name: type: string description: Nome da outra empresa nickname: type: string description: Apelido subscriptionType: #/definitions/subscriptionType subscriptionNumber: type: number description: Número da inscrição format: double subscriptionNumberCNO: type: number description: CNO format: double subscriptionNumberCAEPF: type: number description: CAEPF format: double stateSubscription: type: string description: Inscrição estadual country: #/definitions/country state: #/definitions/state cep: type: string description: CEP city: #/definitions/city neighborhood: #/definitions/neighborhood addressType: #/definitions/publicPlaceType address: type: string description: Endereço addressnumber: type: integer description: Número complement: type: string description: Complemento countrycode: type: integer description: Código do país (DDI) localcode: type: integer description: Código da localidade (DDD) contactNumber: type: string description: Telefone ramal: type: string description: Ramal homePage: type: string description: Home page email: type: string description: Email pulicCompany: #/definitions/decisionType considerSefip: #/definitions/decisionType gpsBase: type: number description: % Base GPS Cooperativa Saúde format: double ansRegister: type: integer description: Registro ANS retentionBaseInss: type: number description: % Base retenção INSS nota fiscal format: double retentionInss: type: number description: % Retenção INSS nota fiscal format: double activityfield: #/definitions/activityfield cnae: type: integer description: CNAE providerCode: type: integer description: Código fornecedor workIndicative: #/definitions/workIndicativeType startDate: type: string description: Data início validade format: date endDate: type: string description: Data fim validade format: date ownerRegistrationTypeCno: #/definitions/ownerRegistrationType ownerRegistrationNumber: type: string description: Número inscrição proprietário contractorRegistrationType: #/definitions/ownerRegistrationType contractorRegistrationNumber: type: string description: Número inscrição contratante otherCompanyUsingType: type: array items: #/definitions/otherCompanyUsingType description: Lista Outra empresa – Tipo de Uso dataAbroadOtherCompany: type: array items: #/definitions/dataAbroadOtherCompany description: Lista dado no exterior country: type: object required: – code – name properties: id: type: string description: Id do país code: type: integer description: Código do País name: type: string description: Nome do país abbreviation: type: string description: Abreviação do nome do país staties: type: array items: #/definitions/state description: Estados state: type: object required: – name properties: id: type: string description: Id do estado name: type: string description: Nome do Estado abbreviation: type: string description: Abreviação do nome do Estado cities: type: array items: #/definitions/city description: Cidades countryId: #/definitions/country city: type: object required: – code – name properties: id: type: string description: Id da cidade code: type: integer description: Código da cidade name: type: string description: Nome da cidade stateId: #/definitions/state neighborhood: type: array items: #/definitions/neighborhood description: Bairros neighborhood: type: object required: – code – name – cep properties: id: type: string description: Id do bairro code: type: integer description: Código do bairro name: type: string description: Nome do bairro city: #/definitions/city cep: type: string description: CEP activityfield: type: object required: – name properties: id: type: string description: Id do ramo de atuação externalId: type: string description: Id externo do ramo de atuação code: type: integer description: Ramo de Atuação name: type: string description: Descrição jobPositionRequirements: type: array items: #/definitions/jobPositionRequirements description: Requisitos de cargo jobPositionRequirements: type: object required: – jobposition – startdate properties: id: type: string description: Id jobposition: #/definitions/jobPosition startdate: type: string description: Data requisito format: date minweight: type: number description: Peso mínimo format: double maxweight: type: number description: Peso máximo format: double minheight: type: integer description: Altura mínima maxheight: type: integer description: Altura máxima minage: type: integer description: Idade mínima maxage: type: integer description: Idade máxima gender: #/definitions/genderType maritalstatus: type: array items: #/definitions/maritalStatus description: Estado Civil educationdegree: type: array items: #/definitions/educationdegree description: Grau instrução qualification: type: array items: #/definitions/qualification description: Qualificação workshift: type: array items: #/definitions/workShiftType description: Turno administrativeregion: type: array items: #/definitions/administrativeregion description: Região administrativa activityfield: type: array items: #/definitions/activityfield description: Ramo de atuação keywords: type: string description: Palavras-chave educationdegree: type: object required: – code – name – nameRais properties: id: type: string description: Id do grau de instrução code: type: integer description: Código do grau de instrução name: type: string description: Descrição do grau de instrução nameRais: #/definitions/degreeInstructionType jobPositionRequirements: type: array items: #/definitions/jobPositionRequirements description: Requisitos do Cargo qualification: type: object required: – description properties: id: type: string description: Id da qualificação externalId: type: string description: Id externo da qualificação code: type: integer description: Código da qualificação description: type: string description: Descrição detalhada da qualificação name: type: string description: Descrição reduzida da qualificação jobPositionRequirements: type: array items: #/definitions/jobPositionRequirements description: Requisitos do Cargo administrativeregion: type: object required: – code – city – name properties: id: type: string description: Id da região administrativa code: type: integer description: Código da região city: #/definitions/city name: type: string description: Nome da região administrativa jobPositionRequirements: type: array items: #/definitions/jobPositionRequirements description: Requisitos do Cargo otherCompanyUsingType: type: object required: – usingType properties: id: type: string description: Id da outra empresa – tipo de uso otherCompany: #/definitions/othercompany usingType: #/definitions/usingType dataAbroadOtherCompany: type: object required: – startDate – NifType – country properties: id: type: string description: Id da outra empresa – dado no exterior othercompany: #/definitions/othercompany startDate: type: string description: Data início format: date NifType: #/definitions/NifType foreignNIF: type: string description: NIF Exterior payerSourceRelationshipType: #/definitions/payerSourceRelationshipType country: #/definitions/country state: type: string description: Estado/Província city: type: string description: Cidade neighborhood: type: string description: Bairro/Distrito postalCode: type: string description: Código postal address: type: string description: Endereço number: type: string description: Número complement: type: string description: Complemento telephone: type: string description: Telefone finalDate: type: string description: Data final format: date 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