EmployeeSupplementsAndDeductionsRegistrations

GetRegistrationBaseDtoQuery

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Responses

200

get/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations

Request samples

C#
Java
Python
JavaScript
curl

Response samples

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"date": "2019-08-24T14:15:22Z",
"units": 0,
"rate": 0,
"total": 0,
"name": "string",
"description": "string",
"status": 0,
"employee": {"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"incomeType": 0
},
"supplementRate": {"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"createdOn": "2019-08-24T14:15:22Z",
"rate": 0,
"hours": 0,
"name": "string",
"number": "string",
"kontoNumber": "string",
"regNumber": "string",
"type": 0,
"sharedToAll": true,
"limitedToEmployee": true,
"isBenefitPackageTwoEnabled": true,
"overrideRate": true,
"isProratedRate": true,
"includeInPensionBase": true,
"includeInAmPensionBase": true,
"predefinedRateType": 0,
"isIncludedInHolidayEntitlementSalary": true,
"overrideName": true,
"useSupplementRates": true,
"useHourRates": true,
"composedRates": "string",
"calculateOnPercentage": true,
"percentage": 0,
"calculateOnGrossSalary": true,
"hasBookingGroupOverride": true,
"isFromTemplate": true,
"isInUse": true,
"isIncludedInHolidayEntitlementSalaryReduction": true
},
"projectId": "string",
"department": {"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"number": "string",
"hasWorkSchema": true
},
"attachmentCount": 0,
"countryUid": "00000000-0000-0000-0000-000000000000",
"countryName": "string",
"countryCode": "string",
"countryId": "string",
"countryTaxPercentage": 0,
"countryTaxableIncome": true,
"costCenterUid": "00000000-0000-0000-0000-000000000000",
"costCenterName": "string",
"costCenterCode": "string",
"triggerRetro": true,
"companyDepartmentUid": "00000000-0000-0000-0000-000000000000",
"companyProfitCenterUid": "00000000-0000-0000-0000-000000000000",
"percentage": 0,
"referenceId": "00000000-0000-0000-0000-000000000000"
}
]
}

InsertRegistrationAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Request Body schema:
application/json

date required	string <date-time>
rate	number <double>
units	number <double>
name	string [ 0 .. 100 ] characters
description	string
status	integer <int32> Enum: 0 1 2 3 4
rateUid	string <uuid>
attachmentUids	Array of strings <uuid>
projectId	string
countryUid	string <uuid>
countryTaxableIncome	boolean
costCenterUid	string <uuid>
countryTaxPercentage	number <double>
triggerRetro	boolean
companyDepartmentUid	string <uuid>
companyProfitCenterUid	string <uuid>
percentage	number <double>

Responses

200

post/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations

Request samples

{"date": "2019-08-24T14:15:22Z",
"rate": 0,
"units": 0,
"name": "string",
"description": "string",
"status": 0,
"rateUid": "00000000-0000-0000-0000-000000000000",
"attachmentUids": ["00000000-0000-0000-0000-000000000000"
],
"projectId": "string",
"countryUid": "00000000-0000-0000-0000-000000000000",
"countryTaxableIncome": true,
"costCenterUid": "00000000-0000-0000-0000-000000000000",
"countryTaxPercentage": 0,
"triggerRetro": true,
"companyDepartmentUid": "00000000-0000-0000-0000-000000000000",
"companyProfitCenterUid": "00000000-0000-0000-0000-000000000000",
"percentage": 0
}

Response samples

