2.0info: 4.33.1 Lançamentos description: HCM – Lançamentos da folha de pagamento x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: entry contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /hcm/entrysecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /entities/entry: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/entry responses: 200: description: The created resource schema: #/definitions/entry 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/entry responses: 200: description: The created resource schema: #/definitions/entry 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/entry default: description: Error response schema: #/definitions/genericError /entities/entry/{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/entry responses: 200: description: Ok schema: #/definitions/entry 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/entry responses: 200: description: Ok schema: #/definitions/entry 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/entry 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/entry/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/entry responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/validCalculationType: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/validCalculationType responses: 200: description: The created resource schema: #/definitions/validCalculationType 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/validCalculationType responses: 200: description: The created resource schema: #/definitions/validCalculationType 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/validCalculationType default: description: Error response schema: #/definitions/genericError /entities/validCalculationType/{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/validCalculationType responses: 200: description: Ok schema: #/definitions/validCalculationType 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/validCalculationType responses: 200: description: Ok schema: #/definitions/validCalculationType 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/validCalculationType 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/validCalculationType/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/validCalculationType responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/payrollcalculation: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/payrollcalculation responses: 200: description: The created resource schema: #/definitions/payrollcalculation 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/payrollcalculation responses: 200: description: The created resource schema: #/definitions/payrollcalculation 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/payrollcalculation default: description: Error response schema: #/definitions/genericError /entities/payrollcalculation/{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/payrollcalculation responses: 200: description: Ok schema: #/definitions/payrollcalculation 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/payrollcalculation responses: 200: description: Ok schema: #/definitions/payrollcalculation 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/payrollcalculation 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/payrollcalculation/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/payrollcalculation responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/apportionmentEntryException: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/apportionmentEntryException responses: 200: description: The created resource schema: #/definitions/apportionmentEntryException 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/apportionmentEntryException responses: 200: description: The created resource schema: #/definitions/apportionmentEntryException 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/apportionmentEntryException default: description: Error response schema: #/definitions/genericError /entities/apportionmentEntryException/{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/apportionmentEntryException responses: 200: description: Ok schema: #/definitions/apportionmentEntryException 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/apportionmentEntryException responses: 200: description: Ok schema: #/definitions/apportionmentEntryException 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/apportionmentEntryException 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/apportionmentEntryException/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/apportionmentEntryException responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/entry13Salary: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/entry13Salary responses: 200: description: The created resource schema: #/definitions/entry13Salary 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/entry13Salary responses: 200: description: The created resource schema: #/definitions/entry13Salary 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/entry13Salary default: description: Error response schema: #/definitions/genericError /entities/entry13Salary/{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/entry13Salary responses: 200: description: Ok schema: #/definitions/entry13Salary 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/entry13Salary responses: 200: description: Ok schema: #/definitions/entry13Salary 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/entry13Salary 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/entry13Salary/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/entry13Salary responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/apportionment: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/apportionment responses: 200: description: The created resource schema: #/definitions/apportionment 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/apportionment responses: 200: description: The created resource schema: #/definitions/apportionment 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/apportionment default: description: Error response schema: #/definitions/genericError /entities/apportionment/{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/apportionment responses: 200: description: Ok schema: #/definitions/apportionment 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/apportionment responses: 200: description: Ok schema: #/definitions/apportionment 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/apportionment 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/apportionment/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/apportionment responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/wagetype: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/wagetype responses: 200: description: The created resource schema: #/definitions/wagetype 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/wagetype responses: 200: description: The created resource schema: #/definitions/wagetype 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/wagetype default: description: Error response schema: #/definitions/genericError /entities/wagetype/{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/wagetype responses: 200: description: Ok schema: #/definitions/wagetype 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/wagetype responses: 200: description: Ok schema: #/definitions/wagetype 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/wagetype 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/wagetype/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/wagetype responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/wageTypeTable: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/wageTypeTable responses: 200: description: The created resource schema: #/definitions/wageTypeTable 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/wageTypeTable responses: 200: description: The created resource schema: #/definitions/wageTypeTable 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/wageTypeTable default: description: Error response schema: #/definitions/genericError /entities/wageTypeTable/{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/wageTypeTable responses: 200: description: Ok schema: #/definitions/wageTypeTable 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/wageTypeTable responses: 200: description: Ok schema: #/definitions/wageTypeTable 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/wageTypeTable 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/wageTypeTable/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/wageTypeTable responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/companyWageTypeTable: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/companyWageTypeTable responses: 200: description: The created resource schema: #/definitions/companyWageTypeTable 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/companyWageTypeTable responses: 200: description: The created resource schema: #/definitions/companyWageTypeTable 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/companyWageTypeTable default: description: Error response schema: #/definitions/genericError /entities/companyWageTypeTable/{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/companyWageTypeTable responses: 200: description: Ok schema: #/definitions/companyWageTypeTable 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/companyWageTypeTable responses: 200: description: Ok schema: #/definitions/companyWageTypeTable 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/companyWageTypeTable 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/companyWageTypeTable/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/companyWageTypeTable responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/apportionmentEntry: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/apportionmentEntry responses: 200: description: The created resource schema: #/definitions/apportionmentEntry 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/apportionmentEntry responses: 200: description: The created resource schema: #/definitions/apportionmentEntry 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/apportionmentEntry default: description: Error response schema: #/definitions/genericError /entities/apportionmentEntry/{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/apportionmentEntry responses: 200: description: Ok schema: #/definitions/apportionmentEntry 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/apportionmentEntry responses: 200: description: Ok schema: #/definitions/apportionmentEntry 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/apportionmentEntry 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/apportionmentEntry/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/apportionmentEntry responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/entryItem: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/entryItem responses: 200: description: The created resource schema: #/definitions/entryItem 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/entryItem responses: 200: description: The created resource schema: #/definitions/entryItem 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/entryItem default: description: Error response schema: #/definitions/genericError /entities/entryItem/{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/entryItem responses: 200: description: Ok schema: #/definitions/entryItem 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/entryItem responses: 200: description: Ok schema: #/definitions/entryItem 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/entryItem 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/entryItem/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/entryItem responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: wageValueType: type: string enum: – VALUE – HOUR wageTypeCategory: type: string enum: – PROCEEDS – DEDUCTION – INFORMATIVE – ADVANTAGE – OTHER_PROCEEDS – OTHER_DEDUCTION wageTypeCharacteristic: type: string enum: – C01A – C01B – C01C – C01D – C01E – C01F – C01G – C01H – C01I – C01J – C01K – C01L – C01M – C01N – C01O – C01P – C01Q – C01R – C01S – C01T – C01U – C01V – C01W – C01X – C01Y – C01Z – C02A – C02B – C02C – C02D – C02E – C02F – C02G – C02H – C02I – C02J – C02K – C02L – C02M – C02N – C02O – C02P – C02Q – C02R – C02S – C02T – C02U – C02V – C02W – C02X – C02Y – C02Z – C03A – C03B – C03C – C03D – C03E – C03F – C03G – C03H – C03I – C03J – C03K – C03L – C03M – C03N – C03O – C03P – C03Q – C03R – C03S – C03T – C03U – C03V – C03W – C03X – C03Y – C03Z – C05A – C05B – C05C – C05D – C05E – C05F – C05G – C05H – C05I – C05J – C05K – C05L – C05M – C05N – C11A – C11B – C11C – C11D – C11E – C11F – C11G – C11H – C11I – C11J – C11K – C11L – C11M – C11N – C11O – C11P – C11Q – C11R – C12A – C12B – C12C – C12D – C12E – C12F – C12G – C12H – C12I – C12J – C13A – C13B – C13C – C13D – C13E – C13F – C13G – C13H – C13I – C13J – C14A – C14B – C14C – C14D – C14G – C14J – C14K – C14L – C14M – C14N – C14O – C14P – C14Q – C15A – C15B – C15C – C15D – C15E – C16A – C16B – C16C – C16D – C16E – C16F – C16G – C16H – C16I – C16J – C17A – C17B – C17C – C17D – C17E – C17G – C17H – C18A – C18B – C18C – C18D – C19A – C19B – C19C – C19D – C19E – C19F – C19G – C19H – C20A – C20B – C20C – C20D – C20E – C21A – C21B – C21C – C21D – C21E – C21F – C21G – C22A – C22B – C22C – C22D – C22E – C23A – C23B – C23C – C23D – C23E – C24A – C24B – C24C – C24D – C24E – C25A – C25B – C25C – C25D – C25E – C25F – C25G – C26A – C26B – C26C – C26D – C26E – C26F – C26G – C27A – C27B – C27C – C27D – C28A – C28C – C28D – C28E – C28F – C28G – C28H – C30A – C31A – C31B – C31C – C31D – C31E – C31F – C31G – C31H – C31I – C31J – C31K – C31L – C31M – C31N – C31O – C32A – C32B – C32C – C32D – C32E – C32F – C32G – C33A – C33B – C34A – C34B – C34C – C35A – C35B – C35C – C35D – C35E – C35F – C35G – C35H – C35I – C35J – C35K – C35L – C35M – C35N – C35O – C35P – C35Q – C35R – C36A – C36B – C36C – C36D – C36E – C36F – C37A – C37B – C37C – C37D – C37E – C38A – C38B – C38C – C38D – C38E – C38F – C38G – C38H – C38I – C38K – C38J – C38L – C38M – C38N – C38O – C38Q – C38R – C39A – C39B – C39C – C39D – C39E – C39F – C39G – C39H – C39I – C39J – C39K – C39L – C39M – C39N – C39O – C39P – C39Q – C39R – C39S – C39T – C39U – C39V – C39Y – C39Z – C40A – C40B – C40C – C40D – C40E – C40F – C40G – C40H – C40I – C40J – C40K – C40L – C40M – C40N – C40O – C40P – C40Q – C40R – C40S – C40T – C40U – C40V – C40W – C40X – C40Y – C40Z – C41A – C41B – C41C – C41D – C41E – C42A – C42B – C42C – C42D – C42E – C42F – C42G – C43A – C43B – C43C – C44A – C44B – C44C – C44D – C44E – C44G – C44H – C44I – C44J – C44K – C45A – C45B – C45C – C45D – C45E – C45F – C45G – C45H – C45I – C45J – C45K – C45L – C45M – C45N – C46A – C48A – C48B – C48C – C48D – C48E – C48F – C48G – C48H – C48I – C48J – C48K – C48L – C48M – C48N – C48O – C48P – C48Q – C48R – C48S – C48T – C49A – C49B – C49C – C49D – C49E – C49F – C49G – C49H – C49I – C49J – C49K – C49L – C49M – C49N – C49O – C49Z – C50A – C50B – C50C – C50D – C50E – C50F – C50G – C50H – C50I – C50J – C50K – C50L – C50M – C50N – C50O – C50P – C50Q – C50R – C50S – C50T – C50U – C50V – C50W – C50X – C50Y – C50Z – C51A – C51B – C51C – C51D – C51E – C51F – C51G – C51H – C51I – C51J – C51K – C51L – C51M – C51N – C51O – C51P – C51Q – C51R – C51S – C51T – C51U – C51V – C51W – C51X – C51Y – C51Z – C52A – C52B – C52C – C52D – C52E – C52F – C52G – C52H – C52I – C52J – C52K – C52L – C52M – C52N – C52O – C52P – C52Q – C52R – C52S – C52T – C52U – C52V – C52W – C52X – C52Y – C52Z – C53A – C53B – C53C – C53D – C53E – C53F – C53G – C53H – C53I – C53J – C53K – C53L – C53M – C53N – C53O – C53P – C53Q – C53R – C53S – C53T – C53U – C53V – C53W – C53X – C53Y – C53Z – C54A – C54B – C54C – C54D – C54E – C54F – C54G – C54H – C54I – C54J – C54K – C54L – C54M – C54N – C54O – C54P – C54Q – C54R – C54S – C54T – C54U – C54V – C54W – C54X – C54Y – C54Z – C55A – C55B – C55C – C55D – C55E – C55F – C55G – C55H – C55I – C55J – C55K – C55L – C55M – C55N – C55O – C55P – C55Q – C55R – C55S – C55T – C55U – C55V – C55W – C55X – C55Y – C55Z – C56A – C56B – C56C – C56D – C56E – C56F – C56G – C56H – C56I – C56J – C56K – C56L – C56M – C56N – C56O – C56P – C56Q – C56R – C56S – C56T – C56U – C56V – C56W – C56X – C56Y – C56Z – C57A – C57B – C57C – C57D – C57E – C58A – C58B – C58C – C58D – C58E – C58F – C58G – C58H – C58I – C58J – C58K – C58L – C61A – C61B – C61D – C62A – C62B – C62D – C63A – C63B – C63D – C61E – C62E – C63E – C42H – C49Q – C38S – C11S – C38T – C38U – C42I – C49R – C61G – C62G – C63G – C29A calculationType: type: string enum: – MONTHLY_CALCULATION – COMPLEMENTARY_PAYROLL – COMPLEMENTARY_AGREEMENT – AGREEMENT_PAYMENT – COMPLEMENTARY_RESCISSION – FIRST_WEEK – INTERMEDIATE_WEEK – LAST_WEEK – THIRTEENTH_PAYDAY_ADVANCE – THIRTEENTH_FULL_SALARY – GRATIFICATION – FIRST_FORTNIGHT – SECOND_FORTNIGHT – SALARY_ADVANCE – PROFT_PARTICIPATION – SPECIAL – LABOR_CLAIM subscriptionType: type: string enum: – EMPTY – CNPJ – CEI – CPF – INCRA companyType: type: string enum: – BRANCH_OFFICE – HEAD_OFFICE – WORK – TEMPORARY – WORK_COOPERATIVELY – DOMESTIC_WORKER – EMPLOYER_ESOCIAL apportionmentUseType: type: string enum: – DONT_USE_APPORTIONMENT – APPORTIONMENT_BY_DEPARTMENT – APPORTIONMENT_BY_COST_CENTER takersRoutineUseType: type: string enum: – BY_COMPANY_BRANCH – BY_APPORTIONMENT apportionmentDiscountType: type: string enum: – TYPE_1 – TYPE_2 calculationSituationType: type: string enum: – CALCULATION_CANCELED – INITIALIZED – TOTAL_CALCULATION – PARTIAL_CALCULATION – SIMULATED_CALCULATION expenseType: type: string enum: – ADMINISTRATIVE – COMMERCIAL – OPERATIONAL entryType: type: string enum: – EVENT – EMPLOYEE formType: type: string enum: – FIXED – VARIABLE conflictType: type: string enum: – LAST – DESPISE – SUM – CONSIST – DUPLICATE employeeType: type: string enum: – NULL – EMPLOYEE – THIRD – PARTNER wageTypeTable: type: object required: – code – name – validity properties: id: type: string description: Id da tabela de evento code: type: integer description: Código da tabela de evento name: type: string description: Descrição da tabela de evento validity: type: string description: Indicador de validade validCalculationType: type: object required: – id – wageTypeTable – wageType – calculationType properties: id: type: string description: Id da tabela wageTypeTable: #/definitions/wageTypeTable wageType: #/definitions/wagetype calculationType: #/definitions/calculationType wagetype: type: object required: – id – wageTypeTable – code – name – wageValueType – type – characteristic properties: id: type: string description: Id do evento wageTypeTable: #/definitions/wageTypeTable code: type: integer description: Código do evento name: type: string description: Descrição do evento wageValueType: #/definitions/wageValueType type: #/definitions/wageTypeCategory characteristic: #/definitions/wageTypeCharacteristic creationdate: type: string description: Data de criação format: date expirationdate: type: string description: Data de extinção format: date syndicate: type: string description: Identificador do sindicato do da contribuição sindical externalId: type: string description: Id externo payrollcalculation: type: object required: – id – company – calculationcode properties: id: type: string description: Id do cálculo da folha de pagamento availableforreference: type: boolean description: Liberar folha no Portal name: type: string description: Nome paymentdate: type: string description: Data de pagamento format: date periodend: type: string description: Data final do período da folha format: date periodstart: type: string description: Data inicial do período da folha format: date referencedate: type: string description: Competência do cálculo format: date calculationtype: #/definitions/calculationType company: #/definitions/company calculationend: type: string description: Data do fim da apuração do cálculo format: date calculationstart: type: string description: Data do início da apuração do cálculo format: date calculationcode: type: integer description: Código do cálculo calculationSituation: #/definitions/calculationSituationType company: type: object required: – cnpj – subscriptionType – companyname – place – companytype – apportionmentUseType – takersRoutineUseType – apportionmentDiscountType – takersRoutineStartDate – useJudicialPensionHistory properties: id: type: string description: Id da empresa code: type: integer description: Código da empresa cnpj: type: string description: Cnpj da empresa subscriptionType: #/definitions/subscriptionType companyname: type: string description: Nome da empresa headquarter: type: string description: Relacionamento com a sede da empresa place: type: string description: Relacionamento com cidade companytype: #/definitions/companyType apportionmentUseType: #/definitions/apportionmentUseType takersRoutineUseType: #/definitions/takersRoutineUseType apportionmentDiscountType: #/definitions/apportionmentDiscountType takersRoutineStartDate: type: string description: Início rotina tomadores por rateio format: date useJudicialPensionHistory: type: boolean description: Usa histórico pensão judicial tradingname: type: string description: Nome fantasia da empresa apportionment: type: object required: – id – code – name – expenseType properties: id: type: string description: Id do rateio code: type: integer description: Código do rateio name: type: string description: Descrição expenseType: #/definitions/expenseType entry: type: object required: – id – company – entryType – formType – conflictType properties: id: type: string description: Id do lançamento company: #/definitions/company entryType: #/definitions/entryType formType: #/definitions/formType conflictType: #/definitions/conflictType wageType: #/definitions/wagetype employee: #/definitions/employee employee: type: object required: – hiredate – employer – companynumber – employeetype – registernumber – registrationnumber – person – department properties: id: type: string description: Id do colaborador hiredate: type: string description: Data de admissão format: date employer: #/definitions/company companynumber: type: integer description: Empresa do colaborador: NUMEMP employeetype: #/definitions/employeeType registernumber: type: integer description: Código do colaborador: NUMCAD registrationnumber: type: integer description: Número de registro do colaborador person: #/definitions/person department: type: string description: Relacionamento com o local costcenter: type: string description: Centro de custo 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 username: type: string description: Nome de usuário cpf: type: string description: Número de CPF entryItem: type: object required: – id – entry – lotIntegration properties: id: type: string description: Id do item do lançamento entry: #/definitions/entry payrollCalculation: #/definitions/payrollcalculation wageType: #/definitions/wagetype employee: #/definitions/employee startDate: type: string description: Data de lançamento format: date endDate: type: string description: Data de validate do lançamento format: date reference: type: number description: Referência do lançamento format: double apportionment: #/definitions/apportionment value: type: number description: Valor do lançamento format: double lotIntegration: type: string description: Id do lote enviado para g5 username: type: string description: Usuário de criação do lançamento creationDate: type: string description: Data de criação do lançamento format: date-time usernameUpdate: type: string description: Usuário de criação do lançamento updateDate: type: string description: Data de criação do lançamento format: date-time apportionmentEntry: type: object required: – id – apportionment – startDate – endDate – percentage properties: id: type: string description: Id da entidade employee: #/definitions/employee department: #/definitions/department jobPosition: #/definitions/jobposition company: #/definitions/company apportionment: #/definitions/apportionment startDate: type: string description: Data inicial format: date endDate: type: string description: Data final format: date percentage: type: number description: Percentual format: double isIntegration: type: boolean description: É integração? (campo calculado) department: type: object required: – id – code – name – position – tablecode – creationdate – expirationdate properties: id: type: string description: Id do local code: type: string description: Código do local name: type: string description: Nome do local position: type: string description: Posição tablecode: type: integer description: Código da tabela creationdate: type: string description: Data de criação format: date expirationdate: type: string description: Data de extinção format: date apportionment: #/definitions/apportionment jobposition: type: object required: – id – code – name – jobpositionstructure properties: id: type: string description: Id do cargo code: type: string description: Código do cargo name: type: string description: Nome do cargo cbo: type: string description: CBO do cargo jobpositionstructure: type: string description: Id da estrutura de cargos creationDate: type: string description: Data de criação do cargo format: date expirationDate: type: string description: Data de extinção do cargo format: date apportionmentEntryException: type: object required: – id – apportionment – wageType – startDate – endDate – percentage properties: id: type: string description: Id da entidade employee: #/definitions/employee department: #/definitions/department jobPosition: #/definitions/jobposition company: #/definitions/company apportionment: #/definitions/apportionment wageType: #/definitions/wagetype startDate: type: string description: Data inicial format: date endDate: type: string description: Data final format: date percentage: type: number description: Percentual format: double isIntegration: type: boolean description: É integração? (campo calculado) entry13Salary: type: object required: – company – companyBranch – competence – employeeType – employee – value properties: id: type: string description: Id da entidade company: #/definitions/company companyBranch: #/definitions/company competence: type: string description: Competência format: date employeeType: #/definitions/employeeType employee: #/definitions/employee value: type: string description: Valor companyWageTypeTable: type: object required: – company – wageTypeTable properties: id: type: string description: Id da entidade company: #/definitions/company wageTypeTable: #/definitions/wageTypeTable 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