Get Agreement Templates V2

Operation: wsdlGetAgreementTemplatesV2
SOAP Action: uri:FlexForce/GetAgreementTemplatesV2
Service: FlexForce
Port: FlexForcePort
Style: rpc

Return agreement templates from Quinyx WFM. Templates capture shared employment terms that can be copied to individual agreements.

Every user in Quinyx WFM needs to have an agreement in order to be scheduled. An agreement contains all necessary information regarding the user’s employment such as working hours, salary, time rules, availability, overtime schedule etc. As many employees may share the same employment terms, it is possible to create agreement templates which can be copied to each employee’s agreement, saving a lot of time in configuration. This web service method is used to export agreement templates from Quinyx WFM. This is an update version that is more upto date with the information available for agreement templates.

Request

Message: wsdlGetAgreementTemplatesV2Request

apiKeystringrequired

API key of any unit on the customer.

GetAgreementTemplatesV2GetAgreementTemplatesV2

Filter set — see the GetAgreementTemplatesV2 type.

templateIdint

Pass in 0 to select all agreement templates.

extTemplateIdstring

This value can be used to identify the agreement template by an external code. Mapping of the external code to Quinyx internal id is done in settings>tables>integration keys

modifiedAfterstring

Pass an empty string ("") if this parameter should be ignored, or a date to return agreement templates modified later than that date.

FormatYYYY-MM-DD hh:mm:ss

curl -X POST 'https://api.quinyx.com/FlexForceWebServices.php' \
  -H 'Content-Type: text/xml; charset=utf-8' \
  -H 'SOAPAction: "uri:FlexForce/GetAgreementTemplatesV2"' \
  --data @- <<'EOF'
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="https://api.quinyx.com/soap/FlexForce">
  <soap:Body>
    <tns:wsdlGetAgreementTemplatesV2>
    <apiKey xsi:type="xsd:string">string</apiKey>
    <GetAgreementTemplatesV2 xsi:type="tns:GetAgreementTemplatesV2">
      <templateId xsi:type="xsd:int">0</templateId>
      <extTemplateId xsi:type="xsd:string">string</extTemplateId>
      <modifiedAfter xsi:type="xsd:string">string</modifiedAfter>
    </GetAgreementTemplatesV2>
    </tns:wsdlGetAgreementTemplatesV2>
  </soap:Body>
</soap:Envelope>
EOF

Response

Message: wsdlGetAgreementTemplatesV2Response

returnAgreementTemplatesV2Response

An AgreementTemplatesV2Response wrapping the matched templates and any validationErrors.

agreementTemplatesArray<AgreementTemplateV2>required

List of agreement templates matching the request filters.

itemAgreementTemplateV2

An agreement template (version 2) — defines defaults that agreements can inherit.

validationErrorsArray<xsd:string>required

Server-side validation errors, if any.

