Returns the list of built-in and user-defined currency objects that match the filters used in the request.
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 50 51 52 53 54 55 56 57 | <?xml version="1.0" encoding="utf-8"?> <?qbxml version="16.0"?> <QBXML> <QBXMLMsgsRq onError="stopOnError"> <CurrencyQueryRq 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 --> </CurrencyQueryRq> <CurrencyQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE"> <CurrencyRet> <!-- optional, may repeat --> <ListID >IDTYPE</ListID> <!-- optional --> <TimeCreated >DATETIMETYPE</TimeCreated> <!-- optional --> <TimeModified >DATETIMETYPE</TimeModified> <!-- optional --> <EditSequence >STRTYPE</EditSequence> <!-- optional --> <Name >STRTYPE</Name> <!-- optional --> <IsActive >BOOLTYPE</IsActive> <!-- optional --> <CurrencyCode >STRTYPE</CurrencyCode> <!-- optional --> <CurrencyFormat> <!-- optional --> <!-- ThousandSeparator may have one of the following values: Comma [DEFAULT], Period, Space, Apostrophe --> <ThousandSeparator >ENUMTYPE</ThousandSeparator> <!-- optional --> <!-- ThousandSeparatorGrouping may have one of the following values: XX_XXX_XXX [DEFAULT], X_XX_XX_XXX --> <ThousandSeparatorGrouping >ENUMTYPE</ThousandSeparatorGrouping> <!-- optional --> <!-- DecimalPlaces may have one of the following values: 0, 2 [DEFAULT] --> <DecimalPlaces >ENUMTYPE</DecimalPlaces> <!-- optional --> <!-- DecimalSeparator may have one of the following values: Period [DEFAULT], Comma --> <DecimalSeparator >ENUMTYPE</DecimalSeparator> <!-- optional --> </CurrencyFormat> <IsUserDefinedCurrency >BOOLTYPE</IsUserDefinedCurrency> <!-- optional --> <ExchangeRate >FLOATTYPE</ExchangeRate> <!-- optional --> <AsOfDate >DATETYPE</AsOfDate> <!-- optional --> </CurrencyRet> </CurrencyQueryRs> </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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | '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 DoCurrencyQuery() 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 BuildCurrencyQueryRq(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 WalkCurrencyQueryRs(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 BuildCurrencyQueryRq(requestMsgSet as IMsgSetRequest) Dim CurrencyQueryRq as ICurrencyQuery CurrencyQueryRq= requestMsgSet.AppendCurrencyQueryRq() Dim ORListQueryElementType6817 as String ORListQueryElementType6817 = "ListIDList" if (ORListQueryElementType6817 == "ListIDList") then 'Set field value for ListIDList 'May create more than one of these if needed CurrencyQueryRq.ORListQuery.ListIDList.Add("200000-1011023419") End If if (ORListQueryElementType6817 == "FullNameList") then 'Set field value for FullNameList 'May create more than one of these if needed CurrencyQueryRq.ORListQuery.FullNameList.Add("ab") End If if (ORListQueryElementType6817 == "ListFilter") then 'Set field value for MaxReturned CurrencyQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6) 'Set field value for ActiveStatus CurrencyQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]) 'Set field value for FromModifiedDate CurrencyQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false) 'Set field value for ToModifiedDate CurrencyQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false) Dim ORNameFilterElementType6818 as String ORNameFilterElementType6818 = "NameFilter" if (ORNameFilterElementType6818 == "NameFilter") then 'Set field value for MatchCriterion CurrencyQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith) 'Set field value for Name CurrencyQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab") End If if (ORNameFilterElementType6818 == "NameRangeFilter") then 'Set field value for FromName CurrencyQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab") 'Set field value for ToName CurrencyQueryRq.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 CurrencyQueryRq.IncludeRetElementList.Add("ab") End Sub Public Sub WalkCurrencyQueryRs( 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.rtCurrencyQueryRs) then 'upcast to more specific type here, this is safe because we checked with response.Type check above Dim CurrencyRet as ICurrencyRetList CurrencyRet = CType(response.Detail,ICurrencyRetList) WalkCurrencyRet(CurrencyRet) End If End If End If Next j End Sub Public Sub WalkCurrencyRet(CurrencyRet as ICurrencyRetList) if (CurrencyRet is nothing) then Exit Sub End If 'Go through all the elements of ICurrencyRetList 'Get value of ListID if ( not CurrencyRet.ListID is nothing) then Dim ListID6819 as String ListID6819 = CurrencyRet.ListID.GetValue() End If 'Get value of TimeCreated if ( not CurrencyRet.TimeCreated is nothing) then Dim TimeCreated6820 as DateTime TimeCreated6820 = CurrencyRet.TimeCreated.GetValue() End If 'Get value of TimeModified if ( not CurrencyRet.TimeModified is nothing) then Dim TimeModified6821 as DateTime TimeModified6821 = CurrencyRet.TimeModified.GetValue() End If 'Get value of EditSequence if ( not CurrencyRet.EditSequence is nothing) then Dim EditSequence6822 as String EditSequence6822 = CurrencyRet.EditSequence.GetValue() End If 'Get value of Name if ( not CurrencyRet.Name is nothing) then Dim Name6823 as String Name6823 = CurrencyRet.Name.GetValue() End If 'Get value of IsActive if ( not CurrencyRet.IsActive is nothing) then Dim IsActive6824 as Boolean IsActive6824 = CurrencyRet.IsActive.GetValue() End If 'Get value of CurrencyCode if ( not CurrencyRet.CurrencyCode is nothing) then Dim CurrencyCode6825 as String CurrencyCode6825 = CurrencyRet.CurrencyCode.GetValue() End If if (not CurrencyRet.CurrencyFormat. is nothing) then 'Get value of ThousandSeparator if ( not CurrencyRet.CurrencyFormat.ThousandSeparator is nothing) then Dim ThousandSeparator6826 as ENThousandSeparator ThousandSeparator6826 = CurrencyRet.CurrencyFormat.ThousandSeparator.GetValue() End If 'Get value of ThousandSeparatorGrouping if ( not CurrencyRet.CurrencyFormat.ThousandSeparatorGrouping is nothing) then Dim ThousandSeparatorGrouping6827 as ENThousandSeparatorGrouping ThousandSeparatorGrouping6827 = CurrencyRet.CurrencyFormat.ThousandSeparatorGrouping.GetValue() End If 'Get value of DecimalPlaces if ( not CurrencyRet.CurrencyFormat.DecimalPlaces is nothing) then Dim DecimalPlaces6828 as ENDecimalPlaces DecimalPlaces6828 = CurrencyRet.CurrencyFormat.DecimalPlaces.GetValue() End If 'Get value of DecimalSeparator if ( not CurrencyRet.CurrencyFormat.DecimalSeparator is nothing) then Dim DecimalSeparator6829 as ENDecimalSeparator DecimalSeparator6829 = CurrencyRet.CurrencyFormat.DecimalSeparator.GetValue() End If End If 'Get value of IsUserDefinedCurrency if ( not CurrencyRet.IsUserDefinedCurrency is nothing) then Dim IsUserDefinedCurrency6830 as Boolean IsUserDefinedCurrency6830 = CurrencyRet.IsUserDefinedCurrency.GetValue() End If 'Get value of ExchangeRate if ( not CurrencyRet.ExchangeRate is nothing) then Dim ExchangeRate6831 as IQBFloatType ExchangeRate6831 = CurrencyRet.ExchangeRate.GetValue() End If 'Get value of AsOfDate if ( not CurrencyRet.AsOfDate is nothing) then Dim AsOfDate6832 as DateTime AsOfDate6832 = CurrencyRet.AsOfDate.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 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 | //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 DoCurrencyQuery() { 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; BuildCurrencyQueryRq(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; WalkCurrencyQueryRs(responseMsgSet); } catch (Exception e) { MessageBox.Show(e.Message, "Error"); if (sessionBegun) { sessionManager.EndSession(); } if (connectionOpen) { sessionManager.CloseConnection(); } } } void BuildCurrencyQueryRq(IMsgSetRequest requestMsgSet) { ICurrencyQuery CurrencyQueryRq= requestMsgSet.AppendCurrencyQueryRq(); //Set attributes //Set field value for metaData CurrencyQueryRq.metaData.SetValue("IQBENmetaDataType"); string ORListQueryElementType6801 = "ListIDList"; if (ORListQueryElementType6801 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed CurrencyQueryRq.ORListQuery.ListIDList.Add("200000-1011023419"); } if (ORListQueryElementType6801 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed CurrencyQueryRq.ORListQuery.FullNameList.Add("ab"); } if (ORListQueryElementType6801 == "ListFilter") { //Set field value for MaxReturned CurrencyQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6); //Set field value for ActiveStatus CurrencyQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]); //Set field value for FromModifiedDate CurrencyQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); //Set field value for ToModifiedDate CurrencyQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); string ORNameFilterElementType6802 = "NameFilter"; if (ORNameFilterElementType6802 == "NameFilter") { //Set field value for MatchCriterion CurrencyQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith); //Set field value for Name CurrencyQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab"); } if (ORNameFilterElementType6802 == "NameRangeFilter") { //Set field value for FromName CurrencyQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab"); //Set field value for ToName CurrencyQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab"); } } //Set field value for IncludeRetElementList //May create more than one of these if needed CurrencyQueryRq.IncludeRetElementList.Add("ab"); } void WalkCurrencyQueryRs(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.rtCurrencyQueryRs) { //upcast to more specific type here, this is safe because we checked with response.Type check above ICurrencyRetList CurrencyRet = (ICurrencyRetList)response.Detail; WalkCurrencyRet(CurrencyRet); } } } } } void WalkCurrencyRet(ICurrencyRetList CurrencyRet) { if (CurrencyRet == null) return; //Go through all the elements of ICurrencyRetList //Get value of ListID if (CurrencyRet.ListID != null) { string ListID6803 = (string)CurrencyRet.ListID.GetValue(); } //Get value of TimeCreated if (CurrencyRet.TimeCreated != null) { DateTime TimeCreated6804 = (DateTime)CurrencyRet.TimeCreated.GetValue(); } //Get value of TimeModified if (CurrencyRet.TimeModified != null) { DateTime TimeModified6805 = (DateTime)CurrencyRet.TimeModified.GetValue(); } //Get value of EditSequence if (CurrencyRet.EditSequence != null) { string EditSequence6806 = (string)CurrencyRet.EditSequence.GetValue(); } //Get value of Name if (CurrencyRet.Name != null) { string Name6807 = (string)CurrencyRet.Name.GetValue(); } //Get value of IsActive if (CurrencyRet.IsActive != null) { bool IsActive6808 = (bool)CurrencyRet.IsActive.GetValue(); } //Get value of CurrencyCode if (CurrencyRet.CurrencyCode != null) { string CurrencyCode6809 = (string)CurrencyRet.CurrencyCode.GetValue(); } if (CurrencyRet.CurrencyFormat != null) { //Get value of ThousandSeparator if (CurrencyRet.CurrencyFormat.ThousandSeparator != null) { ENThousandSeparator ThousandSeparator6810 = (ENThousandSeparator)CurrencyRet.CurrencyFormat.ThousandSeparator.GetValue(); } //Get value of ThousandSeparatorGrouping if (CurrencyRet.CurrencyFormat.ThousandSeparatorGrouping != null) { ENThousandSeparatorGrouping ThousandSeparatorGrouping6811 = (ENThousandSeparatorGrouping)CurrencyRet.CurrencyFormat.ThousandSeparatorGrouping.GetValue(); } //Get value of DecimalPlaces if (CurrencyRet.CurrencyFormat.DecimalPlaces != null) { ENDecimalPlaces DecimalPlaces6812 = (ENDecimalPlaces)CurrencyRet.CurrencyFormat.DecimalPlaces.GetValue(); } //Get value of DecimalSeparator if (CurrencyRet.CurrencyFormat.DecimalSeparator != null) { ENDecimalSeparator DecimalSeparator6813 = (ENDecimalSeparator)CurrencyRet.CurrencyFormat.DecimalSeparator.GetValue(); } } //Get value of IsUserDefinedCurrency if (CurrencyRet.IsUserDefinedCurrency != null) { bool IsUserDefinedCurrency6814 = (bool)CurrencyRet.IsUserDefinedCurrency.GetValue(); } //Get value of ExchangeRate if (CurrencyRet.ExchangeRate != null) { IQBFloatType ExchangeRate6815 = (IQBFloatType)CurrencyRet.ExchangeRate.GetValue(); } //Get value of AsOfDate if (CurrencyRet.AsOfDate != null) { DateTime AsOfDate6816 = (DateTime)CurrencyRet.AsOfDate.GetValue(); } } } } |