{"attachments": [{"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"date": "2019-08-24T14:15:22Z",
"units": 0,
"rate": 0,
"total": 0,
"name": "string",
"description": "string",
"status": 0,
"employee": {"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"incomeType": 0
},
"supplementRate": {"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"createdOn": "2019-08-24T14:15:22Z",
"rate": 0,
"hours": 0,
"name": "string",
"number": "string",
"kontoNumber": "string",
"regNumber": "string",
"type": 0,
"sharedToAll": true,
"limitedToEmployee": true,
"isBenefitPackageTwoEnabled": true,
"overrideRate": true,
"isProratedRate": true,
"includeInPensionBase": true,
"includeInAmPensionBase": true,
"predefinedRateType": 0,
"isIncludedInHolidayEntitlementSalary": true,
"overrideName": true,
"useSupplementRates": true,
"useHourRates": true,
"composedRates": "string",
"calculateOnPercentage": true,
"percentage": 0,
"calculateOnGrossSalary": true,
"hasBookingGroupOverride": true,
"isFromTemplate": true,
"isInUse": true,
"isIncludedInHolidayEntitlementSalaryReduction": true
},
"projectId": "string",
"department": {"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"number": "string",
"hasWorkSchema": true
},
"attachmentCount": 0,
"countryUid": "00000000-0000-0000-0000-000000000000",
"countryName": "string",
"countryCode": "string",
"countryId": "string",
"countryTaxPercentage": 0,
"countryTaxableIncome": true,
"costCenterUid": "00000000-0000-0000-0000-000000000000",
"costCenterName": "string",
"costCenterCode": "string",
"triggerRetro": true,
"companyDepartmentUid": "00000000-0000-0000-0000-000000000000",
"companyProfitCenterUid": "00000000-0000-0000-0000-000000000000",
"percentage": 0,
"referenceId": "00000000-0000-0000-0000-000000000000"
}

DeleteRegistrationsAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Responses

204

No Content

delete/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations

Request samples

C#
Java
Python
JavaScript
curl

GetEmployeeRegistrationAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeeUid required	string <uuid>
registrationUid required	string <uuid>

query Parameters

api-version

string

Responses

200

get/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/{registrationUid}

Request samples

C#
Java
Python
JavaScript
curl

Response samples

{"attachments": [{"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"date": "2019-08-24T14:15:22Z",
"units": 0,
"rate": 0,
"total": 0,
"name": "string",
"description": "string",
"status": 0,
"employee": {"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"incomeType": 0
},
"supplementRate": {"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"createdOn": "2019-08-24T14:15:22Z",
"rate": 0,
"hours": 0,
"name": "string",
"number": "string",
"kontoNumber": "string",
"regNumber": "string",
"type": 0,
"sharedToAll": true,
"limitedToEmployee": true,
"isBenefitPackageTwoEnabled": true,
"overrideRate": true,
"isProratedRate": true,
"includeInPensionBase": true,
"includeInAmPensionBase": true,
"predefinedRateType": 0,
"isIncludedInHolidayEntitlementSalary": true,
"overrideName": true,
"useSupplementRates": true,
"useHourRates": true,
"composedRates": "string",
"calculateOnPercentage": true,
"percentage": 0,
"calculateOnGrossSalary": true,
"hasBookingGroupOverride": true,
"isFromTemplate": true,
"isInUse": true,
"isIncludedInHolidayEntitlementSalaryReduction": true
},
"projectId": "string",
"department": {"id": 0,
"uid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"number": "string",
"hasWorkSchema": true
},
"attachmentCount": 0,
"countryUid": "00000000-0000-0000-0000-000000000000",
"countryName": "string",
"countryCode": "string",
"countryId": "string",
"countryTaxPercentage": 0,
"countryTaxableIncome": true,
"costCenterUid": "00000000-0000-0000-0000-000000000000",
"costCenterName": "string",
"costCenterCode": "string",
"triggerRetro": true,
"companyDepartmentUid": "00000000-0000-0000-0000-000000000000",
"companyProfitCenterUid": "00000000-0000-0000-0000-000000000000",
"percentage": 0,
"referenceId": "00000000-0000-0000-0000-000000000000"
}

DeleteRegistrationAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeeUid required	string <uuid>
registrationUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

delete/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/{registrationUid}

Request samples

C#
Java
Python
JavaScript
curl

UpdateRegistrationAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeeUid required	string <uuid>
registrationUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

date required	string <date-time>
rate	number <double>
units	number <double>
name	string [ 0 .. 100 ] characters
description	string
status	integer <int32> Enum: 0 1 2 3 4
rateUid	string <uuid>
attachmentUids	Array of strings <uuid>
projectId	string
countryUid	string <uuid>
countryTaxableIncome	boolean
costCenterUid	string <uuid>
countryTaxPercentage	number <double>
triggerRetro	boolean
companyDepartmentUid	string <uuid>
companyProfitCenterUid	string <uuid>
percentage	number <double>

Responses

204

No Content

patch/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/{registrationUid}

Request samples

{"date": "2019-08-24T14:15:22Z",
"rate": 0,
"units": 0,
"name": "string",
"description": "string",
"status": 0,
"rateUid": "00000000-0000-0000-0000-000000000000",
"attachmentUids": ["00000000-0000-0000-0000-000000000000"
],
"projectId": "string",
"countryUid": "00000000-0000-0000-0000-000000000000",
"countryTaxableIncome": true,
"costCenterUid": "00000000-0000-0000-0000-000000000000",
"countryTaxPercentage": 0,
"triggerRetro": true,
"companyDepartmentUid": "00000000-0000-0000-0000-000000000000",
"companyProfitCenterUid": "00000000-0000-0000-0000-000000000000",
"percentage": 0
}

GetEmployeeRegistrationAttachmentLocationAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeeUid required	string <uuid>
registrationUid required	string <uuid>
attachmentUid required	string <uuid>

query Parameters

api-version

string

Responses

200

get/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/{registrationUid}/attachments/{attachmentUid}

Request samples

C#
Java
Python
JavaScript
curl

Response samples

"string"

PostEmployeeRegistrationAttachmentsAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Responses

200

post/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/attachments

Request samples

C#
Java
Python
JavaScript
curl

Response samples

[{"name": "string",
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]

RejectRegistrationsAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Responses

204

No Content

patch/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/reject

Request samples

C#
Java
Python
JavaScript
curl

ApproveRegistrationsAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Responses

200

patch/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/approve

Request samples

C#
Java
Python
JavaScript
curl

Response samples

{"isSuccessPartial": true
}

PendingRegistrationsAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Responses

204

No Content

patch/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/pending

Request samples

C#
Java
Python
JavaScript
curl

ManuallyArchiveRegistrationsAsync

Securityoauth2

Request

path Parameters

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

query Parameters

api-version

string

Responses

204

No Content

patch/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/manuallyarchive

Request samples

C#
Java
Python
JavaScript
curl

RejectRegistrationAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeeUid required	string <uuid>
registrationUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/{registrationUid}/reject

Request samples

C#
Java
Python
JavaScript
curl

ApproveRegistrationAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeeUid required	string <uuid>
registrationUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/{registrationUid}/approve

Request samples

C#
Java
Python
JavaScript
curl

PendingRegistrationAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeeUid required	string <uuid>
registrationUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/{registrationUid}/pending

Request samples

C#
Java
Python
JavaScript
curl

ManuallyArchiveRegistrationAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
employeeUid required	string <uuid>
registrationUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

patch/api/companies/{companyUid}/employees/{employeeUid}/supplementsanddeductions/registrations/{registrationUid}/manuallyarchive

Request samples

C#
Java
Python
JavaScript
curl

EmployeeSupplementsAndDeductionsRegistrations

GetRegistrationBaseDtoQuery

path Parameters

query Parameters

InsertRegistrationAsync

path Parameters

query Parameters

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

DeleteRegistrationsAsync

path Parameters

query Parameters

GetEmployeeRegistrationAsync

path Parameters

query Parameters

DeleteRegistrationAsync

path Parameters

query Parameters

UpdateRegistrationAsync

path Parameters

query Parameters

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

GetEmployeeRegistrationAttachmentLocationAsync

path Parameters

query Parameters

PostEmployeeRegistrationAttachmentsAsync

path Parameters

query Parameters

RejectRegistrationsAsync

path Parameters

query Parameters

ApproveRegistrationsAsync

path Parameters

query Parameters

PendingRegistrationsAsync

path Parameters

query Parameters

ManuallyArchiveRegistrationsAsync

path Parameters

query Parameters

RejectRegistrationAsync

path Parameters

query Parameters

ApproveRegistrationAsync

path Parameters

query Parameters

PendingRegistrationAsync

path Parameters

query Parameters

ManuallyArchiveRegistrationAsync

path Parameters

query Parameters

Request Body schema:
application/json

Request Body schema:
application/json