CompanySupplementsAndDeductionsRates

GetSupplementRatesListDtoAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

200

get/api/companies/{companyUid}/supplementsanddeductions/rates/list

Request samples

C#
Java
Python
JavaScript
curl

Response samples

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"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
}
]
}

GetSupplementRatesExtendedDtoAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

skip	integer <int32>
take	integer <int32>
searchPhrase	string
	object (Zalary.SupplementsAndDeductions.Models.RateSortOptions)
override	Array of booleans
prorated	Array of booleans

Responses

200

post/api/companies/{companyUid}/supplementsanddeductions/rates/list

Request samples

{"skip": 0,
"take": 0,
"searchPhrase": "string",
"rateSortOptions": { },
"override": [true
],
"prorated": [true
]
}

Response samples

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"isOverridden": true,
"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
}
]
}

GetSupplementRatesForFilterDtoAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

200

get/api/companies/{companyUid}/supplementsanddeductions/rates/filter

Request samples

C#
Java
Python
JavaScript
curl

Response samples

[{"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
}
]

GetSettingsForSupplementRateTypesAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Responses

200

get/api/companies/{companyUid}/supplementsanddeductions/rates/settings

Request samples

C#
Java
Python
JavaScript
curl

Response samples

{"isActivatedSH": true,
"isActivatedFreeChoise": true,
"isActivatedFreeChoiceTwo": true,
"isActivatedTransferOrPayoutShNettoAmount": true,
"isTransferDaysOfHoliday": true,
"isHolidayHindranceDays": true,
"isExtraHolidayEntitlementInHoursEnabled": true,
"extraHolidayEntitlementInHours": true,
"includeSupplementsInHolidayCalculation": true
}

GetSupplementRateDtoAsync

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
supplementRateUid required	string <uuid>

query Parameters

api-version

string

Responses

200

get/api/companies/{companyUid}/supplementsanddeductions/rates/{supplementRateUid}

Request samples

C#
Java
Python
JavaScript
curl

Response samples