itemstring

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="https://api.quinyx.com/soap/FlexForce">
  <soap:Body>
    <tns:wsdlGetAgreementTemplatesV2Response>
    <return xsi:type="tns:AgreementTemplatesV2Response">
      <agreementTemplates xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:AgreementTemplateV2[1]">
        <item xsi:type="tns:AgreementTemplateV2">
          <id xsi:type="xsd:int">0</id>
          <extTemplateId xsi:type="xsd:string">string</extTemplateId>
          <restId xsi:type="xsd:int">0</restId>
          <templateName xsi:type="xsd:string">string</templateName>
          <hourly xsi:type="xsd:int">0</hourly>
          <comment xsi:type="xsd:string">string</comment>
          <schedulePeriodType xsi:type="xsd:int">0</schedulePeriodType>
          <schedulePeriodLength xsi:type="xsd:int">0</schedulePeriodLength>
          <schedulePeriodStartDate xsi:type="xsd:date">2024-01-01</schedulePeriodStartDate>
          <fullEmploymentDays xsi:type="xsd:decimal">0</fullEmploymentDays>
          <fullEmploymentDaysPerWeek xsi:type="xsd:int">0</fullEmploymentDaysPerWeek>
          <fullEmploymentHrs xsi:type="xsd:decimal">0</fullEmploymentHrs>
          <excludeSundaysInWorkHours xsi:type="xsd:boolean">true</excludeSundaysInWorkHours>
          <breakRounding xsi:type="xsd:boolean">true</breakRounding>
          <breakIsWorkTime xsi:type="xsd:boolean">true</breakIsWorkTime>
          <dayBreak xsi:type="xsd:string">string</dayBreak>
          <weeklyAvg xsi:type="xsd:decimal">0</weeklyAvg>
          <stdRedDays xsi:type="xsd:boolean">true</stdRedDays>
          <stdOverTime xsi:type="xsd:boolean">true</stdOverTime>
          <minHrsWeek xsi:type="xsd:decimal">0</minHrsWeek>
          <maxDays xsi:type="xsd:int">0</maxDays>
          <minFreeDays xsi:type="xsd:int">0</minFreeDays>
          <maxHourDay xsi:type="xsd:decimal">0</maxHourDay>
          <maxHourWeek xsi:type="xsd:decimal">0</maxHourWeek>
          <minRest xsi:type="xsd:decimal">0</minRest>
          <minRestWeek xsi:type="xsd:decimal">0</minRestWeek>
          <seqDays xsi:type="xsd:int">0</seqDays>
          <seqMaxDays xsi:type="xsd:int">0</seqMaxDays>
          <seqMaxHrs xsi:type="xsd:decimal">0</seqMaxHrs>
          <weekStart xsi:type="xsd:int">0</weekStart>
          <atDayBreak xsi:type="xsd:boolean">true</atDayBreak>
          <dayBreakRest xsi:type="xsd:string">string</dayBreakRest>
          <minBreak xsi:type="xsd:int">0</minBreak>
          <maxBreak xsi:type="xsd:int">0</maxBreak>
          <weeksAvail xsi:type="xsd:int">0</weeksAvail>
          <schedWeekEnds xsi:type="xsd:boolean">true</schedWeekEnds>
          <minWeekEndYear xsi:type="xsd:int">0</minWeekEndYear>
          <maxTimeWoBreak xsi:type="xsd:decimal">0</maxTimeWoBreak>
          <scheduleLockPeriod xsi:type="xsd:decimal">0</scheduleLockPeriod>
          <scheduleLockPeriodType xsi:type="xsd:int">0</scheduleLockPeriodType>
          <checkAvailability xsi:type="xsd:boolean">true</checkAvailability>
          <punchType xsi:type="xsd:int">0</punchType>
          <appPayOnAbsence xsi:type="xsd:boolean">true</appPayOnAbsence>
          <payOtime xsi:type="xsd:int">0</payOtime>
          <payUT xsi:type="xsd:int">0</payUT>
          <showIgnoreOtime xsi:type="xsd:boolean">true</showIgnoreOtime>
          <showUnspecifiedLeaveInWP xsi:type="xsd:boolean">true</showUnspecifiedLeaveInWP>
          <allowPunchingOnSubshifts xsi:type="xsd:boolean">true</allowPunchingOnSubshifts>
          <genMoretime xsi:type="xsd:boolean">true</genMoretime>
          <overtimeMethod xsi:type="xsd:int">0</overtimeMethod>
          <overtimeWindow xsi:type="xsd:int">0</overtimeWindow>
          <autoPunchOut xsi:type="xsd:decimal">0</autoPunchOut>
          <lateChange xsi:type="xsd:boolean">true</lateChange>
          <lateChangeUT xsi:type="xsd:int">0</lateChangeUT>
          <breakDayrest xsi:type="xsd:boolean">true</breakDayrest>
          <breakDayrestUT xsi:type="xsd:int">0</breakDayrestUT>
          <breakWeekrest xsi:type="xsd:boolean">true</breakWeekrest>
          <breakWeekrestUT xsi:type="xsd:int">0</breakWeekrestUT>
          <timeBank xsi:type="xsd:boolean">true</timeBank>
          <payrollSystem xsi:type="xsd:int">0</payrollSystem>
          <adjustForLeave xsi:type="xsd:boolean">true</adjustForLeave>
          <advancedTimeRules xsi:type="xsd:boolean">true</advancedTimeRules>
          <otCancelsUt xsi:type="xsd:boolean">true</otCancelsUt>
          <allowOverrideOverlapping xsi:type="xsd:boolean">true</allowOverrideOverlapping>
          <useSecondWeekend xsi:type="xsd:boolean">true</useSecondWeekend>
          <utThreshold xsi:type="xsd:decimal">0</utThreshold>
          <utThresholdType xsi:type="xsd:int">0</utThresholdType>
          <dailyOvertimeHours xsi:type="xsd:decimal">0</dailyOvertimeHours>
          <weeklyOvertimeHours xsi:type="xsd:decimal">0</weeklyOvertimeHours>
          <noCostPeriodStart xsi:type="xsd:string">string</noCostPeriodStart>
          <noCostPeriodEnd xsi:type="xsd:string">string</noCostPeriodEnd>
          <balancePeriodType xsi:type="xsd:int">0</balancePeriodType>
          <balancePeriodLength xsi:type="xsd:int">0</balancePeriodLength>
          <balancePeriodHours xsi:type="xsd:decimal">0</balancePeriodHours>
          <balancePeriodStartDate xsi:type="xsd:date">2024-01-01</balancePeriodStartDate>
          <useWorkDayModel xsi:type="xsd:boolean">true</useWorkDayModel>
          <availability xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:AvailabilityTimePeriod[1]">
            <item xsi:type="tns:AvailabilityTimePeriod">
              <weekDay xsi:type="xsd:int">0</weekDay>
              <availfrom xsi:type="xsd:string">string</availfrom>
              <availto xsi:type="xsd:string">string</availto>
              <weekNo xsi:type="xsd:int">0</weekNo>
            </item>
          </availability>
          <overtimePeriods xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:OvertimePeriod[1]">
            <item xsi:type="tns:OvertimePeriod">
              <weekDay xsi:type="xsd:int">0</weekDay>
              <overtimeFrom xsi:type="xsd:string">string</overtimeFrom>
              <overtimeTo xsi:type="xsd:string">string</overtimeTo>
              <oType xsi:type="xsd:int">0</oType>
              <altWeekDay xsi:type="xsd:int">0</altWeekDay>
            </item>
          </overtimePeriods>
          <utPeriods xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:OvertimePeriod[1]">
            <item xsi:type="tns:OvertimePeriod">
              <weekDay xsi:type="xsd:int">0</weekDay>
              <overtimeFrom xsi:type="xsd:string">string</overtimeFrom>
              <overtimeTo xsi:type="xsd:string">string</overtimeTo>
              <oType xsi:type="xsd:int">0</oType>
              <altWeekDay xsi:type="xsd:int">0</altWeekDay>
            </item>
          </utPeriods>
          <monthlyHours xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:MonthlyHours[1]">
            <item xsi:type="tns:MonthlyHours">
              <year xsi:type="xsd:int">0</year>
              <month xsi:type="xsd:int">0</month>
              <hours xsi:type="xsd:decimal">0</hours>
            </item>
          </monthlyHours>
          <overtimeMethods xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:agreementOvertimeMethod[1]">
            <item xsi:type="tns:agreementOvertimeMethod">
              <overtimeMethodId xsi:type="xsd:int">0</overtimeMethodId>
              <order xsi:type="xsd:int">0</order>
            </item>
          </overtimeMethods>
          <punchDeviations xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:punchRounding[1]">
            <item xsi:type="tns:punchRounding">
              <type xsi:type="xsd:int">0</type>
              <punchPart xsi:type="xsd:int">0</punchPart>
              <insideShift xsi:type="xsd:int">0</insideShift>
              <roundingRule xsi:type="xsd:int">0</roundingRule>
              <minutes xsi:type="xsd:decimal">0</minutes>
            </item>
          </punchDeviations>
          <employmentRates xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:EmploymentRate[1]">
            <item xsi:type="tns:EmploymentRate">
              <fromDate xsi:type="xsd:date">2024-01-01</fromDate>
              <rate xsi:type="xsd:decimal">0</rate>
            </item>
          </employmentRates>
          <nominalDaysPerWeek xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:NominalDayPerWeek[1]">
            <item xsi:type="tns:NominalDayPerWeek">
              <fromDate xsi:type="xsd:date">2024-01-01</fromDate>
              <nominalDaysPerWeek xsi:type="xsd:int">0</nominalDaysPerWeek>
            </item>
          </nominalDaysPerWeek>
          <salaries xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:AgreementSalary[1]">
            <item xsi:type="tns:AgreementSalary">
              <fromDate xsi:type="xsd:date">2024-01-01</fromDate>
              <hourlySalary xsi:type="xsd:decimal">0</hourlySalary>
              <monthlySalary xsi:type="xsd:decimal">0</monthlySalary>
              <monthlyHoursDivisor xsi:type="xsd:decimal">0</monthlyHoursDivisor>
            </item>
          </salaries>
          <salaryAdditionsAgeBased xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:SalaryAdditionByYear[1]">
            <item xsi:type="tns:SalaryAdditionByYear">
              <from xsi:type="xsd:decimal">5</from>
              <salaryAddition xsi:type="xsd:decimal">100.00</salaryAddition>
            </item>
          </salaryAdditionsAgeBased>
          <ageBasedSalaryAdditionCalcMode xsi:type="xsd:int">0</ageBasedSalaryAdditionCalcMode>
          <salaryAdditionsYearsWorkedBased xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:SalaryAdditionByYear[1]">
            <item xsi:type="tns:SalaryAdditionByYear">
              <from xsi:type="xsd:decimal">5</from>
              <salaryAddition xsi:type="xsd:decimal">100.00</salaryAddition>
            </item>
          </salaryAdditionsYearsWorkedBased>
          <yearsWorkedBasedSalaryAdditionCalcMode xsi:type="xsd:int">0</yearsWorkedBasedSalaryAdditionCalcMode>
          <useStdBreakCreationRules xsi:type="xsd:boolean">true</useStdBreakCreationRules>
          <breakCalculationRules xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:BreakCalculationRule[1]">
            <item xsi:type="tns:BreakCalculationRule">
              <weekday xsi:type="xsd:int">0</weekday>
              <hours xsi:type="xsd:decimal">5.2</hours>
              <breakMinutes xsi:type="xsd:int">15</breakMinutes>
              <breakType xsi:type="xsd:int">0</breakType>
              <distribute xsi:type="xsd:int">0</distribute>
              <noOfBreaks xsi:type="xsd:int">1</noOfBreaks>
              <afterHours xsi:type="xsd:decimal">0</afterHours>
            </item>
          </breakCalculationRules>
          <minShiftLenghts xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:MinShiftLength[1]">
            <item xsi:type="tns:MinShiftLength">
              <fromTime xsi:type="xsd:string">string</fromTime>
              <toTime xsi:type="xsd:string">string</toTime>
              <length xsi:type="xsd:decimal">0</length>
            </item>
          </minShiftLenghts>
          <bankHolidays xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:BankHoliday[1]">
            <item xsi:type="tns:BankHoliday">
              <date xsi:type="xsd:date">2024-01-01</date>
              <description xsi:type="xsd:string">string</description>
            </item>
          </bankHolidays>
          <socialCosts xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:SocialCost[1]">
            <item xsi:type="tns:SocialCost">
              <type xsi:type="xsd:int">0</type>
              <fromAge xsi:type="xsd:int">0</fromAge>
              <toAge xsi:type="xsd:int">0</toAge>
              <startOn xsi:type="xsd:int">0</startOn>
              <costPercent xsi:type="xsd:decimal">0</costPercent>
            </item>
          </socialCosts>
          <salaryCostPeriods xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:SalaryCostPeriod[1]">
            <item xsi:type="tns:SalaryCostPeriod">
              <fromDate xsi:type="xsd:date">2024-01-01</fromDate>
              <periodType xsi:type="xsd:int">0</periodType>
              <periodLength xsi:type="xsd:int">0</periodLength>
            </item>
          </salaryCostPeriods>
          <salaryCostLimits xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:SalaryCostLimit[1]">
            <item xsi:type="tns:SalaryCostLimit">
              <fromDate xsi:type="xsd:date">2024-01-01</fromDate>
              <limit xsi:type="xsd:decimal">0</limit>
            </item>
          </salaryCostLimits>
          <ts xsi:type="xsd:dateTime">2024-01-01T00:00:00Z</ts>
        </item>
      </agreementTemplates>
      <validationErrors xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[1]">
        <item xsi:type="xsd:string">string</item>
      </validationErrors>
    </return>
    </tns:wsdlGetAgreementTemplatesV2Response>
  </soap:Body>
</soap:Envelope>

Change log

Date	Description
2017-10-04	New service
2017-12-06	Added salary additions year
2018-01-12	Added break calculation rules
2020-05-11	Added `salaryCostPeriods` and `salaryCostLimits`