ms.worker-api.0.0.14-RELEASE.source-code.openapi.yml Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of worker-api Show documentation
Show all versions of worker-api Show documentation
Payroll Worker API project for Java 17
openapi: 3.0.0
info:
title: Regulations API
description: Regulations API specification
termsOfService: https://deepdreams.tech/terms-of-service
contact:
email: [email protected]
license:
name: Apache 2.0
url: https://www.deepdreams.tech/licenses/LICENSE-1.0.html
version: 0.0.1-SNAPSHOT
servers:
- url: http://alb-1015667293.eu-west-1.elb.amazonaws.com:8048
paths:
/api/regulations/v1/deduction/id/{id}:
get:
summary: Get deduction by id
x-amazon-apigateway-cache:
ttlInSeconds: 300
cachingEnabled: true
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: integer
format: int64
components:
schemas:
MinimumSalary:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/regulations/openapi.yml#/components/schemas/MinimumSalary'
WorkRisk:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/regulations/openapi.yml#/components/schemas/WorkRisk'
AllowanceScheme:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/regulations/openapi.yml#/components/schemas/AllowanceScheme'
Deduction:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/regulations/openapi.yml#/components/schemas/Deduction'
AdvantageInKind:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/regulations/openapi.yml#/components/schemas/AdvantageInKind'
CategorySalary:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/benefit/openapi.yml#/components/schemas/CategorySalary'
Benefit:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/benefit/openapi.yml#/components/schemas/Benefit'
Advance:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/benefit/openapi.yml#/components/schemas/Advance'
WorkingHours:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/attendance/openapi.yml#/components/schemas/WorkingHours'
Report:
type: object
properties:
id:
type: integer
format: int64
documentType:
type: string
payPeriod:
$ref: '#/components/schemas/PayPeriod'
employee:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/employee/openapi.yml#/components/schemas/Employee'
prefix:
type: string
fileName:
type: string
extension:
type: string
title:
type: string
Constant:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/regulations/openapi.yml#/components/schemas/Constant'
PayPeriodEvent:
type: object
properties:
id:
type: integer
format: int64
payPeriodId:
type: integer
format: int64
eventType:
type: string
eventDate:
type: string
format: date-time
subscriberId:
type: integer
format: int64
countryId:
type: integer
format: int64
startDate:
type: string
format: date
endDate:
type: string
format: date
workingHours:
type: number
format: double
enableOvertime:
type: boolean
enableAbsences:
type: boolean
enableSeniority:
type: boolean
PayPeriod:
type: object
properties:
id:
type: integer
format: int64
subscriber:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/subscriber/openapi.yml#/components/schemas/Subscriber'
year:
type: number
format: int32
startDate:
type: string
format: date
endDate:
type: string
format: date
workingHours:
type: number
format: double
enableOvertime:
type: boolean
enableAbsences:
type: boolean
enableSeniority:
type: boolean
status:
type: string
ConstantValue:
type: object
properties:
id:
type: integer
format: int64
constant:
$ref: '#/components/schemas/Constant'
value:
type: number
format: double
employee:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/employee/openapi.yml#/components/schemas/Employee'
payPeriod:
$ref: '#/components/schemas/PayPeriod'
description:
type: string
BenefitItem:
type: object
properties:
id:
type: integer
format: int64
payPeriod:
$ref: '#/components/schemas/PayPeriod'
payslip:
$ref: '#/components/schemas/Payslip'
employee:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/employee/openapi.yml#/components/schemas/Employee'
element:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/regulations/openapi.yml#/components/schemas/Element'
givenInKind:
type: boolean
amount:
type: number
format: decimal
number:
type: integer
format: int32
DeductionItem:
type: object
properties:
id:
type: integer
format: int64
payPeriod:
$ref: '#/components/schemas/PayPeriod'
payslip:
$ref: '#/components/schemas/Payslip'
employee:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/employee/openapi.yml#/components/schemas/Employee'
element:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/regulations/openapi.yml#/components/schemas/Element'
contributor:
type: string
basisAmount:
type: number
format: decimal
employeeRate:
type: number
format: float
employeeAmount:
type: number
format: decimal
employerRate:
type: number
format: float
employerAmount:
type: number
format: decimal
totalAmount:
type: number
format: decimal
Payslip:
type: object
properties:
id:
type: number
format: int64
payPeriod:
$ref: '#/components/schemas/PayPeriod'
employee:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/employee/openapi.yml#/components/schemas/Employee'
evalDate:
type: string
format: date-time
grossSalary:
type: number
format: decimal
netSalary:
type: number
format: decimal
employeeDeductions:
type: number
format: decimal
employerDeductions:
type: number
format: decimal
constantValues:
type: array
items:
$ref: '#/components/schemas/ConstantValue'
benefitItems:
type: array
items:
$ref: '#/components/schemas/BenefitItem'
deductionItems:
type: array
items:
$ref: '#/components/schemas/DeductionItem'
algoVersion:
type: integer
format: int32
EmployeeConstantValue:
type: object
properties:
employee:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/employee/openapi.yml#/components/schemas/Employee'
constantValues:
type: array
items:
$ref: '#/components/schemas/ConstantValue'
EmployeePayslip:
type: object
properties:
employee:
$ref: 'https://deepdreams-openapi.s3.eu-west-1.amazonaws.com/employee/openapi.yml#/components/schemas/Employee'
payslip:
$ref: '#/components/schemas/Payslip'