DataExtAdd

Writes data to one data extension. This request can only be invoked if a data extension definition has already been defined for the target object type. That is, before you can perform the DataExtAdd on a particular customer, say John Henry, the data extension must already be defined for the Customer object. Notice that a data extension definition can be defined in either of two ways: via DataExtDefAdd as already described, or via the QuickBooks UI by the user specifying a custom field. Only custom fields can be defined through the UI, not private data extensions. DataExtAdd adds a custom field (if OwnerID is set to 0) or a private data extension (if OwnerID is set to a GUID) containing the specified value. The custom field or private data extension and value is added to the specified list object, or transaction, or transaction line item. DataExtAdd will return error 3180 if you invoke this on a custom data ext definition that has been deleted and then re-added from the UI. (You can’t re-add a deleted data ext def via the SDK.) However, you can use DataExtMod to write data to that re-added data ext def.Important: If you want to perform a DataExtAdd on a transaction line item, you should use custom fields instead of private data extensions because only custom field data will be returned in queries. Currently, private data is not returned. Both DataExtAdd and DataExtMod cause a Modify event to be generated for the parent object. For example invoking one of these on a Customer causes a Customer Modify event. The Time Modified value for that parent object is also updated.


Request

Response

XMLOPS

VB.NET

C#

Tag Type Max length Implementation Required

IDataExtAdd

Writes data to one data extension. This request can only be invoked if a data extension definition has already been defined for the target object type. That is, before you can perform the DataExtAdd on a particular customer, say John Henry, the data extension must already be defined for the Customer object. Notice that a data extension definition can be defined in either of two ways: via DataExtDefAdd as already described, or via the QuickBooks UI by the user specifying a custom field. Only custom fields can be defined through the UI, not private data extensions. DataExtAdd adds a custom field (if OwnerID is set to 0) or a private data extension (if OwnerID is set to a GUID) containing the specified value. The custom field or private data extension and value is added to the specified list object, or transaction, or transaction line item. DataExtAdd will return error 3180 if you invoke this on a custom data ext definition that has been deleted and then re-added from the UI. (You can’t re-add a deleted data ext def via the SDK.) However, you can use DataExtMod to write data to that re-added data ext def.Important: If you want to perform a DataExtAdd on a transaction line item, you should use custom fields instead of private data extensions because only custom field data will be returned in queries. Currently, private data is not returned. Both DataExtAdd and DataExtMod cause a Modify event to be generated for the parent object. For example invoking one of these on a Customer causes a Customer Modify event. The Time Modified value for that parent object is also updated.
        

OwnerID

OwnerID refers to the owner of a data extension, and must be 0 or a valid GUID. (Custom fields, which are visible in the QuickBooks UI, always have an OwnerID of 0. ) Usually you would keep your application’s GUID confidential to prevent other applications from accessing your data extensions. But if you want to share data extensions with another application, the applications need to use the same GUID. In this case, each application could use two GUIDs, one for shared data extensions and one for confidential data extensions. (An application can have any number of GUIDs.) When you share a 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     Y

DataExtName

The name of the data extension. If this is a custom field, DataExtName will be visible as a label in the QuickBooks user interface. Also because OwnerID and DataExtName together make the data extension unique, and because custom fields all have the same OwnerID of zero, the DataExtName must be a unique value among existing custom fields. In contrast, the DataExtName for private data extensions must be unique only for the specified OwnerID GUID.
 IQBStringType     Y

ORDataExtOwner

 IORDataExtOwner     Y

ListDataExt

This is used for data extensions that are added to a list object. Each DataExtAdd request writes data to one data extension in one object. The object can be a list object, OR a transaction object, OR a line item within the transaction object.
 IListDataExt      

ListDataExtType

The QBPOS object type that this data extension is being added to, for example, Customer, Vendor, Voucher, etc.
 IQBENListDataExtTypeType     Y

ListObjRef

