Cadastros Gerais (general_register)

Cadastros Gerais (general_register)

151 views 17/03/2021 20/04/2021 integrador 0

2.0info: 4.3.0 Cadastros Gerais description: Serviço responsável pelos CRUD de cadastros gerais utilizados pelo HCM x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: general_register contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /hcm/general_register/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /entities/clockingEventOfWorkSchedule: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/clockingEventOfWorkSchedule responses: 200: description: The created resource schema: #/definitions/clockingEventOfWorkSchedule default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/clockingEventOfWorkSchedule responses: 200: description: The created resource schema: #/definitions/clockingEventOfWorkSchedule default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/clockingEventOfWorkSchedule default: description: Error response schema: #/definitions/genericError /entities/clockingEventOfWorkSchedule/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/clockingEventOfWorkSchedule responses: 200: description: Ok schema: #/definitions/clockingEventOfWorkSchedule default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/clockingEventOfWorkSchedule responses: 200: description: Ok schema: #/definitions/clockingEventOfWorkSchedule default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/clockingEventOfWorkSchedule default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/clockingEventOfWorkSchedule/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/clockingEventOfWorkSchedule responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/bank: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/bank default: description: Error response schema: #/definitions/genericError /entities/bank/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/bank/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/bank responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/educationdegree: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/educationdegree responses: 200: description: The created resource schema: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/educationdegree responses: 200: description: The created resource schema: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError /entities/educationdegree/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/educationdegree responses: 200: description: Ok schema: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/educationdegree responses: 200: description: Ok schema: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/educationdegree default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/educationdegree/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/educationdegree responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/organizationalChartDepartment: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/organizationalChartDepartment responses: 200: description: The created resource schema: #/definitions/organizationalChartDepartment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/organizationalChartDepartment responses: 200: description: The created resource schema: #/definitions/organizationalChartDepartment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/organizationalChartDepartment default: description: Error response schema: #/definitions/genericError /entities/organizationalChartDepartment/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/organizationalChartDepartment responses: 200: description: Ok schema: #/definitions/organizationalChartDepartment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/organizationalChartDepartment responses: 200: description: Ok schema: #/definitions/organizationalChartDepartment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/organizationalChartDepartment default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/organizationalChartDepartment/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/organizationalChartDepartment responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/holidayDates: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/holidayDates responses: 200: description: The created resource schema: #/definitions/holidayDates default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/holidayDates responses: 200: description: The created resource schema: #/definitions/holidayDates default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/holidayDates default: description: Error response schema: #/definitions/genericError /entities/holidayDates/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/holidayDates responses: 200: description: Ok schema: #/definitions/holidayDates default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/holidayDates responses: 200: description: Ok schema: #/definitions/holidayDates default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/holidayDates default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/holidayDates/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/holidayDates responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/organizationalChartStructure: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/organizationalChartStructure responses: 200: description: The created resource schema: #/definitions/organizationalChartStructure default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/organizationalChartStructure responses: 200: description: The created resource schema: #/definitions/organizationalChartStructure default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/organizationalChartStructure default: description: Error response schema: #/definitions/genericError /entities/organizationalChartStructure/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/organizationalChartStructure responses: 200: description: Ok schema: #/definitions/organizationalChartStructure default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/organizationalChartStructure responses: 200: description: Ok schema: #/definitions/organizationalChartStructure default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/organizationalChartStructure default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/organizationalChartStructure/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/organizationalChartStructure responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/movimentationreason: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/movimentationreason responses: 200: description: The created resource schema: #/definitions/movimentationreason default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/movimentationreason responses: 200: description: The created resource schema: #/definitions/movimentationreason default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/movimentationreason default: description: Error response schema: #/definitions/genericError /entities/movimentationreason/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/movimentationreason responses: 200: description: Ok schema: #/definitions/movimentationreason default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/movimentationreason responses: 200: description: Ok schema: #/definitions/movimentationreason default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/movimentationreason default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/movimentationreason/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/movimentationreason responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/city: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/city responses: 200: description: The created resource schema: #/definitions/city default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/city responses: 200: description: The created resource schema: #/definitions/city default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/city default: description: Error response schema: #/definitions/genericError /entities/city/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/city responses: 200: description: Ok schema: #/definitions/city default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/city responses: 200: description: Ok schema: #/definitions/city default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/city default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/city/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/city responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/nationality: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/nationality responses: 200: description: The created resource schema: #/definitions/nationality default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/nationality responses: 200: description: The created resource schema: #/definitions/nationality default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/nationality default: description: Error response schema: #/definitions/genericError /entities/nationality/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/nationality responses: 200: description: Ok schema: #/definitions/nationality default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/nationality responses: 200: description: Ok schema: #/definitions/nationality default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/nationality default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/nationality/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/nationality responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/clockingEventBands: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/clockingEventBands responses: 200: description: The created resource schema: #/definitions/clockingEventBands default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/clockingEventBands responses: 200: description: The created resource schema: #/definitions/clockingEventBands default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/clockingEventBands default: description: Error response schema: #/definitions/genericError /entities/clockingEventBands/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/clockingEventBands responses: 200: description: Ok schema: #/definitions/clockingEventBands default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/clockingEventBands responses: 200: description: Ok schema: #/definitions/clockingEventBands default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/clockingEventBands default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/clockingEventBands/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/clockingEventBands responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/bankBranch: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/bankBranch responses: 200: description: The created resource schema: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/bankBranch responses: 200: description: The created resource schema: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError /entities/bankBranch/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankBranch responses: 200: description: Ok schema: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankBranch responses: 200: description: Ok schema: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bankBranch default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/bankBranch/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/bankBranch responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/holiday: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/holiday responses: 200: description: The created resource schema: #/definitions/holiday default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/holiday responses: 200: description: The created resource schema: #/definitions/holiday default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/holiday default: description: Error response schema: #/definitions/genericError /entities/holiday/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/holiday responses: 200: description: Ok schema: #/definitions/holiday default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/holiday responses: 200: description: Ok schema: #/definitions/holiday default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/holiday default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/holiday/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/holiday responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/state: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/state responses: 200: description: The created resource schema: #/definitions/state default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/state responses: 200: description: The created resource schema: #/definitions/state default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/state default: description: Error response schema: #/definitions/genericError /entities/state/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/state responses: 200: description: Ok schema: #/definitions/state default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/state responses: 200: description: Ok schema: #/definitions/state default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/state default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/state/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/state responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/workshift: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/workshift responses: 200: description: The created resource schema: #/definitions/workshift default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/workshift responses: 200: description: The created resource schema: #/definitions/workshift default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/workshift default: description: Error response schema: #/definitions/genericError /entities/workshift/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workshift responses: 200: description: Ok schema: #/definitions/workshift default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workshift responses: 200: description: Ok schema: #/definitions/workshift default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workshift default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/workshift/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workshift 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 parameters: – 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 parameters: – 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 parameters: – 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 parameters: – 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 parameters: – 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 parameters: – 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 parameters: – 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 parameters: – 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/country: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/country responses: 200: description: The created resource schema: #/definitions/country default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/country responses: 200: description: The created resource schema: #/definitions/country default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/country default: description: Error response schema: #/definitions/genericError /entities/country/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/country default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/country/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/country responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/dismissalReason: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/dismissalReason responses: 200: description: The created resource schema: #/definitions/dismissalReason default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/dismissalReason responses: 200: description: The created resource schema: #/definitions/dismissalReason default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/dismissalReason default: description: Error response schema: #/definitions/genericError /entities/dismissalReason/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dismissalReason responses: 200: description: Ok schema: #/definitions/dismissalReason default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dismissalReason responses: 200: description: Ok schema: #/definitions/dismissalReason default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dismissalReason default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/dismissalReason/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dismissalReason responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/workSchedules: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/workSchedules responses: 200: description: The created resource schema: #/definitions/workSchedules default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/workSchedules responses: 200: description: The created resource schema: #/definitions/workSchedules default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/workSchedules default: description: Error response schema: #/definitions/genericError /entities/workSchedules/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workSchedules responses: 200: description: Ok schema: #/definitions/workSchedules default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workSchedules responses: 200: description: Ok schema: #/definitions/workSchedules default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workSchedules default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/workSchedules/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workSchedules responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: 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 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 degreeInstructionType: type: string enum: – Illiterate – ElementarySchoolIncomplete – ElementarySchoolComplete – MiddleSchoolIncomplete – MiddleSchoolComplete – HighSchoolIncomplete – HighSchoolComplete – BachelorIncomplete – BachelorComplete – Postgraduate – Master – Doctoral nationalityType: type: string enum: – BRAZILIAN – NATURALIZED_BRAZILIAN – ARGENTINE – BOLIVIAN – CHILEAN – PARAGUAYAN – URUGUAYAN – VENEZULAN – COLOMBIAN – PERUVIAN – EQUATORIAN – GERMAN – BELGIAN – BRITISH – CANADIAN – SPANISH – NORTH_AMERICAN – FRENCH – SWISS – ITALIAN – HAITIAN – JAPANESE – CHINESE – KOREAN – RUSSIAN – PORTUGUESE – SWENDISH – FINNISH – OTHER_LATIN_AMERICANS – OTHER_ASIANS – BENGALIAN – OTHER_EUROPEAN – GUINEAN – MOROCCAN – CUBAN – SYRIAN – SOUTH_KOREAN – ANGOLAN – CONGOLES – SOUTH_AFRICAN – PAKISTANI – INDIAN – GANES – SENEGALESE – OTHER_AMERICANS – OTHERS workShiftJourneyType: type: string enum: – ON_ENTER – ON_LEAVE scheduleType: type: string enum: – RIGID – MOBILE – FLEXIBLE – MOBILE_ENTER_EXIT – MOBILE_MEAL – FLEXIBLE_ON_INTERVALS mealTimeType: type: string enum: – PROXIMITY_OF_MEAL_TIME – CONSIDER_ALL_INTERVALS missingHoursCalculationType: type: string enum: – AFTER_BUSINESS_TIME – OVER_BUSINESS_TIME accessLevelCalculationType: type: string enum: – STAR_FINISH_SAME_DAY – STAR_FINISH_DIFFERENT_DAY workShifIntervalType: type: string enum: – INTERVAL_ON_FIXED_WORKSHIFT – INTERVAL_ON_VARIABLE_WORKSHIFT – NO_INTERVAL clockingEventUseType: type: string enum: – ENTER_LEAVE_REQUIRED – ENTER_LEAVE_NOT_REQUIRED – ENTER_LEAVE_GENERATED – MEAL_REQUIRED – MEAL_NOT_REQUIRED – MEAL_REQUIRED_EXTRA – MEAL_NOT_REQUIRED_DEFINE_TOLERANCE – MEAL_GENERATED – LUNCH_REQUIRED – LUNCH_NOT_REQUIRED – LUNCH_REQUIRED_EXTRA dateDismissalWarningType: type: string enum: – YES – NO – WARNING_DATE_EQUALS_DISMISSAL indemnifiedDaysType: type: string enum: – YES – NO – YES_BUT_NOT_SUM – HALF_OF_DAYS reopenedDaysType: type: string enum: – YES – NO – YES_WITHOUT_SUM daysInAdvanceType: type: string enum: – COMPANY – EMPLOYEE – NO vacationFractionAndSalaryType: type: string enum: – NO – END_OF_THE_CONTRACT – INDEMNIFIED_DAYS warningNoticeType: type: string enum: – NOTICE_DAY – AFTER_NOTICE_DAY – AFTER_AVAILABLE_NOTICE_DAY determinedDeadlineType: type: string enum: – YES – NO dismissalReasonRaisType: type: string enum: – TYPE_10 – TYPE_11 – TYPE_12 – TYPE_20 – TYPE_21 – TYPE_22 – TYPE_30 – TYPE_31 – TYPE_32 – TYPE_33 – TYPE_34 – TYPE_40 – TYPE_50 – TYPE_60 – TYPE_62 – TYPE_63 – TYPE_64 – TYPE_70 – TYPE_71 – TYPE_72 – TYPE_73 – TYPE_74 – TYPE_75 – TYPE_76 – TYPE_78 – TYPE_79 – TYPE_80 – TYPE_90 homologNetDismissalCodeType: type: string enum: – HOMOLOG_NET_SJ2 – HOMOLOG_NET_JC2 – HOMOLOG_NET_RA2 – HOMOLOG_NET_RA1 – HOMOLOG_NET_SJ1 – HOMOLOG_NET_FT1 – HOMOLOG_NET_PD0 – HOMOLOG_NET_RI2 – HOMOLOG_NET_CR0 – HOMOLOG_NET_FE2 – HOMOLOG_NET_FE1 – HOMOLOG_NET_FM0 – HOMOLOG_NET_NC0 fgtsWithdrawalCodeType: type: string enum: – TYPE_01 – TYPE_02 – TYPE_03 – TYPE_04 – TYPE_05 – TYPE_06 – TYPE_07 – TYPE_10 – TYPE_23 – TYPE_26 – TYPE_27 – TYPE_50 – TYPE_70 – TYPE_80_D – TYPE_80_T – TYPE_81_D – TYPE_81_T – TYPE_82_D – TYPE_82_T – TYPE_86 – TYPE_87_N – TYPE_88 – TYPE_91 – TYPE_92 – TYPE_93 – TYPE_94 – TYPE_95 – TYPE_96 cagedDispenseNoticeType: type: string enum: – TYPE_31 – TYPE_32 – TYPE_40 – TYPE_43 – TYPE_45 – TYPE_50 – TYPE_60 – TYPE_80 – TYPE_90 payFamilySalaryType: type: string enum: – YES – NO – PROPORTIONAL payFgtsFineOnTerminateType: type: string enum: – YES_TYPE_01 – YES_TYPE_02 – YES_TYPE_03 – NO pay13IndemnifiedSalaryType: type: string enum: – NEVER – BIGGER_ZERO – BIGGER_FIFTEEN – CHECK payVacationProportionalType: type: string enum: – ALWAYS – CHECK – NO payIndemnifiedDissidioType: type: string enum: – YES_WITH_SUM – YES_WITHOUT_SUM – NO paySpecialLeaveType: type: string enum: – NO – JUST_OVERDUE – ALL controlRehireType: type: string enum: – YES – NO – DETERMINED_DEADLINE discountTransportationVoucherType: type: string enum: – NORMAL – INTEGRAL monthlyBalanceCalculationType: type: string enum: – ACTUAL_DEFINITION – HOMOLOG_NET_DEFINITION paymentStartDateType: type: string enum: – AFTER_RESIGNATION – RESIGNATION_DAY transferReasonType: type: string enum: – TRANSFER_COMPANY – TRANSFER_COMPANY_BRANCH – NO_REASON_TRANSFER workScheduleType: type: string enum: – TYPE_1 – TYPE_2 – TYPE_3 – TYPE_4 – TYPE_5 – TYPE_6 – TYPE_7 – TYPE_8 eSocialType: type: string enum: – NOT_APPLY – WARNING – SUSPENSION – RETIREMENT – SUCCESSION – SALARY_DESCRIPTION – DESABILITY – OTHERS – WORKING_HOUR_REGIMEN – EMPLOYEMENT_CONTRACT_OBSERVATION – AUTHORIZATION_WORK_ELECTRICAL_INSTALLATIONS – OPERATION_EXECUTION_MACHINE_INTERVENTIONS – HOISTING_EQUIPMENT_OPERATOR – TRAININGS_SIMULATED_EXERCISES salaryDescriptionType: type: string enum: – SALARY_START – SALARY_END appointmentType: type: string enum: – NOT_APPOINTMENT – LAW – DECREE – ORDINANCE – CONTRACT – OTHERS movementSefipType: type: string enum: – H – I1 – I2 – I3 – I4 – I5 – J – K – L – M – N1 – N2 – N3 – O1 – O2 – O3 – P1 – P2 – P3 – Q1 – Q2 – Q3 – Q4 – Q5 – Q6 – R – S2 – S3 – U1 – U2 – U3 – V3 – W – X – Y – Z1 – Z2 – Z3 – Z4 – Z5 – Z6 eSocialDismissalType: 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 – 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_99 – TYPE_36 directorDismissalReasonType: type: string enum: – TYPE_1 – TYPE_2 – TYPE_3 – TYPE_4 – TYPE_5 – TYPE_6 – TYPE_99 paymentDateCountingStartType: type: string enum: – AFTER_DISMISSAL_DATE – DISMISSAL_DATE reasonType: type: string enum: – LEGAL – SPONTANEOUS alteredReasonType: type: string enum: – NOT_APPLICABLE – PROMOTION – READAPTATION – EXPLOITATION – OTHER – NOT_CHANGED movimentationReasonType: type: string enum: – HIRE – MERIT – REALLOCATION – PROMOTION expenseType: type: string enum: – ADMINISTRATIVE – COMMERCIAL – OPERATIONAL dayOfWeakType: type: string enum: – SUNDAY – MONDAY – TUESDAY – WEDNESDAY – THURSDAY – FRIDAY – SATURDAY workshiftType: type: string enum: – PERMANENT – AUTOMATIC_SEARCH – DEFINED – AUTOMATIC_GENERATION holidayType: type: string enum: – OWN – BRANCH – LOCAL – NONE workshiftScaleType: type: string enum: – FIRST_SHIFT – SECOND_SHIFT – THIRD_SHIFT – FOURTH_SHIFT – MIXED – GENERAL clockingEventOnDayOffType: type: string enum: – NOT_CONSIDER – LOCK_LIKE_PREVIOUS – LOCK_LIKE_NEXT projectWorkScheduleOnDayOffType: type: string enum: – NOT_DESIGN – DESIGN_LIKE_PREVIOUS – DESIGN_LIKE_NEXT automaticSearchType: type: string enum: – BY_HIGHER_NUMBER_WORKED_HOURS – BY_HIGHER_PERCENT_WORKED_HOURS – BY_FIRST_CLOCKINGEVENT_ON_DAY – BY_FIRST_CLOCKINGEVENT_ON_DAY_WITH_TOLERANCE inBetweenWorkdaysConsistencyType: type: string enum: – ALERT – BLOCK – IGNORE handleWorkType: type: string enum: – FIXED_WORK_SCHEDULE – SEQUENCE_WORK_SCHEDULE eSocialWorkShiftType: type: string enum: – DAILY_WORKS_SCHEDULE_FIXED_DAY_OFF – WORK_SHIFT_12_36 – DAILY_WORKS_SCHEDULE_VARIANT_DAY_OFF – OTHER_TYPES – NOT_ESOCIAL_OTHER_TYPES subscriptionType: type: string enum: – EMPTY – CNPJ – CEI – CPF – INCRA 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 bankBranches: type: array items: #/definitions/bankBranch description: Lista de agencias bankBranch: type: object required: – code – name – city properties: id: type: string description: Id da agência code: type: integer description: Número da agência name: type: string description: Nome da agência bank: #/definitions/bank city: #/definitions/city digit: type: string description: Dígito da agência 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 district: type: string description: Distrito ibgeCode: type: string description: Código IBGE do município issPercentage: type: number description: Percentual de ISS format: double stateId: #/definitions/state neighborhood: type: array items: #/definitions/neighborhood description: Bairros externalId: type: string description: Id de sistema externo 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 externalId: type: string description: Id de sistema externo 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 codeRfb: type: integer description: Código RFB do País currency: #/definitions/currency externalId: type: string description: Id de sistema externo currency: type: object required: – code properties: id: type: string description: Id da moeda code: type: string description: Código da moeda name: type: string description: Nome symbol: type: string description: Símbolo conversionRates: type: array items: #/definitions/conversionRates description: Índices de conversão conversionRates: type: object required: – destinationCurrency – financialIndex properties: id: type: string description: Id de índices de conversão originCurrency: #/definitions/currency destinationCurrency: #/definitions/currency financialIndex: #/definitions/financialIndex 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 indexValue: type: array items: #/definitions/indexValue description: Índices – Valores indexValue: type: object required: – referenceDate – indexValue properties: id: type: string description: Id de índices – Valores referenceDate: type: string description: Data de referência format: date indexValue: type: number description: Valor do index format: double financialIndex: #/definitions/financialIndex 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 administrativeRegion: #/definitions/administrativeregion address: type: array items: #/definitions/publicPlace description: Logradouros externalId: type: string description: Id de sistema externo 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 publicPlace: type: object required: – cep – addressType properties: id: type: string description: Identificador cep: type: string description: CEP name: type: string description: Nome do Logradouro addressType: #/definitions/addressType neighborhood: #/definitions/neighborhood 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 nationality: type: object required: – code – name – nationalityType properties: id: type: string description: Id da naciolidade code: type: integer description: Código da Nacionalidade name: type: string description: Descrição da Nacionalidade nationalityType: #/definitions/nationalityType countryCodeRfb: type: integer description: Código RFB do país externalId: type: string description: Id de sistema externo workSchedules: type: object required: – code properties: id: type: string description: Identificador code: type: integer description: Código do Horário name: type: string description: Descrição do Horário structure: type: integer description: Estrutura shift: type: integer description: Turno workShiftJourneyType: #/definitions/workShiftJourneyType workShiftSeparation: type: integer description: Separação de Jornada workShiftFactor: type: integer description: Fator de Jornada overtimeMealLimit: type: integer description: Limite Extras Refeição overtimeToleranceEnterExit: type: integer description: Tolerância Extras Entrada/Saída overtimeToleranceMeal: type: integer description: Tolerância de Extras na Refeição dailyMissingHoursTolerance: type: integer description: Tolerância diária de faltas missingHoursToleranceEnterExit: type: integer description: Tolerância de faltas Entrada/Saída missingHoursToleranceMeal: type: integer description: Tolerância de faltas Refeição scheduleType: #/definitions/scheduleType mealTimeType: #/definitions/mealTimeType hoursDeductProduction: type: integer description: Horas a deduzir da Produção payOvertimeTwelveHours: type: boolean description: Pagar Extras 12 Horas dailyOvertimeTolerance: type: integer description: Tolerância diária extras missingHoursCalculationType: #/definitions/missingHoursCalculationType accessLevelCalculationType: #/definitions/accessLevelCalculationType esocialFlexibility: type: boolean description: Flexibilidade eSocial esocialIntervalType: #/definitions/workShifIntervalType calculateIndemnifiedInterval: type: boolean description: Calcula intervalo indenizado startIndemnifiedInterval: type: integer description: Inicio intervalo indenizado endIndemnifiedInterval: type: integer description: Fim intervalo indenizado clockingEventOfWorkSchedule: type: array items: #/definitions/clockingEventOfWorkSchedule description: Marcações do horário clockingEventBands: type: array items: #/definitions/clockingEventBands description: Faixas de marcação de horário clockingEventOfWorkSchedule: type: object required: – clockingEventSequence properties: id: type: string description: Identificador workSchedule: #/definitions/workSchedules clockingEventSequence: type: integer description: Sequência da marcação clockingEventUseType: #/definitions/clockingEventUseType clockingEventTime: type: integer description: Hora da marcação beforeTolerance: type: integer description: Tolerância antes afterTolerance: type: integer description: Tolerância depois clockingEventMobility: type: integer description: Mobilidade da marcação clockingEventBands: type: object required: – clockingEventBandSequence properties: id: type: string description: Identificador workSchedule: #/definitions/workSchedules clockingEventBandSequence: type: integer description: Sequência da faixa de marcação startAccessBand: type: integer description: Início da faixa Acesso endAccessBand: type: integer description: Fim da faixa Acesso startClockingEventBand: type: integer description: Início da faixa Ponto endClockingEventBand: type: integer description: Fim da faixa Ponto dismissalReason: type: object required: – code – name – checkStability – vacationFractionAndSalaryType – printDispenseNotice – dismissalReasonRaisType – homologNetDismissalCodeType – fgtsWithdrawalCodeType – cagedDispenseNoticeType – payFamilySalaryType – payFgtsOnTermination – payFgtsFineOnTerminateType – pay13ProportionalSalary – pay13IndemnifiedSalaryType – payVacationProportionalType – payBonus – payIndemnifiedDissidioType – paySpecialLeaveType – controlRehireType – otherEvents – spreadWorkflow – considerInTheMovesPortlet – discountTransportationVoucherType – monthlyBalanceCalculation – paymentStartDate – allowsWithdrawalDismissal – paymentDateCountingStart properties: id: type: string description: Id da causa code: type: integer description: Código da causa name: type: string description: Descrição da causa dateDismissalWarningType: #/definitions/dateDismissalWarningType indemnifiedDaysType: #/definitions/indemnifiedDaysType reopenedDaysType: #/definitions/reopenedDaysType checkStability: type: boolean description: Checar estabilidade? daysInAdvanceType: #/definitions/daysInAdvanceType vacationFractionAndSalaryType: #/definitions/vacationFractionAndSalaryType warningNoticeType: #/definitions/warningNoticeType printDispenseNotice: type: boolean description: Imprimir Comunicado de Dispensa? determinedDeadlineType: #/definitions/determinedDeadlineType dismissalReasonRaisType: #/definitions/dismissalReasonRaisType homologNetDismissalCodeType: #/definitions/homologNetDismissalCodeType fgtsWithdrawalCodeType: #/definitions/fgtsWithdrawalCodeType cagedDispenseNoticeType: #/definitions/cagedDispenseNoticeType payFamilySalaryType: #/definitions/payFamilySalaryType payFgtsOnTermination: type: boolean description: Pagar FGTS na rescisão? payFgtsFineOnTerminateType: #/definitions/payFgtsFineOnTerminateType pay13ProportionalSalary: type: boolean description: Pagar 13o salário proporcional? pay13IndemnifiedSalaryType: #/definitions/pay13IndemnifiedSalaryType payVacationProportionalType: #/definitions/payVacationProportionalType payBonus: type: boolean description: Pagar gratificação? payIndemnifiedDissidioType: #/definitions/payIndemnifiedDissidioType paySpecialLeaveType: #/definitions/paySpecialLeaveType controlRehireType: #/definitions/controlRehireType otherEvents: type: boolean description: Calcular outros eventos da rescisão? spreadWorkflow: type: boolean description: Divulgar no workflow? daysToLockTheBadge: type: integer description: Dias para bloquear o crachá, após demissão considerInTheMovesPortlet: type: boolean description: Considerar no portlet de movimentações? discountTransportationVoucherType: #/definitions/discountTransportationVoucherType monthlyBalanceCalculation: #/definitions/monthlyBalanceCalculationType paymentStartDate: #/definitions/paymentStartDateType allowsWithdrawalDismissal: type: boolean description: Permite afastamento de rescisão? transferReasonType: #/definitions/transferReasonType annotationType: #/definitions/annotationtype dismissalReasonSefip: type: array items: #/definitions/dismissalReasonSefip description: Motivo da demissão Sefip dismissalReasonEsocial: type: array items: #/definitions/dismissalReasonEsocial description: Causa do desligamento eSocial paymentDateCountingStart: #/definitions/paymentDateCountingStartType annotationtype: type: object required: – code – name – showinadmissioncard – usesTransfers – appointmentType properties: id: type: string description: Id do tipo da anotação code: type: integer description: Código do tipo de anotação name: type: string description: Descrição do tipo showinadmissioncard: type: boolean description: Se mostra na admissão workScheduleType: #/definitions/workScheduleType eSocialType: #/definitions/eSocialType salaryDescriptionType: #/definitions/salaryDescriptionType pregnantApprenticeType: type: boolean description: Aprendiz grávida usesTransfers: type: boolean description: Uso transferências appointmentType: #/definitions/appointmentType dismissalReasonSefip: type: object required: – referenceDate – movementSefipType properties: id: type: string description: Id do do motivo referenceDate: type: string description: Data de referência format: date movementSefipType: #/definitions/movementSefipType dismissalReason: #/definitions/dismissalReason dismissalReasonEsocial: type: object required: – referenceDate – eSocialDismissalType – directorDismissalReasonType properties: id: type: string description: Id da outra empresa referenceDate: type: string description: Data de referência format: date eSocialDismissalType: #/definitions/eSocialDismissalType directorDismissalReasonType: #/definitions/directorDismissalReasonType dismissalReason: #/definitions/dismissalReason movimentationreason: type: object required: – code – name – reason properties: id: type: string description: Id do motivo code: type: integer description: Código do motivo name: type: string description: Nome do motivo reason: #/definitions/reasonType alteredReasonType: #/definitions/alteredReasonType movimentationReasonType: #/definitions/movimentationReasonType organizationalChartStructure: type: object required: – code – name properties: id: type: string description: Id do Organograma code: type: integer description: Código do organograma name: type: string description: Nome do organograma useMask: type: boolean description: Usa Máscara levelEmployee: type: integer description: Nível Colaboradores levelQL: type: integer description: Nível do QL levelCompanyBranch: type: integer description: Nível Filial levelPPRA: type: integer description: Nível PPRA/PCMSO levelPSS: type: integer description: Nível PSS organizationalChartDepartment: type: array items: #/definitions/organizationalChartDepartment description: Locais do Organograma organizationalChartDepartment: type: object required: – code properties: id: type: string description: Id da entidade organizationalChartStructure: #/definitions/organizationalChartStructure code: type: integer description: Local name: type: string description: Nome do Local apportionment: #/definitions/apportionment createdDate: type: string description: Data Criação format: date extinctionDate: type: string description: Data Extinção format: date ppp: type: boolean description: Considera PPP organizationalChartDepartmentHierarchy: type: array items: #/definitions/organizationalChartDepartmentHierarchy description: Hierarquia dos Locais no Organograma 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 do rateio expenseType: #/definitions/expenseType organizationalChartDepartmentHierarchy: type: object properties: id: type: string description: Id da entidade organizationalChartDepartment: #/definitions/organizationalChartDepartment initialDate: type: string description: Data Início Hierarquia format: date endDate: type: string description: Data Fim Hierarquia format: date departmentPosition: type: string description: Posição do Local departmentCode: type: string description: Código do Local holidayDates: type: object required: – code – holidayDate properties: id: type: string description: Id da entidade code: type: integer description: Código da Tabela de Feriados holidayDate: type: string description: Data do Feriado format: date name: type: string description: Descrição do feriado giveTramportationVoucher: type: boolean description: Distribuir Vale Transporte dayForWork: #/definitions/dayOfWeakType holiday: #/definitions/holiday holiday: type: object required: – code properties: id: type: string description: Id da entidade code: type: integer description: Código Tabela de Feriados name: type: string description: Descrição da Tabela de Feriados holidayDates: type: array items: #/definitions/holidayDates description: Datas de feriados workshift: type: object required: – code – workshiftType properties: id: type: string description: Id da escala code: type: integer description: Código da escala description: type: string description: Descrição da escala monthminutes: type: number description: Horas mensais format: double weekminutes: type: number description: Horas semanais format: double dsrminutes: type: number description: Horas DSR format: double workshiftType: #/definitions/workshiftType structure: type: string description: Estrutura holidayType: #/definitions/holidayType workshiftScale: #/definitions/workshiftScaleType holidayTable: #/definitions/holiday officialHolidayTable: #/definitions/holiday clockingEventOnDayOff: #/definitions/clockingEventOnDayOffType workScheduleSeparationOnDayOff: type: number description: Separação de Jornada na Folga format: double projectWorkScheduleOnDayOff: #/definitions/projectWorkScheduleOnDayOffType automaticSearchType: #/definitions/automaticSearchType inBetweenWorkdaysConsistency: #/definitions/inBetweenWorkdaysConsistencyType relayTypeForPPPEmissionDescription: type: string description: Descrição do tipo de revezamento para emissão do PPP workSchedule: #/definitions/workSchedules dayOffWorkSchedule: #/definitions/workSchedules doubleShiftWorkSchedule: #/definitions/workSchedules handleWork: #/definitions/handleWorkType eSocialWorkShift: #/definitions/eSocialWorkShiftType eSocialWorkShiftDesciption: type: string description: Descrição da jornada do eSocial payProportionalextraHoursOnHoliday: type: boolean description: Pagar extras proporcionais no feriado workshiftClass: #/definitions/workshiftClass workshiftClass: type: object required: – code properties: id: type: string description: Id da escala code: type: integer description: Código da Classe de Escala name: type: string description: Descrição da Classe de Escala relayWorkshift: type: boolean description: Escala de Revezamento 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 genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment