3.35 wsdlGetStandardBankHolidays
Description
This API relates to standard bank holidays and fetching the setup of those in Quinyx. Related Quinyc manual here https://quinyx.helpdocs.io/l/en/article/n421w2oyj8-bank-holidays
Request
Parameter | Data type | Required | Format/example | Comment |
apiKey | String | Mandatory | 1234-1234-1234-1234 | |
fromDate | String | Mandatory | 2020-01-01 | |
toDate | String | Mandatory | 2020-12-31 |
Response
Parameter | Data type | Required | Format/example | Comment |
standardBankHolidays | standardBankHoliday[] |
standardBankHoliday
Parameter | Data type | Required | Format/example | Comment |
id | Integer | Id of the Bank holiday | ||
redDate | String | yyyy-mm-dd example 2020-12-24 | Date of the Bank holiday | |
description | String | New years day | Name of the Bank holiday | |
oType | Integer | 0=always 1= if shift starts on this calendar day. 2= if shift start on prior calendar day 3 = if shift xstarts on this or prior calendar day | ||
reduxBefRedDay | Decimal | example: 100.00 or 0.00 or 50.00 | The reduction of nominal hours on a day before bankholiday | |
reduxBefRedDayType | Integer | 0 = percent 1 = hours | If the reduction is in percent or hours | |
reduxRedDay | Decimal | example: 100.00 or 0.00 or 50.00 | The reduction of nominal hours on a bankholiday | |
reduxRedDayType | Integer | 0 = percent 1 = hours | If the reduction is in percent or hours | |
countAsScheduledHours | Integer | Select and define times if only certain times are to be counted against overtime and the unsocial hours limit. | ||
countAsScheduledFrom | String | 00:00:00 | ||
countAsScheduledTo | String | 00:00:00 | ||
canScheduleTwoYears | Integer | 0 = No 1 = Yes | ||
noDates | Array of string | Defined dates that if they are scheduled on this date, They then can not be scheduled on the defined date | ||
salaryTypeRules | bankHolidaysSalaryTypeRule[] | Array of rules, see below for definition | ||
manualSalaries | bankHolidayManualSalary[] | Array of manual salaries, see below for definition | ||
overtimes | standardOvertime[] | Array of standardovertime for the bank holida | ||
validity | Integer | |||
createLeaveIfScheduled | Integer | 0 = No 1 = Yes | Enter if leave is to be created if there is no time punch | |
createLeaveReasonId | Integer | 12356 | If above is set to 1. What leavereason is to be created | |
onlyTheseUnitGroups | String | [490,855] | The unit groups the bank holiday is connected to | |
validationErrors | Array of string |
BankHolidayRule
Parameter | Data type | Required | Format/example | Comment |
stCode | String | 4032 | salarytype code | |
fromTime | String | 00:00:00 | ||
fromType | Integer | 0 = Day before 1 = Same day 2 = Day after | From what day the rule is defined | |
toTime | String | 00:00:00 | ||
toType | Integer | 0 = Day before 1 = Same day 2 = Day after | From what day the rule is defined | |
amount | Decimal | 1.5 | If amount type = 2 then an amount can be set | |
amountType | Integer | 0 = Punched hours 1 = Scheduled hours 2 = Exactly 3 = Nominal hours | ||
hasWorkRequirement | Boolean | true=1 false=0 | ||
workRequirement | Integer | |||
hasShiftRequirement | Boolean | true=1 false=0 | ||
shiftRequirement | Integer | |||
leaveTypeId | Integer | |||
hasAlternateSalary | Boolean | true=1 false=0 | ||
alternateAmount | Decimal | |||
alternateStCode | Integer | |||
alternateFromTime | String | |||
alternateFromType | Integer | |||
alternateToTime | String | |||
alternateToType | Integer | |||
replaceBaseSalaries | Boolean | true=1 false=0 | ||
replaceUTSalaries | Boolean | true=1 false=0 | ||
replaceATSalaries | Boolean | true=1 false=0 | ||
replaceOTSalaries | Boolean | true=1 false=0 | ||
leaveReasons | String | |||
replaceSickLeaveSalaries | Boolean | true=1 false=0 | ||
eligibilityRuleIds | String | |||
validationErrors | Array of strings |
BankHolidayManualSalary
Parameter | Data type | Required | Format/example | Comment |
id | Integer | |||
salTypeStCode1 | Integer | |||
functionType | Integer | |||
timeIntervalType | Integer | |||
multiFactor | Decimal | |||
salTypeStCode2 | Integer | |||
ruleCondition | Integer | |||
ruleOperator | Integer | |||
ruleSalaryTypeStCode | Integer | |||
ruleWorkedHrs | Decimal | |||
startTime | String | |||
endTime | String | |||
minMinutes | Decimal | |||
maxMinutes | Decimal | |||
refType | String | |||
comment | String | |||
parentRuleId | Integer | |||
inheritParent | Boolean | true=1 false=0 | ||
validationErrors | Array of String |
standardOvertime
Parameter | Data type | Required | Format/example | Comment |
overtimeFrom | String | |||
overtimeTo | String | |||
oType | Integer | |||
firstHours | Decimal | |||
firstType | Integer | |||
firstBeg | String | |||
firstEnd | String | |||
isAdditionalSalaryType | Integer | |||
replaceBaseSalaries | Integer | |||
validationErrors | Array of String |
Example request
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uri="uri:FlexForce">
<soapenv:Header/>
<soapenv:Body>
<uri:wsdlgetStandardBankHolidays soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<apiKey xsi:type="xsd:string">1234-1234-1234-1234</apiKey>
<fromDate xsi:type="xsd:string">2020-01-01</fromDate>
<toDate xsi:type="xsd:string">2020-12-31</toDate>
</uri:wsdlgetStandardBankHolidays>
</soapenv:Body>
</soapenv:Envelope>
Change log
Date | Released in version | Description | Author |
2020-06-10 | 374 | Method created. | Maroun Sleiman |
2020-07-22 | 380 | Added Bank id. | Marija Bogdanovic |