This object reference is what links the data extension value to the target object.
 IQBBaseRef     Y

ListID

The unique ID returned by QBPOS for this object. If supplied in a request, the ListID is a reference to an object required in the request. For example, in a SalesOrder or PurchaseOrder line item, the ListID that is required is an Item list ID.
 IQBIDType     Y

OtherDataExtType

Used to extend objects that are not list or transaction objects. For example, you would use this to extend the company object.
 IQBENOtherDataExtTypeType      

DataExtValue

The data in this field. The maximum length of DataExtValue will depend on the DataExtType of this data extension. For example, if DataExtType is STR255TYPE, the maximum length of DataExtValue is 255 characters. If DataExtType is STR1024TYPE, the maximum size of DataExtValue is 1KB.
 IQBStringType     Y
Tag Type Max length Implementation Required

IResponse

Writes data to one data extension. This request can only be invoked if a data extension definition has already been defined for the target object type. That is, before you can perform the DataExtAdd on a particular customer, say John Henry, the data extension must already be defined for the Customer object. Notice that a data extension definition can be defined in either of two ways: via DataExtDefAdd as already described, or via the QuickBooks UI by the user specifying a custom field. Only custom fields can be defined through the UI, not private data extensions. DataExtAdd adds a custom field (if OwnerID is set to 0) or a private data extension (if OwnerID is set to a GUID) containing the specified value. The custom field or private data extension and value is added to the specified list object, or transaction, or transaction line item. DataExtAdd will return error 3180 if you invoke this on a custom data ext definition that has been deleted and then re-added from the UI. (You can’t re-add a deleted data ext def via the SDK.) However, you can use DataExtMod to write data to that re-added data ext def.Important: If you want to perform a DataExtAdd on a transaction line item, you should use custom fields instead of private data extensions because only custom field data will be returned in queries. Currently, private data is not returned. Both DataExtAdd and DataExtMod cause a Modify event to be generated for the parent object. For example invoking one of these on a Customer causes a Customer Modify event. The Time Modified value for that parent object is also updated.
        

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

 IDataExtRet      

OwnerID

OwnerID refers to the owner of a data extension, and must be 0 or a valid GUID. (Custom fields, which are visible in the QuickBooks UI, always have an OwnerID of 0. ) Usually you would keep your application’s GUID confidential to prevent other applications from accessing your data extensions. But if you want to share data extensions with another application, the applications need to use the same GUID. In this case, each application could use two GUIDs, one for shared data extensions and one for confidential data extensions. (An application can have any number of GUIDs.) When you share a 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     Y

DataExtName

The name of the data extension. If this is a custom field, DataExtName will be visible as a label in the QuickBooks user interface. Also because OwnerID and DataExtName together make the data extension unique, and because custom fields all have the same OwnerID of zero, the DataExtName must be a unique value among existing custom fields. In contrast, the DataExtName for private data extensions must be unique only for the specified OwnerID GUID.
 IQBStringType     Y

DataExtType

b>DataExtType The type of the data extension.
 IQBENDataExtTypeType     Y

DataExtValue

The data in this field. The maximum length of DataExtValue will depend on the DataExtType of this data extension. For example, if DataExtType is STR255TYPE, the maximum length of DataExtValue is 255 characters. If DataExtType is STR1024TYPE, the maximum size of DataExtValue is 1KB.
 IQBStringType     Y 

 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
