This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Working with Pay Schedules in Xero

Owned by Former user (Deleted)
Last updated: Feb 25, 2015
3 min read

The getPaySchedules operation retrieves one or more pay schedules.

getPaySchedules
<xero.getPaySchedules>
    <payScheduleId>{$ctx:payScheduleId}</payScheduleId>
    <order>{$ctx:order}</order>
    <page>{$ctx:page}</page>
    <modifiedAfter>{$ctx:modifiedAfter}</modifiedAfter>
	<where>{$ctx:where}</where>
</xero.getPaySchedules>
Properties
  • payScheduleId: The identifier of a pay schedule.
  • order: The parameter by which the pay schedules to be retrieved are sorted.
  • page: The page number of the list of pay schedules that needs to be retrieved.
  • modifiedAfter: The time stamp after which it is modified. The timestamp after which the pay schedules are retrieved. If specified, only pay schedules created after this timestamp will be retrieved. 
  • where: The parameter by which the pay schedules to be retrieved are filtered.
Sample request

Following is a sample REST/XML request that can be handled by the getPaySchedules operation.

Sample Request for getPaySchedules
<getPaySchedules>
    <consumerKey>LMVNBEID7LSZ2L8KSOKJA73UJ8H8S0</consumerKey>
    <consumerSecret>SUJOX3Y6MQYHBQJ8QIAGWQVPIKDOO2</consumerSecret>
    <accessToken>17YN7PMAQCXPVIDMPXV55XC7VOEDBP</accessToken>
    <accessTokenSecret>LGAKWWCNYTW0F5NRUZEFREACUUEDS7</accessTokenSecret>
    <acceptType></acceptType>
    <apiUrl>https://api.xero.com</apiUrl>
    <payScheduleId></payScheduleId>
    <order></order>
    <page>1</page>
    <modifiedAfter></modifiedAfter>
	<where>PayScheduleName.contains("chamath1")</where>
</getPaySchedules>
Related Xero documentation
http://developer.xero.com/documentation/payroll-api-us/pay-schedules/#GET

Sample configuration

Following is a sample proxy service that illustrates how to connect to Xero with the init operation and use the getPaySchedules operation. The sample request for this proxy can be found in getPaySchedules sample request.

Sample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="xero_getPaySchedules"
       transports="https,http"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
      <inSequence onError="faultHandlerSeq">
         <property name="consumerKey" expression="//consumerKey/text()"/>
         <property name="accessToken" expression="//accessToken/text()"/>
         <property name="accessTokenSecret" expression="//accessTokenSecret/text()"/>
         <property name="apiUrl" expression="//apiUrl/text()"/>
         <property name="consumerSecret" expression="//consumerSecret/text()"/>
         <property name="payScheduleId" expression="//payScheduleId/text()"/>
         <property name="order" expression="//order/text()"/>
         <property name="page" expression="//page/text()"/>
         <property name="modifiedAfter" expression="//modifiedAfter/text()"/>
         <property name="where" expression="//where/text()"/>
         <property name="acceptType" expression="//acceptType/text()"/>
         <xero.init>
            <consumerKey>{$ctx:consumerKey}</consumerKey>
            <accessToken>{$ctx:accessToken}</accessToken>
            <accessTokenSecret>{$ctx:accessTokenSecret}</accessTokenSecret>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <consumerSecret>{$ctx:consumerSecret}</consumerSecret>
            <acceptType>{$ctx:acceptType}</acceptType>
         </xero.init>
         <xero.getPaySchedules>
            <payScheduleId>{$ctx:payScheduleId}</payScheduleId>
            <order>{$ctx:order}</order>
            <page>{$ctx:page}</page>
            <modifiedAfter>{$ctx:modifiedAfter}</modifiedAfter>
            <where>{$ctx:where}</where>
         </xero.getPaySchedules>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>