Skip to content

Get First To Expire Time Trackers Balance

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

Get Statutory and Non-Statutory balances for Time Trackers with a "First To Expire" deduction order.

Request

Message: wsdlGetFirstToExpireTimeTrackersBalanceRequest

apiKeystringrequired

API key of the unit.

timeTrackersArray<ttFirstToExpireBalanceItem>required

Array of ttFirstToExpireBalanceItem records identifying which balances to fetch.

itemttFirstToExpireBalanceItem

An item in a first-to-expire time-tracker balance.

badgeNostringrequired

Badge number. Specify either this or userId.

Example1121
userIdintrequired

Employee ID. Specify either badgeNo or this.

Example56781
timeTrackerIdintrequired

Time tracker ID

Example1442
periodintrequired

Period (year) for periodized time trackers. Required for periodized time trackers.

Example2017
datestring

If not provided, the current date will be used.

Example2017-01-01
curl -X POST 'https://api.quinyx.com/FlexForceWebServices.php' \
  -H 'Content-Type: text/xml; charset=utf-8' \
  -H 'SOAPAction: "uri:FlexForce/wsdlGetFirstToExpireTimeTrackersBalance"' \
  --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:wsdlGetFirstToExpireTimeTrackersBalance>
    <apiKey xsi:type="xsd:string">string</apiKey>
    <timeTrackers xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:ttFirstToExpireBalanceItem[1]">
      <item xsi:type="tns:ttFirstToExpireBalanceItem">
        <badgeNo xsi:type="xsd:string">1121</badgeNo>
        <userId xsi:type="xsd:int">56781</userId>
        <timeTrackerId xsi:type="xsd:int">1442</timeTrackerId>
        <period xsi:type="xsd:int">2017</period>
        <date xsi:type="xsd:string">2017-01-01</date>
      </item>
    </timeTrackers>
    </tns:wsdlGetFirstToExpireTimeTrackersBalance>
  </soap:Body>
</soap:Envelope>
EOF

Response

Message: wsdlGetFirstToExpireTimeTrackersBalanceResponse

returnArray<ttFirstToExpireBalanceResultItem>

A ttFirstToExpireBalanceResult wrapping the resolved balances.

itemttFirstToExpireBalanceResultItem

An item in a first-to-expire time-tracker balance result.

userIdintrequired
Example56781
badgeNostringrequired
Example1121
timeTrackerIdintrequired

Time tracker ID

periodintrequired

Period (year)

balancedecimalrequired

The calculated balance

statutorydecimalrequired
nonStatutorydecimalrequired
datestringrequired
Example2017-01-01
validationErrorsArray<xsd:string>required

An array of validation error messages. Will be empty array if there are no errors

<?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:wsdlGetFirstToExpireTimeTrackersBalanceResponse>
    <return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:ttFirstToExpireBalanceResultItem[1]">
      <item xsi:type="tns:ttFirstToExpireBalanceResultItem">
        <userId xsi:type="xsd:int">56781</userId>
        <badgeNo xsi:type="xsd:string">1121</badgeNo>
        <timeTrackerId xsi:type="xsd:int">0</timeTrackerId>
        <period xsi:type="xsd:int">0</period>
        <balance xsi:type="xsd:decimal">0</balance>
        <statutory xsi:type="xsd:decimal">0</statutory>
        <nonStatutory xsi:type="xsd:decimal">0</nonStatutory>
        <date xsi:type="xsd:string">2017-01-01</date>
        <validationErrors xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[1]">
          <item xsi:type="xsd:string">string</item>
        </validationErrors>
      </item>
    </return>
    </tns:wsdlGetFirstToExpireTimeTrackersBalanceResponse>
  </soap:Body>
</soap:Envelope>

Change log

Date Description
2020-04-05 Method created.