SalesRepAdd

Adds a sales rep. The sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. A SalesRepRef refers to a person on the SalesRep list. In a request, if a SalesRepRef aggregate includes both FullName and ListID, FullName will be ignored.


Request

Response

XMLOps

VB.NET

C#

Tag Type Max length Implementation Required

ISalesRepAdd

Adds a sales rep. The sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. A SalesRepRef refers to a person on the SalesRep list. In a request, if a SalesRepRef aggregate includes both FullName and ListID, FullName will be ignored.
        

Initial

The initials of a sales representative’s name.
 IQBStringType 5 chars   Y

IsActive

If IsActive is true, this object is currently enabled for use by QuickBooks. The default value is true.
 IQBBoolType      

SalesRepEntityRef

Refers to the sales representative’s full information on the Employee, Vendor, or OtherName list. In a request, if a SalesRepEntityRef aggregate includes both FullName and ListID, FullName will be ignored. Notice that you cannot supply a customer name here.
 IQBBaseRef     Y

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType      

FullName

FullName (along with ListID) is a way to identify a list object. The FullName is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. FullName values are not case-sensitive.
 IQBStringType 41 chars    

IncludeRetElementList

You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a City within an Address: you must specify Address and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the DataExtRet element and you must supply the OwnerID set to either a value of 0 (custom data) or the GUID for the private data.
 IBSTRList 50 chars 4.0  
Tag Type Max length Implementation Required

IResponse

Adds a sales rep. The sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. A SalesRepRef refers to a person on the SalesRep list. In a request, if a SalesRepRef aggregate includes both FullName and ListID, FullName will be ignored.
        

StatusCode

A number that corresponds to a statusSeverity and statusMessage. Five status codes relate directly to signon messages: 2000, 2010, 2020, 2030, and 2040. For details about these and other statusCode values that can be returned, see the statusCode table on the Error Codes page.
 IQBIntType     Y

StatusSeverity

One of the following values: INFO The request was completed, and the results are consistent with what your application expected. WARNING The request was completed, but the results might not be consistent with what you expected. ERROR The request was not completed. No data will appear in the server’s response after the statusMessage.
 IQBStringType     Y

StatusMessage

A user-readable explanation of the success or error condition that is indicated by the statusCode. For details about the statusMessage values that can be returned, see the “Explanation” column of the statusCode table on the Error Codes page.
 IQBStringType     Y

Detail

 ISalesRepRet      

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType     Y

TimeCreated

Time the object was created.
 IQBDateTimeType     Y

TimeModified

Time the object was last modified.
 IQBDateTimeType     Y

EditSequence

A number that the server generates and assigns to this object. Every time the object is changed, the server will change its EditSequence value. When you try to modify a list object, you must provide its EditSequence. The server compares the EditSequence you provide with the EditSequence in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because EditSequence is only used to check whether two objects match, there is no reason to interpret its value.
 IQBStringType 16 chars   Y

Initial

The initials of a sales representative’s name.
 IQBStringType 5 chars   Y

IsActive

If IsActive is true, this object is currently enabled for use by QuickBooks. The default value is true.
 IQBBoolType      

SalesRepEntityRef

Refers to the sales representative’s full information on the Employee, Vendor, or OtherName list. In a request, if a SalesRepEntityRef aggregate includes both FullName and ListID, FullName will be ignored. Notice that you cannot supply a customer name here.
 IQBBaseRef     Y

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType      

FullName

FullName (along with ListID) is a way to identify a list object. The FullName is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. FullName values are not case-sensitive.
 IQBStringType 41 chars    

Detail

 IErrorRecovery   11.0  

ORListOwnerTxn

 IORListOwnerTxn     Y

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType      

OwnerID

