Queries for the specified payroll wage item or set of items.
Request
Response
XMLOps
VB.NET
C#
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | <?xml version="1.0" encoding="utf-8"?> <?qbxml version="17.0"?> <QBXML> <QBXMLMsgsRq onError="stopOnError"> <PayrollItemWageQueryRq metaData="ENUMTYPE"> <!-- BEGIN OR --> <ListID >IDTYPE</ListID> <!-- optional, may repeat --> <!-- OR --> <FullName >STRTYPE</FullName> <!-- optional, may repeat --> <!-- OR --> <MaxReturned >INTTYPE</MaxReturned> <!-- optional --> <!-- ActiveStatus may have one of the following values: ActiveOnly [DEFAULT], InactiveOnly, All --> <ActiveStatus >ENUMTYPE</ActiveStatus> <!-- optional --> <FromModifiedDate >DATETIMETYPE</FromModifiedDate> <!-- optional --> <ToModifiedDate >DATETIMETYPE</ToModifiedDate> <!-- optional --> <!-- BEGIN OR --> <NameFilter> <!-- optional --> <!-- MatchCriterion may have one of the following values: StartsWith, Contains, EndsWith --> <MatchCriterion >ENUMTYPE</MatchCriterion> <!-- required --> <Name >STRTYPE</Name> <!-- required --> </NameFilter> <!-- OR --> <NameRangeFilter> <!-- optional --> <FromName >STRTYPE</FromName> <!-- optional --> <ToName >STRTYPE</ToName> <!-- optional --> </NameRangeFilter> <!-- END OR --> <!-- END OR --> <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat --> </PayrollItemWageQueryRq> <PayrollItemWageQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE"> <PayrollItemWageRet> <!-- optional, may repeat --> <ListID >IDTYPE</ListID> <!-- required --> <TimeCreated >DATETIMETYPE</TimeCreated> <!-- required --> <TimeModified >DATETIMETYPE</TimeModified> <!-- required --> <EditSequence >STRTYPE</EditSequence> <!-- required --> <Name >STRTYPE</Name> <!-- required --> <IsActive >BOOLTYPE</IsActive> <!-- optional --> <!-- WageType may have one of the following values: Bonus, Commission, HourlyOvertime, HourlyRegular, HourlySick, HourlyVacation, SalaryRegular, SalarySick, SalaryVacation --> <WageType >ENUMTYPE</WageType> <!-- required --> <ExpenseAccountRef> <!-- required --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </ExpenseAccountRef> </PayrollItemWageRet> </PayrollItemWageQueryRs> </QBXMLMsgsRq> </QBXML> |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | 'The following sample code is generated as an illustration of
'Creating requests and parsing responses ONLY
'This code is NOT intended to show best practices or ideal code
'Use at your most careful discretion
imports System
imports System.Net
imports System.Drawing
imports System.Collections
imports System.ComponentModel
imports System.Windows.Forms
imports System.Data
imports System.IO
imports Interop.QBFC16
Module com.intuit.idn.samples
Public Class Sample
Public Sub DoPayrollItemWageQuery()
Dim sessionBegun as Boolean
sessionBegun = False
Dim connectionOpen as Boolean
connectionOpen = False
Dim sessionManager as QBSessionManager
sessionManager = nothing
Try
'Create the session Manager object
sessionManager = new QBSessionManager
'Create the message set request object to hold our request
Dim requestMsgSet as IMsgSetRequest
requestMsgSet = sessionManager.CreateMsgSetRequest("US",16,0)
requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue
BuildPayrollItemWageQueryRq(requestMsgSet)
'Connect to QuickBooks and begin a session
sessionManager.OpenConnection("","Sample Code from OSR")
connectionOpen = True
sessionManager.BeginSession("", ENOpenMode.omDontCare)
sessionBegun = True
'Send the request and get the response from QuickBooks
Dim responseMsgSet as IMsgSetResponse
responseMsgSet = sessionManager.DoRequests(requestMsgSet)
'End the session and close the connection to QuickBooks
sessionManager.EndSession()
sessionBegun = False
sessionManager.CloseConnection()
connectionOpen = False
WalkPayrollItemWageQueryRs(responseMsgSet)
Catch e as Exception
MessageBox.Show(e.Message, "Error")
if (sessionBegun) then
sessionManager.EndSession()
End If
if (connectionOpen) then
sessionManager.CloseConnection()
End If
End Try
End Sub
Public Sub BuildPayrollItemWageQueryRq(requestMsgSet as IMsgSetRequest)
Dim PayrollItemWageQueryRq as IPayrollItemWageQuery
PayrollItemWageQueryRq= requestMsgSet.AppendPayrollItemWageQueryRq()
Dim ORListQueryElementType17272 as String
ORListQueryElementType17272 = "ListIDList"
if (ORListQueryElementType17272 == "ListIDList") then
'Set field value for ListIDList
'May create more than one of these if needed
PayrollItemWageQueryRq.ORListQuery.ListIDList.Add("200000-1011023419")
End If
if (ORListQueryElementType17272 == "FullNameList") then
'Set field value for FullNameList
'May create more than one of these if needed
PayrollItemWageQueryRq.ORListQuery.FullNameList.Add("ab")
End If
if (ORListQueryElementType17272 == "ListFilter") then
'Set field value for MaxReturned
PayrollItemWageQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6)
'Set field value for ActiveStatus
PayrollItemWageQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT])
'Set field value for FromModifiedDate
PayrollItemWageQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
'Set field value for ToModifiedDate
PayrollItemWageQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
Dim ORNameFilterElementType17273 as String
ORNameFilterElementType17273 = "NameFilter"
if (ORNameFilterElementType17273 == "NameFilter") then
'Set field value for MatchCriterion
PayrollItemWageQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith)
'Set field value for Name
PayrollItemWageQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab")
End If
if (ORNameFilterElementType17273 == "NameRangeFilter") then
'Set field value for FromName
PayrollItemWageQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab")
'Set field value for ToName
PayrollItemWageQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab")
End If
End If
'Set field value for IncludeRetElementList
'May create more than one of these if needed
PayrollItemWageQueryRq.IncludeRetElementList.Add("ab")
End Sub
Public Sub WalkPayrollItemWageQueryRs( responseMsgSet as IMsgSetResponse)
if (responseMsgSet is nothing) then
Exit Sub
End If
Dim responseList as IResponseList
responseList = responseMsgSet.ResponseList
if (responseList is nothing) then
Exit Sub
End If
'if we sent only one request, there is only one response, we'll walk the list for this sample
for j=0 to responseList.Count-1
Dim response as IResponse
response = responseList.GetAt(j)
'check the status code of the response, 0=ok, >0 is warning
if (response.StatusCode >= 0) then
'the request-specific response is in the details, make sure we have some
if (not response.Detail is nothing) then
'make sure the response is the type we're expecting
Dim responseType as ENResponseType
responseType = CType(response.Type.GetValue(),ENResponseType)
if (responseType == ENResponseType.rtPayrollItemWageQueryRs) then
'upcast to more specific type here, this is safe because we checked with response.Type check above
Dim PayrollItemWageRet as IPayrollItemWageRetList
PayrollItemWageRet = CType(response.Detail,IPayrollItemWageRetList)
WalkPayrollItemWageRet(PayrollItemWageRet)
End If
End If
End If
Next j
End Sub
Public Sub WalkPayrollItemWageRet(PayrollItemWageRet as IPayrollItemWageRetList)
if (PayrollItemWageRet is nothing) then
Exit Sub
End If
'Go through all the elements of IPayrollItemWageRetList
'Get value of ListID
Dim ListID17274 as String
ListID17274 = PayrollItemWageRet.ListID.GetValue()
'Get value of TimeCreated
Dim TimeCreated17275 as DateTime
TimeCreated17275 = PayrollItemWageRet.TimeCreated.GetValue()
'Get value of TimeModified
Dim TimeModified17276 as DateTime
TimeModified17276 = PayrollItemWageRet.TimeModified.GetValue()
'Get value of EditSequence
Dim EditSequence17277 as String
EditSequence17277 = PayrollItemWageRet.EditSequence.GetValue()
'Get value of Name
Dim Name17278 as String
Name17278 = PayrollItemWageRet.Name.GetValue()
'Get value of IsActive
if ( not PayrollItemWageRet.IsActive is nothing) then
Dim IsActive17279 as Boolean
IsActive17279 = PayrollItemWageRet.IsActive.GetValue()
End If
'Get value of WageType
Dim WageType17280 as ENWageType
WageType17280 = PayrollItemWageRet.WageType.GetValue()
'Get value of ListID
if ( not PayrollItemWageRet.ExpenseAccountRef.ListID is nothing) then
Dim ListID17281 as String
ListID17281 = PayrollItemWageRet.ExpenseAccountRef.ListID.GetValue()
End If
'Get value of FullName
if ( not PayrollItemWageRet.ExpenseAccountRef.FullName is nothing) then
Dim FullName17282 as String
FullName17282 = PayrollItemWageRet.ExpenseAccountRef.FullName.GetValue()
End If
End Sub
End Class
End Module
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 | //The following sample code is generated as an illustration of //Creating requests and parsing responses ONLY //This code is NOT intended to show best practices or ideal code //Use at your most careful discretion using System; using System.Net; using System.Drawing; using System.Collections; using System.ComponentModel; using System.Windows.Forms; using System.Data; using System.IO; using Interop.QBFC16; namespace com.intuit.idn.samples { public class Sample { public void DoPayrollItemWageQuery() { bool sessionBegun = false; bool connectionOpen = false; QBSessionManager sessionManager = null; try { //Create the session Manager object sessionManager = new QBSessionManager(); //Create the message set request object to hold our request IMsgSetRequest requestMsgSet = sessionManager.CreateMsgSetRequest("US",16,0); requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue; BuildPayrollItemWageQueryRq(requestMsgSet); //Connect to QuickBooks and begin a session sessionManager.OpenConnection("","Sample Code from OSR"); connectionOpen = true; sessionManager.BeginSession("", ENOpenMode.omDontCare); sessionBegun = true; //Send the request and get the response from QuickBooks IMsgSetResponse responseMsgSet = sessionManager.DoRequests(requestMsgSet); //End the session and close the connection to QuickBooks sessionManager.EndSession(); sessionBegun = false; sessionManager.CloseConnection(); connectionOpen = false; WalkPayrollItemWageQueryRs(responseMsgSet); } catch (Exception e) { MessageBox.Show(e.Message, "Error"); if (sessionBegun) { sessionManager.EndSession(); } if (connectionOpen) { sessionManager.CloseConnection(); } } } void BuildPayrollItemWageQueryRq(IMsgSetRequest requestMsgSet) { IPayrollItemWageQuery PayrollItemWageQueryRq= requestMsgSet.AppendPayrollItemWageQueryRq(); //Set attributes //Set field value for metaData PayrollItemWageQueryRq.metaData.SetValue("IQBENmetaDataType"); string ORListQueryElementType17261 = "ListIDList"; if (ORListQueryElementType17261 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed PayrollItemWageQueryRq.ORListQuery.ListIDList.Add("200000-1011023419"); } if (ORListQueryElementType17261 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed PayrollItemWageQueryRq.ORListQuery.FullNameList.Add("ab"); } if (ORListQueryElementType17261 == "ListFilter") { //Set field value for MaxReturned PayrollItemWageQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6); //Set field value for ActiveStatus PayrollItemWageQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]); //Set field value for FromModifiedDate PayrollItemWageQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); //Set field value for ToModifiedDate PayrollItemWageQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); string ORNameFilterElementType17262 = "NameFilter"; if (ORNameFilterElementType17262 == "NameFilter") { //Set field value for MatchCriterion PayrollItemWageQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith); //Set field value for Name PayrollItemWageQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab"); } if (ORNameFilterElementType17262 == "NameRangeFilter") { //Set field value for FromName PayrollItemWageQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab"); //Set field value for ToName PayrollItemWageQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab"); } } //Set field value for IncludeRetElementList //May create more than one of these if needed PayrollItemWageQueryRq.IncludeRetElementList.Add("ab"); } void WalkPayrollItemWageQueryRs(IMsgSetResponse responseMsgSet) { if (responseMsgSet == null) return; IResponseList responseList = responseMsgSet.ResponseList; if (responseList == null) return; //if we sent only one request, there is only one response, we'll walk the list for this sample for(int i=0; i < responseList.Count; i++) { IResponse response = responseList.GetAt(i); //check the status code of the response, 0=ok, >0 is warning if (response.StatusCode >= 0) { //the request-specific response is in the details, make sure we have some if (response.Detail != null) { //make sure the response is the type we're expecting ENResponseType responseType = (ENResponseType)response.Type.GetValue(); if (responseType == ENResponseType.rtPayrollItemWageQueryRs) { //upcast to more specific type here, this is safe because we checked with response.Type check above IPayrollItemWageRetList PayrollItemWageRet = (IPayrollItemWageRetList)response.Detail; WalkPayrollItemWageRet(PayrollItemWageRet); } } } } } void WalkPayrollItemWageRet(IPayrollItemWageRetList PayrollItemWageRet) { if (PayrollItemWageRet == null) return; //Go through all the elements of IPayrollItemWageRetList //Get value of ListID string ListID17263 = (string)PayrollItemWageRet.ListID.GetValue(); //Get value of TimeCreated DateTime TimeCreated17264 = (DateTime)PayrollItemWageRet.TimeCreated.GetValue(); //Get value of TimeModified DateTime TimeModified17265 = (DateTime)PayrollItemWageRet.TimeModified.GetValue(); //Get value of EditSequence string EditSequence17266 = (string)PayrollItemWageRet.EditSequence.GetValue(); //Get value of Name string Name17267 = (string)PayrollItemWageRet.Name.GetValue(); //Get value of IsActive if (PayrollItemWageRet.IsActive != null) { bool IsActive17268 = (bool)PayrollItemWageRet.IsActive.GetValue(); } //Get value of WageType ENWageType WageType17269 = (ENWageType)PayrollItemWageRet.WageType.GetValue(); //Get value of ListID if (PayrollItemWageRet.ExpenseAccountRef.ListID != null) { string ListID17270 = (string)PayrollItemWageRet.ExpenseAccountRef.ListID.GetValue(); } //Get value of FullName if (PayrollItemWageRet.ExpenseAccountRef.FullName != null) { string FullName17271 = (string)PayrollItemWageRet.ExpenseAccountRef.FullName.GetValue(); } } } } |