Ruby

Xero Add a Payroll Timesheet with Lines

Demonstrates how to POST a timesheet with lines (for Xero Payroll).

Note: This example requires Chilkat v9.5.0.64 or greater.

Ruby

require 'chilkat'

success = false

# Note: Requires Chilkat v9.5.0.64 or greater.

# This requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

rest = Chilkat::CkRest.new()

# Before sending REST API calls, the REST object needs to be
# initialized for OAuth1.
# See Xero 2-Legged OAuth1 Setup for sample code.

# Assuming the REST object's OAuth1 authenticator is setup, and the initial
# connection was made, we may now send REST HTTP requests..

# --------------------------------------------------------------
# Build the following XML:

# 	<Timesheets> 
# 	  <Timesheet>  
# 	    <EmployeeID>1f606d28-0537-42af-80ce-312d449458af</EmployeeID> 
# 	    <StartDate>2016-11-22</StartDate> 
# 	    <EndDate>2016-11-28</EndDate> 
# 	    <Status>Draft</Status> 
# 	    <TimesheetLines> 
# 	        <TimesheetLine> 
# 	            <EarningsRateID>2c4fbb29-aa68-4a8d-bc05-3f6366f75227</EarningsRateID> 
# 	            <NumberOfUnits> 
# 	                <NumberOfUnit>8.00</NumberOfUnit> 
# 	                <NumberOfUnit>8.00</NumberOfUnit> 
# 	                <NumberOfUnit>8.00</NumberOfUnit> 
# 	                <NumberOfUnit>8.00</NumberOfUnit> 
# 	                <NumberOfUnit>8.00</NumberOfUnit> 
# 	                <NumberOfUnit>0.00</NumberOfUnit> 
# 	                <NumberOfUnit>0.00</NumberOfUnit> 
# 	            </NumberOfUnits> 
# 	        </TimesheetLine> 
# 	    </TimesheetLines> 
# 	  </Timesheet> 
# 	</Timesheets>  

xml = Chilkat::CkXml.new()
xml.put_Tag("Timesheets")
xml.NewChild2("Timesheet|EmployeeID","1f606d28-0537-42af-80ce-312d449458af")
xml.NewChild2("Timesheet|StartDate","2016-11-22")
xml.NewChild2("Timesheet|EndDate","2016-11-28")
xml.NewChild2("Timesheet|Status","Draft")
xml.NewChild2("Timesheet|TimesheetLines|TimesheetLine|EarningsRateID","2c4fbb29-aa68-4a8d-bc05-3f6366f75227")
tagPath = "Timesheet|TimesheetLines|TimesheetLine|NumberOfUnits|NumberOfUnit"
xml.NewChild2(tagPath,"8.00")
xml.NewChild2(tagPath,"8.00")
xml.NewChild2(tagPath,"8.00")
xml.NewChild2(tagPath,"8.00")
xml.NewChild2(tagPath,"8.00")
xml.NewChild2(tagPath,"0.00")
xml.NewChild2(tagPath,"0.00")

# Do not emit the XML declarator. Xero does not accept the XML if it
# has the initial line: <?xml version="1.0" encoding="utf-8"?>
xml.put_EmitXmlDecl(false)
print xml.getXml() + "\n";
print "--" + "\n";

xml.put_EmitCompact(true)

rest.AddQueryParam("xml",xml.getXml())

responseXml = rest.fullRequestFormUrlEncoded("POST","/payroll.xro/1.0/Timesheets")
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

# A 200 response is expected for actual success.
if (rest.get_ResponseStatusCode() != 200)
    print responseXml + "\n";
    exit
end

# Examine the XML response
xml.LoadXml(responseXml)
print xml.getXml() + "\n";

# A successful XML response is as follows:

# 	<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
# 	    <Id>f213ed01-5a70-4adf-b11f-1aa0c74b96ac</Id>
# 	    <Status>OK</Status>
# 	    <ProviderName>ChilkatAU</ProviderName>
# 	    <DateTimeUTC>2016-11-11T22:39:10.2293174Z</DateTimeUTC>
# 	    <Timesheets>
# 	        <Timesheet>
# 	            <TimesheetID>f62b4437-62b8-4d21-b0c6-791999652712</TimesheetID>
# 	            <EmployeeID>1f606d28-0537-42af-80ce-312d449458af</EmployeeID>
# 	            <StartDate>2016-11-22T00:00:00</StartDate>
# 	            <EndDate>2016-11-28T00:00:00</EndDate>
# 	            <Status>DRAFT</Status>
# 	            <Hours>40.00</Hours>
# 	            <TimesheetLines>
# 	                <TimesheetLine>
# 	                    <EarningsRateID>2c4fbb29-aa68-4a8d-bc05-3f6366f75227</EarningsRateID>
# 	                    <NumberOfUnits>
# 	                        <NumberOfUnit>8.00</NumberOfUnit>
# 	                        <NumberOfUnit>8.00</NumberOfUnit>
# 	                        <NumberOfUnit>8.00</NumberOfUnit>
# 	                        <NumberOfUnit>8.00</NumberOfUnit>
# 	                        <NumberOfUnit>8.00</NumberOfUnit>
# 	                        <NumberOfUnit>0.00</NumberOfUnit>
# 	                        <NumberOfUnit>0.00</NumberOfUnit>
# 	                    </NumberOfUnits>
# 	                    <UpdatedDateUTC>2016-11-11T22:39:10.1824429</UpdatedDateUTC>
# 	                </TimesheetLine>
# 	            </TimesheetLines>
# 	            <UpdatedDateUTC>2016-11-11T22:39:10.1824429</UpdatedDateUTC>
# 	        </Timesheet>
# 	    </Timesheets>
# 	</Response