Refers to the owner of a data extension:If OwnerID is 0, this is a public data extension, also known as a custom field. Custom fields appear in the QuickBooks UI.If OwnerID is a GUID, for example {6B063959-81B0-4622-85D6-F548C8CCB517}, this field is a private data extension defined by an integrated application. Private data extensions do not appear in the QuickBooks UI. Note that OwnerID values are not case-sensitive, meaning that if you enter an OwnerID value with lower-case letters, the value will be saved and returned with upper-case letters. When you share a private data extension with another application, the other application must know both the OwnerID and the DataExtName, as these together form a data extension’s unique name.
 IQBGUIDType      

TxnID

QuickBooks generates a unique TxnID for each transaction that is added to QuickBooks. A TxnID returned from a request can be used to refer to the transaction in subsequent requests. Notice that you cannot supply the TxnID of a TimeTracking transaction to TransactionQueryRq requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window.
 IQBIDType      

TxnNumber

An identifying number for this transaction.
 IQBIntType      

EditSequence

A number that the server generates and assigns to this object. Every time the object is changed, the server will change its EditSequence value. When you try to modify a list object, you must provide its EditSequence. The server compares the EditSequence you provide with the EditSequence in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because EditSequence is only used to check whether two objects match, there is no reason to interpret its value.
 IQBStringType 16 chars    

ExternalGUID

Allows for the attachment of a user defined GUID value.
 IQBGUIDType       

 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
<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="16.0"?>
<QBXML>
        <QBXMLMsgsRq onError="stopOnError">
                <SalesRepAddRq>
                        <SalesRepAdd> <!-- required -->
                                <Initial >STRTYPE</Initial> <!-- required -->
                                <IsActive >BOOLTYPE</IsActive> <!-- optional -->
                                <SalesRepEntityRef> <!-- required -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </SalesRepEntityRef>
                        </SalesRepAdd>
                        <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat -->
                </SalesRepAddRq>

                <SalesRepAddRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE">
                        <SalesRepRet> <!-- optional -->
                                <ListID >IDTYPE</ListID> <!-- required -->
                                <TimeCreated >DATETIMETYPE</TimeCreated> <!-- required -->
                                <TimeModified >DATETIMETYPE</TimeModified> <!-- required -->
                                <EditSequence >STRTYPE</EditSequence> <!-- required -->
                                <Initial >STRTYPE</Initial> <!-- required -->
                                <IsActive >BOOLTYPE</IsActive> <!-- optional -->
                                <SalesRepEntityRef> <!-- required -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </SalesRepEntityRef>
                        </SalesRepRet>
                        <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>
                </SalesRepAddRs>
        </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
