ClearedStatusMod(2.0)

Changes the cleared status of a transaction.


Request

Response

XMLOps

VB.NET

C#

Tag Type Max length Implementation Required

IClearedStatusMod

Changes the cleared status of a transaction.
     2.0  

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     Y

useMacro

The useMacro attribute assigns a TxnID or TxnLineID that was named previously by a defMacro attribute. (Note that defMacro was introduced with SDK 2.0, so it only works with 2.0 and higher requests.) If you use macros with QBOE…There may be a bug in the QBOE implementation of this feature. If this feature is not working for you in QBOE, try stripping the prefix “TxnID:” from the name of the useMacro. For example, defMacro=”TxnID:RecvPmt1234” and useMacro=”RecvPmt1234”
 IQBStringType   2.0  

TxnLineID

Identification number of the transaction line. (TxnLineID is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, TxnLineID is always returned as zero.) G/p>If you need to add a new transaction line in a transaction Mod request, you can do so by setting the TxnLineID to -1.
 IQBIDType      

useMacro

The useMacro attribute assigns a TxnID or TxnLineID that was named previously by a defMacro attribute. (Note that defMacro was introduced with SDK 2.0, so it only works with 2.0 and higher requests.) If you use macros with QBOE…There may be a bug in the QBOE implementation of this feature. If this feature is not working for you in QBOE, try stripping the prefix “TxnID:” from the name of the useMacro. For example, defMacro=”TxnID:RecvPmt1234” and useMacro=”RecvPmt1234”
 IQBStringType   2.0  

ClearedStatus

Indicates whether a transaction or transaction line has been cleared.
 IQBENClearedStatusType     Y
Tag Type Max length Implementation Required

IResponse

Changes the cleared status of a transaction.
     2.0  

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 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="16.0"?>
<QBXML>
        <QBXMLMsgsRq onError="stopOnError">
                <ClearedStatusModRq>
                        <ClearedStatusMod> <!-- required -->
                                <TxnID  useMacro="MACROTYPE">IDTYPE</TxnID> <!-- required -->
                                <TxnLineID  useMacro="MACROTYPE">IDTYPE</TxnLineID> <!-- optional -->
                                <!-- ClearedStatus may have one of the following values: Cleared, NotCleared, Pending -->
                                <ClearedStatus >ENUMTYPE</ClearedStatus> <!-- required -->
                        </ClearedStatusMod>
                </ClearedStatusModRq>

                <ClearedStatusModRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE">
                </ClearedStatusModRs>
        </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
'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  DoClearedStatusMod()
                        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

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

                                WalkClearedStatusModRs(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 BuildClearedStatusModRq(requestMsgSet as IMsgSetRequest)
                        Dim ClearedStatusModRq as IClearedStatusMod
                        ClearedStatusModRq= requestMsgSet.AppendClearedStatusModRq()
                        'Set field value for TxnID
                        ClearedStatusModRq.TxnID.SetValue("200000-1011023419")
                        'Set attributes
                        'Set field value for useMacro
                        ClearedStatusModRq.useMacro.SetValue("IQBStringType")
                        'Set field value for TxnLineID
                        ClearedStatusModRq.TxnLineID.SetValue("200000-1011023419")
                        'Set attributes
                        'Set field value for useMacro
                        ClearedStatusModRq.useMacro.SetValue("IQBStringType")
                        'Set field value for ClearedStatus
                        ClearedStatusModRq.ClearedStatus.SetValue(ENClearedStatus.csCleared)
                End Sub




                Public Sub WalkClearedStatusModRs( 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.rtClearedStatusModRs) then
                                                End If
                                        End If
                                End If
                        Next j
                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
//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  DoClearedStatusMod()
                {
                        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;

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

                                WalkClearedStatusModRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildClearedStatusModRq(IMsgSetRequest requestMsgSet)
                {
                        IClearedStatusMod ClearedStatusModRq= requestMsgSet.AppendClearedStatusModRq();
                        //Set field value for TxnID
                        ClearedStatusModRq.TxnID.SetValue("200000-1011023419");
                        //Set attributes
                        //Set field value for useMacro
                        ClearedStatusModRq.useMacro.SetValue("IQBStringType");
                        //Set field value for TxnLineID
                        ClearedStatusModRq.TxnLineID.SetValue("200000-1011023419");
                        //Set attributes
                        //Set field value for useMacro
                        ClearedStatusModRq.useMacro.SetValue("IQBStringType");
                        //Set field value for ClearedStatus
                        ClearedStatusModRq.ClearedStatus.SetValue(ENClearedStatus.csCleared);
                }




                void WalkClearedStatusModRs(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.rtClearedStatusModRs)
                                                {
                                                }
                                        }
                                }
                        }
                }





        }
}