{"employees": ["00000000-0000-0000-0000-000000000000"
],
"departments": ["00000000-0000-0000-0000-000000000000"
],
"hourRates": [{"name": "string",
"number": "string",
"excludeHours": true,
"isBenefitsPackageTwoEnabled": true,
"timeInLieuEnabled": true,
"ratio": 0,
"isStandard": true,
"hourRateExtras": [{"uid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"extraHourRateDataType": "string",
"amountType": "string",
"amount": 0,
"hasOverride": true,
"accountNumber": "string",
"creditAccountNumber": "string",
"wageCode": "string",
"accountText": "string"
}
],
"isIncludeInStandardRateDataPresent": true,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"supplementRates": [{"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
}
],
"bookingGroupUids": ["00000000-0000-0000-0000-000000000000"
],
"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
}

DeleteSupplementRatesDtoQuery

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
supplementRateUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

delete/api/companies/{companyUid}/supplementsanddeductions/rates/{supplementRateUid}

Request samples

C#
Java
Python
JavaScript
curl

UpdateSupplementRatesDtoQuery

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
supplementRateUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

name required	string [ 0 .. 100 ] characters
number required	string
kontoNumber	string
regNumber	string
type	integer <int32> Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
rate	number <double>
sharedToAll	boolean
hours	number <double>
limitedToEmployee	boolean
isBenefitPackageTwoEnabled	boolean
overrideRate	boolean
employees required	Array of strings <uuid>
departments required	Array of strings <uuid>
isProratedRate	boolean
includeInPensionBase	boolean
includeInAmPensionBase	boolean
isIncludedInHolidayEntitlementSalary	boolean
overrideName	boolean
useSupplementRates	boolean
supplementRates	Array of strings <uuid>
useHourRates	boolean
hourRates	Array of strings <uuid>
calculateOnPercentage	boolean
percentage	number <double>
calculateOnGrossSalary	boolean
hasBookingGroupOverride	boolean
bookingGroupUids	Array of strings <uuid>
isIncludedInHolidayEntitlementSalaryReduction	boolean

Responses

204

No Content

patch/api/companies/{companyUid}/supplementsanddeductions/rates/{supplementRateUid}

Request samples

{"name": "string",
"number": "string",
"kontoNumber": "string",
"regNumber": "string",
"type": 0,
"rate": 0,
"sharedToAll": true,
"hours": 0,
"limitedToEmployee": true,
"isBenefitPackageTwoEnabled": true,
"overrideRate": true,
"employees": ["00000000-0000-0000-0000-000000000000"
],
"departments": ["00000000-0000-0000-0000-000000000000"
],
"isProratedRate": true,
"includeInPensionBase": true,
"includeInAmPensionBase": true,
"isIncludedInHolidayEntitlementSalary": true,
"overrideName": true,
"useSupplementRates": true,
"supplementRates": ["00000000-0000-0000-0000-000000000000"
],
"useHourRates": true,
"hourRates": ["00000000-0000-0000-0000-000000000000"
],
"calculateOnPercentage": true,
"percentage": 0,
"calculateOnGrossSalary": true,
"hasBookingGroupOverride": true,
"bookingGroupUids": ["00000000-0000-0000-0000-000000000000"
],
"isIncludedInHolidayEntitlementSalaryReduction": true
}

GetSupplementRatesDtoAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

currentRateUid	string <uuid>
api-version	string

Responses

200

get/api/companies/{companyUid}/supplementsanddeductions/rates

Request samples

C#
Java
Python
JavaScript
curl

Response samples

[{"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
}
]

InsertSupplementRatesDtoAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

name required	string [ 0 .. 100 ] characters
number required	string
kontoNumber	string
regNumber	string
type	integer <int32> Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
rate	number <double>
sharedToAll	boolean
hours	number <double>
limitedToEmployee	boolean
isBenefitPackageTwoEnabled	boolean
overrideRate	boolean
employees required	Array of strings <uuid>
departments required	Array of strings <uuid>
isProratedRate	boolean
includeInPensionBase	boolean
includeInAmPensionBase	boolean
isIncludedInHolidayEntitlementSalary	boolean
overrideName	boolean
useSupplementRates	boolean
supplementRates	Array of strings <uuid>
useHourRates	boolean
hourRates	Array of strings <uuid>
calculateOnPercentage	boolean
percentage	number <double>
calculateOnGrossSalary	boolean
hasBookingGroupOverride	boolean
bookingGroupUids	Array of strings <uuid>
isIncludedInHolidayEntitlementSalaryReduction	boolean

Responses

200

post/api/companies/{companyUid}/supplementsanddeductions/rates

Request samples

{"name": "string",
"number": "string",
"kontoNumber": "string",
"regNumber": "string",
"type": 0,
"rate": 0,
"sharedToAll": true,
"hours": 0,
"limitedToEmployee": true,
"isBenefitPackageTwoEnabled": true,
"overrideRate": true,
"employees": ["00000000-0000-0000-0000-000000000000"
],
"departments": ["00000000-0000-0000-0000-000000000000"
],
"isProratedRate": true,
"includeInPensionBase": true,
"includeInAmPensionBase": true,
"isIncludedInHolidayEntitlementSalary": true,
"overrideName": true,
"useSupplementRates": true,
"supplementRates": ["00000000-0000-0000-0000-000000000000"
],
"useHourRates": true,
"hourRates": ["00000000-0000-0000-0000-000000000000"
],
"calculateOnPercentage": true,
"percentage": 0,
"calculateOnGrossSalary": true,
"hasBookingGroupOverride": true,
"bookingGroupUids": ["00000000-0000-0000-0000-000000000000"
],
"isIncludedInHolidayEntitlementSalaryReduction": true
}

Response samples

{"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
}

DeleteSupplementOverridesAsync

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

companySupplementRatesUids

required

Array of strings <uuid>

Responses

204

No Content

post/api/companies/{companyUid}/supplementsanddeductions/rates/delete-overrides

Request samples

{"companySupplementRatesUids": ["00000000-0000-0000-0000-000000000000"
]
}

CompanySupplementsAndDeductionsRates

GetSupplementRatesListDtoAsync

path Parameters

query Parameters

GetSupplementRatesExtendedDtoAsync

path Parameters

query Parameters

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

GetSupplementRatesForFilterDtoAsync

path Parameters

query Parameters

GetSettingsForSupplementRateTypesAsync

path Parameters

query Parameters

GetSupplementRateDtoAsync

path Parameters

query Parameters

DeleteSupplementRatesDtoQuery

path Parameters

query Parameters

UpdateSupplementRatesDtoQuery

path Parameters

query Parameters

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

GetSupplementRatesDtoAsync

path Parameters

query Parameters

InsertSupplementRatesDtoAsync

path Parameters

query Parameters

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

DeleteSupplementOverridesAsync

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

Request Body schema:
application/json

Request Body schema:
application/json