'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  DoSalesRepAdd()
                        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

                                BuildSalesRepAddRq(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

                                WalkSalesRepAddRs(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 BuildSalesRepAddRq(requestMsgSet as IMsgSetRequest)
                        Dim SalesRepAddRq as ISalesRepAdd
                        SalesRepAddRq= requestMsgSet.AppendSalesRepAddRq()
                        'Set field value for Initial
                        SalesRepAddRq.Initial.SetValue("ab")
                        'Set field value for IsActive
                        SalesRepAddRq.IsActive.SetValue(True)
                        'Set field value for ListID
                        SalesRepAddRq.SalesRepEntityRef.ListID.SetValue("200000-1011023419")
                        'Set field value for FullName
                        SalesRepAddRq.SalesRepEntityRef.FullName.SetValue("ab")
                        'Set field value for IncludeRetElementList
                        'May create more than one of these if needed
                        SalesRepAddRq.IncludeRetElementList.Add("ab")
                End Sub




                Public Sub WalkSalesRepAddRs( 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.rtSalesRepAddRs) then
                                                        'upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        Dim SalesRepRet as ISalesRepRet
                                                        SalesRepRet = CType(response.Detail,ISalesRepRet)
                                                        WalkSalesRepRet(SalesRepRet)
                                                End If
                                        End If
                                End If
                        Next j
                End Sub




                Public Sub WalkSalesRepRet(SalesRepRet as ISalesRepRet)
                        if (SalesRepRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of ISalesRepRet
                        'Get value of ListID
                        Dim ListID21497 as String
                        ListID21497 = SalesRepRet.ListID.GetValue()
                        'Get value of TimeCreated
                        Dim TimeCreated21498 as DateTime
                        TimeCreated21498 = SalesRepRet.TimeCreated.GetValue()
                        'Get value of TimeModified
                        Dim TimeModified21499 as DateTime
                        TimeModified21499 = SalesRepRet.TimeModified.GetValue()
                        'Get value of EditSequence
                        Dim EditSequence216.0 as String
                        EditSequence216.0 = SalesRepRet.EditSequence.GetValue()
                        'Get value of Initial
                        Dim Initial21501 as String
                        Initial21501 = SalesRepRet.Initial.GetValue()
                        'Get value of IsActive
                        if ( not SalesRepRet.IsActive is nothing) then
                                Dim IsActive21502 as Boolean
                                IsActive21502 = SalesRepRet.IsActive.GetValue()
                        End If
                        'Get value of ListID
                        if ( not SalesRepRet.SalesRepEntityRef.ListID is nothing) then
                                Dim ListID21503 as String
                                ListID21503 = SalesRepRet.SalesRepEntityRef.ListID.GetValue()
                        End If
                        'Get value of FullName
                        if ( not SalesRepRet.SalesRepEntityRef.FullName is nothing) then
                                Dim FullName21504 as String
                                FullName21504 = SalesRepRet.SalesRepEntityRef.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
//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  DoSalesRepAdd()
                {
                        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;

                                BuildSalesRepAddRq(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;

                                WalkSalesRepAddRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildSalesRepAddRq(IMsgSetRequest requestMsgSet)
                {
                        ISalesRepAdd SalesRepAddRq= requestMsgSet.AppendSalesRepAddRq();
                        //Set field value for Initial
                        SalesRepAddRq.Initial.SetValue("ab");
                        //Set field value for IsActive
                        SalesRepAddRq.IsActive.SetValue(true);
                        //Set field value for ListID
                        SalesRepAddRq.SalesRepEntityRef.ListID.SetValue("200000-1011023419");
                        //Set field value for FullName
                        SalesRepAddRq.SalesRepEntityRef.FullName.SetValue("ab");
                        //Set field value for IncludeRetElementList
                        //May create more than one of these if needed
                        SalesRepAddRq.IncludeRetElementList.Add("ab");
                }




                void WalkSalesRepAddRs(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.rtSalesRepAddRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        ISalesRepRet SalesRepRet = (ISalesRepRet)response.Detail;
                                                        WalkSalesRepRet(SalesRepRet);
                                                }
                                        }
                                }
                        }
                }




                void WalkSalesRepRet(ISalesRepRet SalesRepRet)
                {
                        if (SalesRepRet == null) return;
                        //Go through all the elements of ISalesRepRet
                        //Get value of ListID
                        string ListID21489 = (string)SalesRepRet.ListID.GetValue();
                        //Get value of TimeCreated
                        DateTime TimeCreated21490 = (DateTime)SalesRepRet.TimeCreated.GetValue();
                        //Get value of TimeModified
                        DateTime TimeModified21491 = (DateTime)SalesRepRet.TimeModified.GetValue();
                        //Get value of EditSequence
                        string EditSequence21492 = (string)SalesRepRet.EditSequence.GetValue();
                        //Get value of Initial
                        string Initial21493 = (string)SalesRepRet.Initial.GetValue();
                        //Get value of IsActive
                        if (SalesRepRet.IsActive != null)
                        {
                                bool IsActive21494 = (bool)SalesRepRet.IsActive.GetValue();
                        }
                        //Get value of ListID
                        if (SalesRepRet.SalesRepEntityRef.ListID != null)
                        {
                                string ListID21495 = (string)SalesRepRet.SalesRepEntityRef.ListID.GetValue();
                        }
                        //Get value of FullName
                        if (SalesRepRet.SalesRepEntityRef.FullName != null)
                        {
                                string FullName21496 = (string)SalesRepRet.SalesRepEntityRef.FullName.GetValue();
                        }
                }




        }
}