<?xml version="1.0" encoding="utf-8"?>
<?qbposxml version="4.0"?>
<QBPOSXML>
        <QBPOSXMLMsgsRq onError="stopOnError">
                <DataExtAddRq>
                        <DataExtAdd> <!-- required -->
                                <OwnerID >GUIDTYPE</OwnerID> <!-- required -->
                                <DataExtName >STRTYPE</DataExtName> <!-- required -->
                                <!-- BEGIN OR -->
                                        <!-- ListDataExtType may have one of the following values: Department, Customer, Vendor, Employee, ItemInventory, SalesReceipt, Voucher, InventoryQtyAdjustment, InventoryCostAdjustment, TransferSlip, SalesOrder, PurchaseOrder, TimeEntry -->
                                        <ListDataExtType >ENUMTYPE</ListDataExtType> <!-- required -->
                                        <ListObjRef> <!-- required -->
                                                <ListID >IDTYPE</ListID> <!-- required -->
                                        </ListObjRef>
                                <!-- OR -->
                                        <!-- OtherDataExtType may have one of the following values: Company -->
                                        <OtherDataExtType >ENUMTYPE</OtherDataExtType> <!-- optional -->
                                <!-- END OR -->
                                <DataExtValue >STRTYPE</DataExtValue> <!-- required -->
                        </DataExtAdd>
                </DataExtAddRq>

                <DataExtAddRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE">
                        <DataExtRet> <!-- optional -->
                                <OwnerID >GUIDTYPE</OwnerID> <!-- required -->
                                <DataExtName >STRTYPE</DataExtName> <!-- required -->
                                <!-- DataExtType may have one of the following values: INTTYPE, AMTTYPE, PRICETYPE, QUANTYPE, PERCENTTYPE, DATETIMETYPE, STR255TYPE, STR1024TYPE -->
                                <DataExtType >ENUMTYPE</DataExtType> <!-- required -->
                                <DataExtValue >STRTYPE</DataExtValue> <!-- required -->
                        </DataExtRet>
                </DataExtAddRs>
        </QBPOSXMLMsgsRq>
</QBPOSXML>


  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
