Queries for the specified payment method or set of payment methods.
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 | <?xml version="1.0" encoding="utf-8"?> <?qbxml version="17.0"?> <QBXML> <QBXMLMsgsRq onError="stopOnError"> <PaymentMethodQueryRq 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 --> <!-- PaymentMethodType may have one of the following values: AmericanExpress, Cash, Check, DebitCard, Discover, ECheck, GiftCard, MasterCard, Other, OtherCreditCard, Visa --> <PaymentMethodType >ENUMTYPE</PaymentMethodType> <!-- optional, may repeat --> <!-- END OR --> <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat --> </PaymentMethodQueryRq> <PaymentMethodQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE"> <PaymentMethodRet> <!-- 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 --> <!-- PaymentMethodType may have one of the following values: AmericanExpress, Cash, Check, DebitCard, Discover, ECheck, GiftCard, MasterCard, Other, OtherCreditCard, Visa --> <PaymentMethodType >ENUMTYPE</PaymentMethodType> <!-- optional --> </PaymentMethodRet> </PaymentMethodQueryRs> </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 | '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 DoPaymentMethodQuery()
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
BuildPaymentMethodQueryRq(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
WalkPaymentMethodQueryRs(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 BuildPaymentMethodQueryRq(requestMsgSet as IMsgSetRequest)
Dim PaymentMethodQueryRq as IPaymentMethodQuery
PaymentMethodQueryRq= requestMsgSet.AppendPaymentMethodQueryRq()
Dim ORPaymentMethodListQueryElementType17168 as String
ORPaymentMethodListQueryElementType17168 = "ListIDList"
if (ORPaymentMethodListQueryElementType17168 == "ListIDList") then
'Set field value for ListIDList
'May create more than one of these if needed
PaymentMethodQueryRq.ORPaymentMethodListQuery.ListIDList.Add("200000-1011023419")
End If
if (ORPaymentMethodListQueryElementType17168 == "FullNameList") then
'Set field value for FullNameList
'May create more than one of these if needed
PaymentMethodQueryRq.ORPaymentMethodListQuery.FullNameList.Add("ab")
End If
if (ORPaymentMethodListQueryElementType17168 == "PaymentMethodListFilter") then
'Set field value for MaxReturned
PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.MaxReturned.SetValue(6)
'Set field value for ActiveStatus
PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT])
'Set field value for FromModifiedDate
PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
'Set field value for ToModifiedDate
PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
Dim ORNameFilterElementType17169 as String
ORNameFilterElementType17169 = "NameFilter"
if (ORNameFilterElementType17169 == "NameFilter") then
'Set field value for MatchCriterion
PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith)
'Set field value for Name
PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ORNameFilter.NameFilter.Name.SetValue("ab")
End If
if (ORNameFilterElementType17169 == "NameRangeFilter") then
'Set field value for FromName
PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab")
'Set field value for ToName
PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab")
End If
'Set field value for PaymentMethodTypeList
'May create more than one of these if needed
PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.PaymentMethodTypeList.Add(ENPaymentMethodTypeList.pmtlAmericanExpress)
End If
'Set field value for IncludeRetElementList
'May create more than one of these if needed
PaymentMethodQueryRq.IncludeRetElementList.Add("ab")
End Sub
Public Sub WalkPaymentMethodQueryRs( 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.rtPaymentMethodQueryRs) then
'upcast to more specific type here, this is safe because we checked with response.Type check above
Dim PaymentMethodRet as IPaymentMethodRetList
PaymentMethodRet = CType(response.Detail,IPaymentMethodRetList)
WalkPaymentMethodRet(PaymentMethodRet)
End If
End If
End If
Next j
End Sub
Public Sub WalkPaymentMethodRet(PaymentMethodRet as IPaymentMethodRetList)
if (PaymentMethodRet is nothing) then
Exit Sub
End If
'Go through all the elements of IPaymentMethodRetList
'Get value of ListID
Dim ListID17170 as String
ListID17170 = PaymentMethodRet.ListID.GetValue()
'Get value of TimeCreated
Dim TimeCreated17171 as DateTime
TimeCreated17171 = PaymentMethodRet.TimeCreated.GetValue()
'Get value of TimeModified
Dim TimeModified17172 as DateTime
TimeModified17172 = PaymentMethodRet.TimeModified.GetValue()
'Get value of EditSequence
Dim EditSequence17173 as String
EditSequence17173 = PaymentMethodRet.EditSequence.GetValue()
'Get value of Name
Dim Name17174 as String
Name17174 = PaymentMethodRet.Name.GetValue()
'Get value of IsActive
if ( not PaymentMethodRet.IsActive is nothing) then
Dim IsActive17175 as Boolean
IsActive17175 = PaymentMethodRet.IsActive.GetValue()
End If
'Get value of PaymentMethodType
if ( not PaymentMethodRet.PaymentMethodType is nothing) then
Dim PaymentMethodType17176 as ENPaymentMethodType
PaymentMethodType17176 = PaymentMethodRet.PaymentMethodType.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 | //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 DoPaymentMethodQuery() { 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; BuildPaymentMethodQueryRq(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; WalkPaymentMethodQueryRs(responseMsgSet); } catch (Exception e) { MessageBox.Show(e.Message, "Error"); if (sessionBegun) { sessionManager.EndSession(); } if (connectionOpen) { sessionManager.CloseConnection(); } } } void BuildPaymentMethodQueryRq(IMsgSetRequest requestMsgSet) { IPaymentMethodQuery PaymentMethodQueryRq= requestMsgSet.AppendPaymentMethodQueryRq(); //Set attributes //Set field value for metaData PaymentMethodQueryRq.metaData.SetValue("IQBENmetaDataType"); string ORPaymentMethodListQueryElementType17159 = "ListIDList"; if (ORPaymentMethodListQueryElementType17159 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed PaymentMethodQueryRq.ORPaymentMethodListQuery.ListIDList.Add("200000-1011023419"); } if (ORPaymentMethodListQueryElementType17159 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed PaymentMethodQueryRq.ORPaymentMethodListQuery.FullNameList.Add("ab"); } if (ORPaymentMethodListQueryElementType17159 == "PaymentMethodListFilter") { //Set field value for MaxReturned PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.MaxReturned.SetValue(6); //Set field value for ActiveStatus PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]); //Set field value for FromModifiedDate PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); //Set field value for ToModifiedDate PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); string ORNameFilterElementType17160 = "NameFilter"; if (ORNameFilterElementType17160 == "NameFilter") { //Set field value for MatchCriterion PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith); //Set field value for Name PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ORNameFilter.NameFilter.Name.SetValue("ab"); } if (ORNameFilterElementType17160 == "NameRangeFilter") { //Set field value for FromName PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab"); //Set field value for ToName PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab"); } //Set field value for PaymentMethodTypeList //May create more than one of these if needed PaymentMethodQueryRq.ORPaymentMethodListQuery.PaymentMethodListFilter.PaymentMethodTypeList.Add(ENPaymentMethodTypeList.pmtlAmericanExpress); } //Set field value for IncludeRetElementList //May create more than one of these if needed PaymentMethodQueryRq.IncludeRetElementList.Add("ab"); } void WalkPaymentMethodQueryRs(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.rtPaymentMethodQueryRs) { //upcast to more specific type here, this is safe because we checked with response.Type check above IPaymentMethodRetList PaymentMethodRet = (IPaymentMethodRetList)response.Detail; WalkPaymentMethodRet(PaymentMethodRet); } } } } } void WalkPaymentMethodRet(IPaymentMethodRetList PaymentMethodRet) { if (PaymentMethodRet == null) return; //Go through all the elements of IPaymentMethodRetList //Get value of ListID string ListID17161 = (string)PaymentMethodRet.ListID.GetValue(); //Get value of TimeCreated DateTime TimeCreated17162 = (DateTime)PaymentMethodRet.TimeCreated.GetValue(); //Get value of TimeModified DateTime TimeModified17163 = (DateTime)PaymentMethodRet.TimeModified.GetValue(); //Get value of EditSequence string EditSequence17164 = (string)PaymentMethodRet.EditSequence.GetValue(); //Get value of Name string Name17165 = (string)PaymentMethodRet.Name.GetValue(); //Get value of IsActive if (PaymentMethodRet.IsActive != null) { bool IsActive17166 = (bool)PaymentMethodRet.IsActive.GetValue(); } //Get value of PaymentMethodType if (PaymentMethodRet.PaymentMethodType != null) { ENPaymentMethodType PaymentMethodType17167 = (ENPaymentMethodType)PaymentMethodRet.PaymentMethodType.GetValue(); } } } } |