Adds a vendor type. A vendor type allows business owners to categorize vendors in ways that are meaningful for their businesses. For example, a vendor type might indicate which industry a vendor represents, or which part of the country a vendor is in.
A VendorTypeRef aggregate refers to one of the types on the VendorType list. In a request, if a VendorTypeRef aggregate includes both FullName and ListID, FullName will be ignored.
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 | <?xml version="1.0" encoding="utf-8"?> <?qbxml version="16.0"?> <QBXML> <QBXMLMsgsRq onError="stopOnError"> <VendorTypeAddRq> <VendorTypeAdd> <!-- required --> <Name >STRTYPE</Name> <!-- required --> <IsActive >BOOLTYPE</IsActive> <!-- optional --> <ParentRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </ParentRef> </VendorTypeAdd> <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat --> </VendorTypeAddRq> <VendorTypeAddRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE"> <VendorTypeRet> <!-- optional --> <ListID >IDTYPE</ListID> <!-- required --> <TimeCreated >DATETIMETYPE</TimeCreated> <!-- required --> <TimeModified >DATETIMETYPE</TimeModified> <!-- required --> <EditSequence >STRTYPE</EditSequence> <!-- required --> <Name >STRTYPE</Name> <!-- required --> <FullName >STRTYPE</FullName> <!-- required --> <IsActive >BOOLTYPE</IsActive> <!-- optional --> <ParentRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </ParentRef> <Sublevel >INTTYPE</Sublevel> <!-- required --> </VendorTypeRet> <ErrorRecovery> <!-- optional --> <!-- BEGIN OR --> <ListID >IDTYPE</ListID> <!-- optional --> <!-- OR --> <OwnerID >GUIDTYPE</OwnerID> <!-- optional --> <!-- OR --> <TxnID >IDTYPE</TxnID> <!-- optional --> <!-- END OR --> <TxnNumber >INTTYPE</TxnNumber> <!-- optional --> <EditSequence >STRTYPE</EditSequence> <!-- optional --> <ExternalGUID >GUIDTYPE</ExternalGUID> <!-- optional --> </ErrorRecovery> </VendorTypeAddRs> </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 | '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 DoVendorTypeAdd() 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 BuildVendorTypeAddRq(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 WalkVendorTypeAddRs(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 BuildVendorTypeAddRq(requestMsgSet as IMsgSetRequest) Dim VendorTypeAddRq as IVendorTypeAdd VendorTypeAddRq= requestMsgSet.AppendVendorTypeAddRq() 'Set field value for Name VendorTypeAddRq.Name.SetValue("ab") 'Set field value for IsActive VendorTypeAddRq.IsActive.SetValue(True) 'Set field value for ListID VendorTypeAddRq.ParentRef.ListID.SetValue("200000-1011023419") 'Set field value for FullName VendorTypeAddRq.ParentRef.FullName.SetValue("ab") 'Set field value for IncludeRetElementList 'May create more than one of these if needed VendorTypeAddRq.IncludeRetElementList.Add("ab") End Sub Public Sub WalkVendorTypeAddRs( 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.rtVendorTypeAddRs) then 'upcast to more specific type here, this is safe because we checked with response.Type check above Dim VendorTypeRet as IVendorTypeRet VendorTypeRet = CType(response.Detail,IVendorTypeRet) WalkVendorTypeRet(VendorTypeRet) End If End If End If Next j End Sub Public Sub WalkVendorTypeRet(VendorTypeRet as IVendorTypeRet) if (VendorTypeRet is nothing) then Exit Sub End If 'Go through all the elements of IVendorTypeRet 'Get value of ListID Dim ListID24619 as String ListID24619 = VendorTypeRet.ListID.GetValue() 'Get value of TimeCreated Dim TimeCreated24620 as DateTime TimeCreated24620 = VendorTypeRet.TimeCreated.GetValue() 'Get value of TimeModified Dim TimeModified24621 as DateTime TimeModified24621 = VendorTypeRet.TimeModified.GetValue() 'Get value of EditSequence Dim EditSequence24622 as String EditSequence24622 = VendorTypeRet.EditSequence.GetValue() 'Get value of Name Dim Name24623 as String Name24623 = VendorTypeRet.Name.GetValue() 'Get value of FullName Dim FullName24624 as String FullName24624 = VendorTypeRet.FullName.GetValue() 'Get value of IsActive if ( not VendorTypeRet.IsActive is nothing) then Dim IsActive24625 as Boolean IsActive24625 = VendorTypeRet.IsActive.GetValue() End If if (not VendorTypeRet.ParentRef. is nothing) then 'Get value of ListID if ( not VendorTypeRet.ParentRef.ListID is nothing) then Dim ListID24626 as String ListID24626 = VendorTypeRet.ParentRef.ListID.GetValue() End If 'Get value of FullName if ( not VendorTypeRet.ParentRef.FullName is nothing) then Dim FullName24627 as String FullName24627 = VendorTypeRet.ParentRef.FullName.GetValue() End If End If 'Get value of Sublevel Dim Sublevel24628 as Integer Sublevel24628 = VendorTypeRet.Sublevel.GetValue() 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 | //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 DoVendorTypeAdd() { 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; BuildVendorTypeAddRq(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; WalkVendorTypeAddRs(responseMsgSet); } catch (Exception e) { MessageBox.Show(e.Message, "Error"); if (sessionBegun) { sessionManager.EndSession(); } if (connectionOpen) { sessionManager.CloseConnection(); } } } void BuildVendorTypeAddRq(IMsgSetRequest requestMsgSet) { IVendorTypeAdd VendorTypeAddRq= requestMsgSet.AppendVendorTypeAddRq(); //Set field value for Name VendorTypeAddRq.Name.SetValue("ab"); //Set field value for IsActive VendorTypeAddRq.IsActive.SetValue(true); //Set field value for ListID VendorTypeAddRq.ParentRef.ListID.SetValue("200000-1011023419"); //Set field value for FullName VendorTypeAddRq.ParentRef.FullName.SetValue("ab"); //Set field value for IncludeRetElementList //May create more than one of these if needed VendorTypeAddRq.IncludeRetElementList.Add("ab"); } void WalkVendorTypeAddRs(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.rtVendorTypeAddRs) { //upcast to more specific type here, this is safe because we checked with response.Type check above IVendorTypeRet VendorTypeRet = (IVendorTypeRet)response.Detail; WalkVendorTypeRet(VendorTypeRet); } } } } } void WalkVendorTypeRet(IVendorTypeRet VendorTypeRet) { if (VendorTypeRet == null) return; //Go through all the elements of IVendorTypeRet //Get value of ListID string ListID24609 = (string)VendorTypeRet.ListID.GetValue(); //Get value of TimeCreated DateTime TimeCreated24610 = (DateTime)VendorTypeRet.TimeCreated.GetValue(); //Get value of TimeModified DateTime TimeModified24611 = (DateTime)VendorTypeRet.TimeModified.GetValue(); //Get value of EditSequence string EditSequence24612 = (string)VendorTypeRet.EditSequence.GetValue(); //Get value of Name string Name24613 = (string)VendorTypeRet.Name.GetValue(); //Get value of FullName string FullName24614 = (string)VendorTypeRet.FullName.GetValue(); //Get value of IsActive if (VendorTypeRet.IsActive != null) { bool IsActive24615 = (bool)VendorTypeRet.IsActive.GetValue(); } if (VendorTypeRet.ParentRef != null) { //Get value of ListID if (VendorTypeRet.ParentRef.ListID != null) { string ListID24616 = (string)VendorTypeRet.ParentRef.ListID.GetValue(); } //Get value of FullName if (VendorTypeRet.ParentRef.FullName != null) { string FullName24617 = (string)VendorTypeRet.ParentRef.FullName.GetValue(); } } //Get value of Sublevel int Sublevel24618 = (int)VendorTypeRet.Sublevel.GetValue(); } } } |