'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.qbposfc4

        Public Class SampleDataExtAdd
                Public Sub  DoDataExtAdd()
                        Dim sessionBegun as Boolean
                        sessionBegun = False
                        Dim connectionOpen as Boolean
                        connectionOpen = False
                        Dim sessionManager as QBPOSSessionManager
                        sessionManager = nothing

                        Try
                                'Create the session Manager object
                                sessionManager = new QBPOSSessionManager

                                'Create the message set request object to hold our request
                                Dim requestMsgSet as IMsgSetRequest
                                requestMsgSet = sessionManager.CreateMsgSetRequest(4,0)
                                requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue

                                BuildDataExtAddRq(requestMsgSet)

                                'Connect to QuickBooks and begin a session
                                sessionManager.OpenConnection("","Sample Code from OSR")
                                connectionOpen = True
                                sessionManager.BeginSession("")
                                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

                                WalkDataExtAddRs(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 BuildDataExtAddRq(requestMsgSet as IMsgSetRequest)
                        Dim DataExtAddRq as IDataExtAdd
                        DataExtAddRq= requestMsgSet.AppendDataExtAddRq()
                        'Set field value for OwnerID
                        DataExtAddRq.OwnerID.SetValue(System.Guid.NewGuid().ToString())
                        'Set field value for DataExtName
                        DataExtAddRq.DataExtName.SetValue("ab")
                        Dim ORDataExtOwnerElementType537 as String
                        ORDataExtOwnerElementType537 = "ListDataExt"
                        if (ORDataExtOwnerElementType537 = "ListDataExt") then
                                'Set field value for ListDataExtType
                                DataExtAddRq.ORDataExtOwner.ListDataExt.ListDataExtType.SetValue(ENListDataExtType.ldetDepartment)
                                'Set field value for ListID
                                DataExtAddRq.ORDataExtOwner.ListDataExt.ListObjRef.ListID.SetValue("200000-1011023419")
                        End If
                        if (ORDataExtOwnerElementType537 = "OtherDataExtType") then
                                'Set field value for OtherDataExtType
                                DataExtAddRq.ORDataExtOwner.OtherDataExtType.SetValue(ENOtherDataExtType.odetCompany)
                        End If
                        'Set field value for DataExtValue
                        DataExtAddRq.DataExtValue.SetValue("ab")
                End Sub




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




                Public Sub WalkDataExtRet(DataExtRet as IDataExtRet)
                        if (DataExtRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of IDataExtRet
                        'Get value of OwnerID
                        Dim OwnerID538 as String
                        OwnerID538 = DataExtRet.OwnerID.GetValue()
                        'Get value of DataExtName
                        Dim DataExtName539 as String
                        DataExtName539 = DataExtRet.DataExtName.GetValue()
                        'Get value of DataExtType
                        Dim DataExtType540 as ENDataExtType
                        DataExtType540 = DataExtRet.DataExtType.GetValue()
                        'Get value of DataExtValue
                        Dim DataExtValue541 as String
                        DataExtValue541 = DataExtRet.DataExtValue.GetValue()
                End Sub




        End Class


  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
//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.qbposfc4;

namespace com.intuit.idn.samples
{
        public class SampleDataExtAdd
        {
                public void  DoDataExtAdd()
                {
                        bool sessionBegun = false;
                        bool connectionOpen = false;
                        QBPOSSessionManager sessionManager = null;

                        try
                        {
                                //Create the session Manager object
                                sessionManager = new QBPOSSessionManager();

                                //Create the message set request object to hold our request
                                IMsgSetRequest requestMsgSet = sessionManager.CreateMsgSetRequest(4,0);
                                requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue;

                                BuildDataExtAddRq(requestMsgSet);

                                //Connect to QuickBooks and begin a session
                                sessionManager.OpenConnection("","Sample Code from OSR");
                                connectionOpen = true;
                                sessionManager.BeginSession("");
                                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;

                                WalkDataExtAddRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildDataExtAddRq(IMsgSetRequest requestMsgSet)
                {
                        IDataExtAdd DataExtAddRq= requestMsgSet.AppendDataExtAddRq();
                        //Set field value for OwnerID
                        DataExtAddRq.OwnerID.SetValue(Guid.NewGuid().ToString());
                        //Set field value for DataExtName
                        DataExtAddRq.DataExtName.SetValue("ab");
                        string ORDataExtOwnerElementType542 = "ListDataExt";
                        if (ORDataExtOwnerElementType542 == "ListDataExt")
                        {
                                //Set field value for ListDataExtType
                                DataExtAddRq.ORDataExtOwner.ListDataExt.ListDataExtType.SetValue(ENListDataExtType.ldetDepartment);
                                //Set field value for ListID
                                DataExtAddRq.ORDataExtOwner.ListDataExt.ListObjRef.ListID.SetValue("200000-1011023419");
                        }
                        if (ORDataExtOwnerElementType542 == "OtherDataExtType")
                        {
                                //Set field value for OtherDataExtType
                                DataExtAddRq.ORDataExtOwner.OtherDataExtType.SetValue(ENOtherDataExtType.odetCompany);
                        }
                        //Set field value for DataExtValue
                        DataExtAddRq.DataExtValue.SetValue("ab");
                }




                void WalkDataExtAddRs(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.rtDataExtAddRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        IDataExtRet DataExtRet = (IDataExtRet)response.Detail;
                                                                WalkDataExtRet(DataExtRet);
                                                }
                                        }
                                }
                        }
                }




                void WalkDataExtRet(IDataExtRet DataExtRet)
                {
                        if (DataExtRet == null) return;
                        //Go through all the elements of IDataExtRet
                        //Get value of OwnerID
                        string OwnerID543 = (string)DataExtRet.OwnerID.GetValue();
                        //Get value of DataExtName
                        string DataExtName544 = (string)DataExtRet.DataExtName.GetValue();
                        //Get value of DataExtType
                        ENDataExtType DataExtType545 = (ENDataExtType)DataExtRet.DataExtType.GetValue();
                        //Get value of DataExtValue
                        string DataExtValue546 = (string)DataExtRet.DataExtValue.GetValue();
                }




        }
}