PayrollBenefit

GetPayrollBenefitsPerEmployee

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>
employeeUid required	string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}/benefits

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

[{"payrollEmployeeFk": 0,
"benefitName": "string",
"benefitUid": "00000000-0000-0000-0000-000000000000",
"benefitFk": 0,
"benefitType": 0,
"name": "string",
"isProrated": true,
"pbsNumber": "string",
"includedInPensionBase": true,
"includedInAmPensionBase": true,
"includedInHolidayEntitlementSalaryBase": true,
"pricePerMonth": 0,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]

InsertPayrollBenefitPerEmployee

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>
employeeUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

benefitUid required	string <uuid>
pricePerMonth	number <double>
name	string [ 0 .. 80 ] characters
isProrated	boolean
pbsNumber	string
companyContribution	number <double>
includedInPensionBase	boolean
includedInAmPensionBase	boolean
includedInHolidayEntitlementSalaryBase	boolean

Responses

200

OK

post/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}/benefits

Request samples

{"benefitUid": "00000000-0000-0000-0000-000000000000",
"pricePerMonth": 0,
"name": "string",
"isProrated": true,
"pbsNumber": "string",
"companyContribution": 0,
"includedInPensionBase": true,
"includedInAmPensionBase": true,
"includedInHolidayEntitlementSalaryBase": true
}

Response samples

200

{"pricePerMonth": 0,
"benefitBase": {"name": "string",
"type": 0,
"resource": "string",
"includedInPensionBase": true,
"includedInAmPensionBase": true,
"includedInHolidayEntitlementSalaryBase": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
},
"name": "string",
"isEditable": true,
"pbsNumber": "string",
"companyContribution": 0,
"includedInPensionBase": true,
"includedInAmPensionBase": true,
"includedInHolidayEntitlementSalaryBase": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}

DeletePayrollBenefitPerEmployee

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>
employeeUid required	string <uuid>
payrollBenefitUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

delete/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}/benefits/{payrollBenefitUid}

Request samples

C#
Java
Python
JavaScript
curl

PatchPayrollBenefitPerEmployee

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
payrollUid required	string <uuid>
employeeUid required	string <uuid>
payrollBenefitUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

pricePerMonth	number <double>
name	string [ 0 .. 80 ] characters
isProrated	boolean
pbsNumber	string
companyContribution	number <double>
includedInPensionBase	boolean
includedInAmPensionBase	boolean
includedInHolidayEntitlementSalaryBase	boolean

Responses

204

No Content

patch/api/companies/{companyUid}/payroll/{payrollUid}/employees/{employeeUid}/benefits/{payrollBenefitUid}

Request samples

{"pricePerMonth": 0,
"name": "string",
"isProrated": true,
"pbsNumber": "string",
"companyContribution": 0,
"includedInPensionBase": true,
"includedInAmPensionBase": true,
"includedInHolidayEntitlementSalaryBase": true
}

PayrollBenefit

GetPayrollBenefitsPerEmployee

path Parameters

query Parameters

InsertPayrollBenefitPerEmployee

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

DeletePayrollBenefitPerEmployee

path Parameters

query Parameters

PatchPayrollBenefitPerEmployee

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

Request Body schema:
application/json

Request Body schema:
application/json