Gestão de Pessoas (hcm)

2.0info: 7.13.0 Dependentes description: HCM – Gestão de dependentes x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: dependent contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /hcm/dependentsecurityDefinitions: 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: /dependentQuery: post: description: Retorna as informações do dependente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dependentId properties: dependentId: type: string description: Id do dependente responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/dependentQueryData default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do dependente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dependentId properties: dependentId: type: string description: Id do dependente responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/dependentQueryData default: description: Error response schema: #/definitions/genericError /entities/familySalary: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/familySalary responses: 200: description: The created resource schema: #/definitions/familySalary 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/familySalary responses: 200: description: The created resource schema: #/definitions/familySalary 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/familySalary default: description: Error response schema: #/definitions/genericError /entities/familySalary/{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/familySalary responses: 200: description: Ok schema: #/definitions/familySalary 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/familySalary responses: 200: description: Ok schema: #/definitions/familySalary 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/familySalary 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/familySalary/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/familySalary responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/childcareAssistance: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/childcareAssistance responses: 200: description: The created resource schema: #/definitions/childcareAssistance 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/childcareAssistance responses: 200: description: The created resource schema: #/definitions/childcareAssistance 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/childcareAssistance default: description: Error response schema: #/definitions/genericError /entities/childcareAssistance/{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/childcareAssistance responses: 200: description: Ok schema: #/definitions/childcareAssistance 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/childcareAssistance responses: 200: description: Ok schema: #/definitions/childcareAssistance 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/childcareAssistance 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/childcareAssistance/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/childcareAssistance responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/dependentIncomeTax: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dependentIncomeTax responses: 200: description: The created resource schema: #/definitions/dependentIncomeTax 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/dependentIncomeTax responses: 200: description: The created resource schema: #/definitions/dependentIncomeTax 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/dependentIncomeTax default: description: Error response schema: #/definitions/genericError /entities/dependentIncomeTax/{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/dependentIncomeTax responses: 200: description: Ok schema: #/definitions/dependentIncomeTax 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/dependentIncomeTax responses: 200: description: Ok schema: #/definitions/dependentIncomeTax 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/dependentIncomeTax 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/dependentIncomeTax/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/dependentIncomeTax responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/tutelage: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/tutelage responses: 200: description: The created resource schema: #/definitions/tutelage 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/tutelage responses: 200: description: The created resource schema: #/definitions/tutelage 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/tutelage default: description: Error response schema: #/definitions/genericError /entities/tutelage/{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/tutelage responses: 200: description: Ok schema: #/definitions/tutelage 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/tutelage responses: 200: description: Ok schema: #/definitions/tutelage 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/tutelage 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/tutelage/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/tutelage responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/familySalaryDocument: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/familySalaryDocument responses: 200: description: The created resource schema: #/definitions/familySalaryDocument 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/familySalaryDocument responses: 200: description: The created resource schema: #/definitions/familySalaryDocument 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/familySalaryDocument default: description: Error response schema: #/definitions/genericError /entities/familySalaryDocument/{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/familySalaryDocument responses: 200: description: Ok schema: #/definitions/familySalaryDocument 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/familySalaryDocument responses: 200: description: Ok schema: #/definitions/familySalaryDocument 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/familySalaryDocument 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/familySalaryDocument/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/familySalaryDocument responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/dependent: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dependent responses: 200: description: The created resource schema: #/definitions/dependent 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/dependent responses: 200: description: The created resource schema: #/definitions/dependent 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/dependent default: description: Error response schema: #/definitions/genericError /entities/dependent/{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/dependent responses: 200: description: Ok schema: #/definitions/dependent 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/dependent responses: 200: description: Ok schema: #/definitions/dependent 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/dependent 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/dependent/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/dependent responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/dependentHealthInsurance: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dependentHealthInsurance responses: 200: description: The created resource schema: #/definitions/dependentHealthInsurance 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/dependentHealthInsurance responses: 200: description: The created resource schema: #/definitions/dependentHealthInsurance 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/dependentHealthInsurance default: description: Error response schema: #/definitions/genericError /entities/dependentHealthInsurance/{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/dependentHealthInsurance responses: 200: description: Ok schema: #/definitions/dependentHealthInsurance 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/dependentHealthInsurance responses: 200: description: Ok schema: #/definitions/dependentHealthInsurance 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/dependentHealthInsurance 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/dependentHealthInsurance/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/dependentHealthInsurance responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/judicialPension: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/judicialPension responses: 200: description: The created resource schema: #/definitions/judicialPension 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/judicialPension responses: 200: description: The created resource schema: #/definitions/judicialPension 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/judicialPension default: description: Error response schema: #/definitions/genericError /entities/judicialPension/{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/judicialPension responses: 200: description: Ok schema: #/definitions/judicialPension 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/judicialPension responses: 200: description: Ok schema: #/definitions/judicialPension 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/judicialPension 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/judicialPension/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/judicialPension responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: employeeType: type: string enum: – NULL – EMPLOYEE – THIRD – PARTNER actionType: type: string enum: – SAVE – EDIT – DELETE genderType: type: string enum: – Male – Female kinshipDegreeType: type: string enum: – Adopted – Child – Concubine – ExSpouse – ExPartner – Grandparent – Grandchild – GreatGrandparent – GreatGrandchild – Guardianship – NephewNiece – Other – Parent – FatherInLaw – Partner – Pensioners – Pupil – Sibling – SonDaughterInLaw – Spouse – Stepfather – Stepmother – Stepchild – Trusted – UncleAunt – Tutor eSocialDependentType: type: string enum: – DontTakeDependent – Spouse – Partner – SonStepson – SonStepsonStudent – SiblingGrandsonGreat – SiblingGrandsonGreatStudent – ParentsGrandparentsGreat – PoorMinor – IncapablePerson – ExSpouse – AggregateOthers – DontSendType maritalStatusType: type: string enum: – Single – Married – Divorced – Widower – Concubinage – Separated – StableUnion – Others degreeInstructionType: type: string enum: – Illiterate – ElementarySchoolIncomplete – ElementarySchoolComplete – MiddleSchoolIncomplete – MiddleSchoolComplete – HighSchoolIncomplete – HighSchoolComplete – BachelorIncomplete – BachelorComplete – Postgraduate – Master – Doctoral subscriptionType: type: string enum: – CNPJ – CEI – CPF – INCRA schoolGradeType: type: string enum: – TYPE_1 – TYPE_2 – TYPE_3 – TYPE_4 – TYPE_5 – TYPE_6 – TYPE_7 – TYPE_8 – TYPE_9 – TYPE_10 – TYPE_11 – TYPE_12 – TYPE_13 – TYPE_14 – TYPE_15 – TYPE_16 – TYPE_17 methodPaymentType: type: string enum: – BANK_CHECK – MONEY – MONEY_ORDER – BANKING_RELATIONSHIP – PIX – EXTERNAL addressType: type: string enum: – Others – Airport – Lane – Area – Avenue – Balneary – Block – Field – Farmstead – Cologne – Condominium – Set – District – Terrace – Season – Road – ShantyTown – Farm – Market – Gallery – Granja – Garden – Slope – Lake – Lagoon – Long – Allotment – Hill – Core – Park – Footbridge – Courtyard – Square – Beach – Court – Nook – Residential – Highway – Street – Sector – Site – Bystreet – Excerpt – Clover – Valley – Path – Via – Viaduct – Alley – Village – Access – Camp – LocalAccess – Churchyard – SpecialArea – RightMarginalAvenue – LeftMarginalAvenue – RingRoad – LaterRoadBetween – Artery – High – Shortcut – GreenArea – ContourAvenue – MarginalAvenue – OldAvenue – Alleyway – Hole – Belvedere – Balloon – Blocks – Bulevar – Forest – Boulevard – Low – Pier – Sidewalk – Way – Channel – Chapadao – BicyclePath – CircularRoad – HousingComplex – RoadComplex – Community – Hall – Stream – Contour – Descent – Detour – BetweenBlock – IntermunicipalRoad – Cove – PrivateEntrance – BetweenQuarter – Ladder – Staircase – StateHighway – VicinalRoad – RoadConnection – MunicipalRoad – RoadToSerfdom – OldRoad – LaterRoad – Stadium – Office – PrivateRoad – Parking – Evangelical – Lofty – IndustrialAxis – Railroad – Source – Strong – HousingNucleus – Island – Undetermined – Islet – Window – Lot – Marketplace – Marina – Module – Projection – Mount – RuralNucleus – Knoll – Parallel – Tour – SportsSquare – Stop – RestArea – Tip – Prolonging – CityPark – ResidentialPark – Passage – PedestrianWalkway – UndergroundPassage – Bridge – Port – Fifth – Farms – IntegrationStreet – LinkStreet – PrivateStreet – OldStreet – Branch – Playground – Retreat – Straight – SideStreet – Ramp – RodoRing – Kneecap – PedestrianStreet – Margin – Return – Roundabout – SecondAvenue – Bondage – Uploading – Trench – Terminal – Tunnel – PrivateBystreet – OldBystreet – Unity – CollectorRoad – LocalWay – AccessWay – Ditch – CoastalWay – Expressway – HighRoad – CoastalRoad – Walkway – Variant – Zigzag phoneType: type: string enum: – PERSONAL – PROFESSIONAL – MOBILE – BUSINESS_FAX – PERSONAL_FAX – OTHER accountType: type: string enum: – CURRENT_ACCOUNT – SAVING_ACCOUNT – SALARY_ACCOUNT – OTHER baseCalculationType: type: string enum: – FIXED – VARIABLE salary13Type: type: string enum: – YES – NO – PARTIAL salaryAdvancedType: type: string enum: – YES – NO – PERCENTAGE decisionType: type: string enum: – YES – NO informationType: type: string enum: – CUMULATIVE – PERCENTAGE – FIXED_PERCENTEGE – DAILY_VALUE – MONTHLY_VALUE indexType: type: string enum: – OTHER – UFIR – URV – ITRD – SELIC – CONTRIBUTION_SALARY_CORRECTION – SAVINGS_CORRECTION – CURRENCY fgtsPensionType: type: string enum: – NOT_APPLICABLE – VALUE – PERCENTAGE pixKeyType: type: string enum: – TELEPHONE – EMAIL – CPF – CNPJ – RANDOM_KEY – BANK_ACCOUNT dependentQueryData: type: object required: – ok – dependentPersonaData – dependentDocumentData – dependentControlsData properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta message: type: string description: Mensagem de retorno dependentPersonaData: #/definitions/dependentPersonaData dependentDocumentData: #/definitions/dependentDocumentData dependentControlsData: #/definitions/dependentControlsData dependentPersonaData: type: object required: – employeeId – name – degreeOfKinship – eSocialDependentType properties: attachment: #/definitions/fileUploadedData employeeId: #/definitions/employee dependentId: type: string description: Id do dependente name: type: string description: Nome gender: #/definitions/autocompleteEnumData degreeOfKinship: #/definitions/autocompleteEnumData eSocialDependentType: #/definitions/autocompleteEnumData motherName: type: string description: Nome da mae birthday: type: string description: Data de nascimento da pessoa format: date maritalStatus: #/definitions/autocompleteEnumData degreeOfEducation: #/definitions/autocompleteData cityOfBirth: #/definitions/autocompleteData stateOfBirth: #/definitions/autocompleteData countryOfBirth: #/definitions/autocompleteData customFieldsDependent: type: array items: #/definitions/customData description: Campos do usuário da entidade person disabilityDate: type: string description: Data da invalidez format: date fileUploadedData: type: object properties: attachmentId: type: string description: Id do anexo na base de dados fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por / type: string description: Versão do arquivo thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto, e que deve ser criada a foto e seu Thumbnail(128X128px) permanentUrl: type: string description: Url do arquivo permanente employee: type: object properties: id: type: string description: Id do colaborador companynumber: type: integer description: Empresa do colaborador: NUMEMP employeetype: #/definitions/employeeType registernumber: type: integer description: Código do colaborador: NUMCAD person: #/definitions/person employer: #/definitions/company hiredate: type: string description: Data de admissão format: date person: type: object required: – firstname – lastname properties: id: type: string description: Id da pessoa firstname: type: string description: Primeiro nome middlename: type: string description: Segundo nome lastname: type: string description: Último nome attachment: type: string description: Id do upload da foto da g7 company: type: object required: – cnpj – companyname properties: id: type: string description: Id da entidade. code: type: integer description: Código da empresa. cnpj: type: string description: Cnpj da empresa. companyname: type: string description: Nome da empresa. headquarter: type: string description: Relacionamento com a sede da empresa autocompleteEnumData: type: object required: – key properties: key: type: string description: Chave do enum value: type: string description: Valor do enum autocompleteData: type: object required: – tableId properties: tableId: type: string description: Id da tabela name: type: string description: Descrição da tabela customData: type: object required: – field properties: value: type: string description: Valor do campo field: type: string description: Nome do campo label: type: string description: Label do campo type: type: string description: Tipo do campo regex: type: string description: Regex de validação tooltip: type: string description: Tooltip do campo mask: type: string description: Máscara do campo dependentDocumentData: type: object properties: dependentCpfDocumentsGroup: #/definitions/dependentCpfDocumentsGroup dependentIdentityRegistryDocumentsGroup: #/definitions/dependentIdentityRegistryDocumentsGroup dependentNationalHealthDocumentsGroup: #/definitions/dependentNationalHealthDocumentsGroup dependentRgNumberDocumentsGroup: #/definitions/dependentRgNumberDocumentsGroup dependentCivilCertificateDocumentsGroup: #/definitions/dependentCivilCertificateDocumentsGroup dependentDeathCertificateDocumentsGroup: #/definitions/dependentDeathCertificateDocumentsGroup dependentCpfDocumentsGroup: type: object properties: cpfNumber: type: string description: CPF da pessoa dependentIdentityRegistryDocumentsGroup: type: object properties: civilianIdentityRegistry: type: string description: Registro de identidade civil dependentNationalHealthDocumentsGroup: type: object properties: nationalHealthCard: type: string description: Cartão nacional de saúde dependentRgNumberDocumentsGroup: type: object properties: rgNumberEmissionDate: type: string description: Data de emissão format: date rgNumberState: #/definitions/autocompleteData rgNumberIssuer: type: string description: Orgão emissor rgNumber: type: string description: Número do rg dependentCivilCertificateDocumentsGroup: type: object properties: civilCertificate: #/definitions/autocompleteEnumData civilCertificateRegistry: type: string description: Matrícula do certidão civil civilCertificateTerm: type: string description: Termo da certidão civil declarationOfLiveBirth: type: string description: Declaração de nascido vivo civilCertificateNotaryOffice: type: string description: Cartório da certidão civil civilCertificatePage: type: string description: Folha da certidão civil civilCertificateBook: type: string description: Livro do certidão civil dependentDeathCertificateDocumentsGroup: type: object properties: deathDate: type: string description: Data do óbito format: date deathCertificateRegistry: type: string description: Número da certidão de óbito deathCertificateTerm: type: string description: Termo da certidão de óbito dependentControlsData: type: object properties: tutelageGroup: #/definitions/tutelageData childcareAssistanceGroup: #/definitions/childcareAssistanceData familySalaryGroup: #/definitions/familySalaryData familySalaryDocumentGroup: #/definitions/familySalaryDocumentData isIncomeTaxRequired: type: boolean description: Se o dependente deve ter os campos obrigatários do imposto de renda preenchidos dependentIncomeTaxGroup: #/definitions/dependentIncomeTaxData dependentHealthInsuranceGroup: #/definitions/dependentHealthInsuranceData tutelageData: type: object properties: id: type: string description: Id do tutelado startDate: type: string description: Data de inicio da tutela format: date endDate: type: string description: Data final da tutela format: date childcareAssistanceData: type: object properties: id: type: string description: Id do auxílio creche childcareAssistance: type: boolean description: Se tem auxílio creche months: type: integer description: Meses familySalaryData: type: object properties: id: type: string description: Id do salário familia ageLimitSalaryFamily: type: integer description: Idade limite do salário familia certificateSubmission: type: string description: Data de entrega da certidão format: date printedNotice: type: boolean description: Aviso impresso familySalaryDocument: type: array items: #/definitions/familySalaryDocumentData description: Documentos do salário familia familySalaryDocumentData: type: object required: – referenceYear – actionType properties: id: type: string description: Id da entidade referenceYear: type: integer description: Ano de referência school: #/definitions/autocompleteData scholarship: type: boolean description: É bolsista? schoolGrade: #/definitions/autocompleteEnumData frequencyInMay: type: string description: Frequência em maio format: date percentageInMay: type: number description: Percentual em maio format: double frequencyInNovember: type: string description: Frequência em novembro format: date percentageInNovember: type: number description: Percentual em novembro format: double vaccination: type: string description: Vacinação format: date actionType: #/definitions/actionType dependentIncomeTaxData: type: object properties: id: type: string description: Id da entidade ageLimitIncomeTax: type: integer description: Idade limite imposto de renda beginCompetence: type: string description: Inicio da competência format: date endCompetence: type: string description: Fim da competência format: date dependentHealthInsuranceData: type: object properties: id: type: string description: Id da entidade registration: type: integer description: Matrícula startDate: type: string description: Data da inclusão format: date endDate: type: string description: Data da exclusão format: date dependent: type: object required: – employee – fullname – isaccountedforirrf – iseligibletoalimony – iseligibletofamilyallowence – type – eSocialDependentType – birthcertificate – cpf – rg – deathcertificate – deathdate – maritalstatus – educationdegree – mothersname – livebirthdeclaration – agelimitir – agelimitfamilysalary – nameNotary – bookNumber – sheetNumber – registerNumber properties: id: type: string description: Id do dependente birthdate: type: string description: Data de nascimento format: date employee: #/definitions/employee fullname: type: string description: Nome completo gender: #/definitions/genderType isaccountedforirrf: type: boolean description: Representa se o dependente é contabilizado no IRRF iseligibletoalimony: type: boolean description: Representa se o dependente é elegível a pensão alimentícia iseligibletofamilyallowence: type: boolean description: Representa se o dependente é elegível para subsídio familiar (Salário família) type: #/definitions/kinshipDegreeType eSocialDependentType: #/definitions/eSocialDependentType birthcertificate: type: string description: Certidão de nascimento cpf: type: string description: CPF rg: type: string description: RG deathcertificate: type: string description: Certidão de óbito deathdate: type: string description: Data de óbito format: date maritalstatus: #/definitions/maritalStatusType educationdegree: #/definitions/educationdegree mothersname: type: string description: Nome da mãe placeofbirth: #/definitions/city livebirthdeclaration: type: string description: Declaração de nascimento agelimitir: type: integer description: Limite de idade para IR agelimitfamilysalary: type: integer description: Limite de idade para pensão familiar nameNotary: type: string description: Nome do cartório bookNumber: type: string description: Número do livro sheetNumber: type: string description: Número da folha registerNumber: type: string description: Número do registro attachment: #/definitions/attachment disabilityDate: type: string description: Data da invalidez format: date educationdegree: type: object 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: Nome do grau de instrução nameRais: #/definitions/degreeInstructionType city: type: object required: – name properties: id: type: string description: Id da cidade name: type: string description: Nome da cidade stateId: #/definitions/state state: type: object 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 countryId: #/definitions/country country: type: object properties: id: type: string description: Id do país name: type: string description: Nome do país abbreviation: type: string description: Abreviação do nome do país attachment: type: object required: – id – name properties: id: type: string description: Identificador name: type: string description: Nome do arquivo type: string description: Versão do arquivo temporário permanentUrl: type: string description: Caminho permanente do arquivo person: type: string description: Pessoa sourceId: type: string description: Identificador do anexo sourceType: type: string description: Tipo do anexo createdat: type: string description: Data de criação format: date updatedat: type: string description: Data de alteração format: date status: type: integer description: Status tutelage: type: object required: – startDate – endDate – dependent properties: id: type: string description: Id do tutelado startDate: type: string description: Data de inicio da tutela format: date endDate: type: string description: Data final da tutela format: date dependent: #/definitions/dependent childcareAssistance: type: object required: – childcareAssistance – months – dependent properties: id: type: string description: Id do auxílio creche childcareAssistance: type: boolean description: Se tem auxílio creche months: type: integer description: Meses dependent: #/definitions/dependent familySalary: type: object required: – ageLimitSalaryFamily – certificateSubmission – printedNotice – dependent properties: id: type: string description: Id do salário familia ageLimitSalaryFamily: type: integer description: Idade limite do salário familia certificateSubmission: type: string description: Data de entrega da certidão format: date printedNotice: type: boolean description: Aviso impresso dependent: #/definitions/dependent externalId: type: string description: Identificador Externo familySalaryDocument: type: object required: – referenceYear – school – scholarship – schoolGrade – frequencyInMay – percentageInMay – frequencyInNovember – percentageInNovember – vaccination – dependent properties: id: type: string description: Id da entidade referenceYear: type: integer description: Ano de referência school: #/definitions/othercompany scholarship: type: boolean description: É bolsista? schoolGrade: #/definitions/schoolGradeType frequencyInMay: type: string description: Frequência em maio format: date percentageInMay: type: number description: Percentual em maio format: double frequencyInNovember: type: string description: Frequência em novembro format: date percentageInNovember: type: number description: Percentual em novembro format: double vaccination: type: string description: Vacinação format: date dependent: #/definitions/dependent othercompany: type: object required: – name – nickname – subscriptionType – subscriptionNumber – subscriptionNumberCNO – subscriptionNumberCAEPF – startDate – endDate properties: id: type: string description: Id da outra empresa name: type: string description: Nome da outra empresa nickname: type: string description: Apelido da outra empresa subscriptionType: #/definitions/subscriptionType subscriptionNumber: type: integer description: Número da inscrição subscriptionNumberCNO: type: integer description: Número inscrição CNO subscriptionNumberCAEPF: type: integer description: Inscrição no CAEPF (número) startDate: type: string description: Data de inicio da validade format: date endDate: type: string description: Data fim da validade format: date dependentIncomeTax: type: object required: – beginCompetence – endCompetence – dependent properties: id: type: string description: Id da entidade ageLimitIncomeTax: type: integer description: Idade limite imposto de renda beginCompetence: type: string description: Inicio da competência format: date endCompetence: type: string description: Fim da competência format: date dependent: #/definitions/dependent externalId: type: string description: Id externo G5 dependentHealthInsurance: type: object required: – registration – startDate – endDate – dependent properties: id: type: string description: Id da entidade registration: type: integer description: Matrícula startDate: type: string description: Data da inclusão format: date endDate: type: string description: Data da exclusão format: date dependent: #/definitions/dependent judicialPension: type: object required: – dependent – startDate – methodPaymentType – baseCalculationType properties: id: type: string description: Id da entidade dependent: #/definitions/dependent startDate: type: string description: Data de inicio format: date endDate: type: string description: Data de encerramento format: date sequence: type: integer description: Sequência do cadastro methodPaymentType: #/definitions/methodPaymentType address: #/definitions/address phone: type: array items: #/definitions/phone description: Telefones de contato bankAccount: #/definitions/bankAccount judicialDistrict: #/definitions/city bookAccount: type: string description: Conta contábil familySalaryQuota: type: integer description: Cota salário família baseCalculationType: #/definitions/baseCalculationType fixedJudicialValue: #/definitions/fixedJudicialValue variableJudicialValue: #/definitions/variableJudicialValue pixKeyType: #/definitions/pixKeyType pixKey: type: string description: Chave Pix address: type: object required: – addresstype – neighborhoodId – address – number properties: id: type: string description: Id da entidade cityId: #/definitions/city addresstype: #/definitions/addressType postalcode: type: string description: Código postal do endereço (CEP) neighborhoodId: #/definitions/neighborhood address: type: string description: Endereço. number: type: string description: Número do endereço. additional: type: string description: Informação adicional referente ao endereço. neighborhood: type: object required: – code – name 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 phone: type: object required: – phoneType – internationalCode – localCode – number properties: id: type: string description: Id da entidade phoneType: #/definitions/phoneType internationalCode: type: string description: Código do país (DDI) localCode: type: string description: Código da localidade (DDD) number: type: string description: Número do telefone extention: type: string description: Ramal do telefone bankAccount: type: object required: – bank – bankBranch – accountType – bankAccount properties: id: type: string description: Id da entidade bank: #/definitions/bank bankBranch: #/definitions/bankBranch accountType: #/definitions/accountType bankAccount: type: string description: Conta bancária. digit: type: string description: Digito da conta bank: type: object required: – code – name properties: id: type: string description: Id do banco code: type: integer description: Número do banco name: type: string description: Descrição bankBranch: type: object required: – code – name – bank properties: id: type: string description: Id da entidade code: type: integer description: Número da agência name: type: string description: Nome da agência bank: #/definitions/bank fixedJudicialValue: type: object required: – initialValue – salary13Type – salaryAdvancedType – wageBonusType – vacationType properties: id: type: string description: Id da entidade initialValue: type: number description: Valor inicial format: double salary13Type: #/definitions/salary13Type salaryAdvancedType: #/definitions/salaryAdvancedType salaryAdvancedPercentage: type: integer description: Porcentagem do adiantamento salarial para a pensão wageBonusType: #/definitions/decisionType vacationType: #/definitions/decisionType startCorrection: type: string description: Data de inicio da correção format: date financialIndex: #/definitions/financialIndex correctionDay: type: integer description: Dia da correção periodicityCorrection: type: integer description: Periodicidade da correção financialIndex: type: object required: – code – name – informationType – indexType – numberOfDigits – numberOfDecimals properties: id: type: string description: Id do índice code: type: integer description: Código do índice name: type: string description: Nome do índice informationType: #/definitions/informationType indexType: #/definitions/indexType numberOfDigits: type: integer description: Quantidade de dígitos numberOfDecimals: type: integer description: Quantidade de decimais variableJudicialValue: type: object required: – minimumValue – judicialPensionPercentage – judicialPensionVacation – judicialPension13Salary – judicialPensionWageBonus – judicialPensionFgts – fgtsPensionType properties: id: type: string description: Id da entidade minimumValue: type: number description: Valor mínimo format: double judicialPensionPercentage: type: number description: Percentual da pensão judicial format: double judicialPensionVacation: type: number description: Percentual de férias da pensão format: double judicialPension13Salary: type: number description: Percentual de 13o salário da pensão format: double judicialPensionWageBonus: type: number description: Percentual de bônus do salário (PLR) da pensão format: double judicialPensionFgts: type: number description: Percentual de FGTS da pensão format: double fgtsPensionType: #/definitions/fgtsPensionType 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