Calling Stored Procedures
You can invoke a stored procedure using QuickBooksCommand in the same way as any other SQL stored procedure. To instantiate a QuickBooksCommand object, provide the name of the stored procedure and a QuickBooksConnection instance as arguments to the constructor. Set the value of the CommandType property to "StoredProcedure" and add the parameters as key-value pairs to the Parameters collection of the QuickBooksCommand instance.
C#
string connectionString = "User=test;Password=test;URL=http://localhost:8166;"; using (QuickBooksConnection connection = new QuickBooksConnection(connectionString)) { QuickBooksCommand cmd = new QuickBooksCommand("ClearTransaction", connection); cmd.CommandType = CommandType.StoredProcedure; cmd.Parameters.Add(new QuickBooksParameter("@TxnID", "300-1603373489")); // Add other parameters as needed ... QuickBooksDataReader rdr = cmd.ExecuteReader(); while (rdr.Read()) { for (int i = 0; i < rdr.FieldCount; i++) { Console.WriteLine(rdr.GetName(i) + " --> " + rdr[i]); } Console.WriteLine(); } }
VB.NET
Dim connectionString As String = "User=test;Password=test;URL=http://localhost:8166;" Using connection As New QuickBooksConnection(connectionString) Dim cmd As New QuickBooksCommand("ClearTransaction", connection) cmd.CommandType = CommandType.StoredProcedure cmd.Parameters.Add(New QuickBooksParameter("@TxnID", "300-1603373489")) ' Add other parameters as needed ... Dim rdr As QuickBooksDataReader = cmd.ExecuteReader() While rdr.Read() For i As Integer = 0 To rdr.FieldCount - 1 Console.WriteLine(rdr.GetName(i) + " --> " + rdr(i)) Next Console.WriteLine() End While End Using
Alternatively, you can set the parameters of a stored procedure in the text of the command. The support for stored procedure statements follows the standard form shown below:
"EXECUTE my_proc @first = 1, @second = 2, @third = 3;" "EXEC my_proc @first = 1, @second = 2, @third = 3;"
To execute a parameterized query, add parameters as key-value pairs to the Parameters collection of the QuickBooksCommand instance.
C#
string connectionString = "User=test;Password=test;URL=http://localhost:8166;"; using (QuickBooksConnection connection = new QuickBooksConnection(connectionString)) { QuickBooksCommand cmd = new QuickBooksCommand("EXECUTE ClearTransaction TxnID = @TxnID;", connection); cmd.Parameters.Add(new QuickBooksParameter("@TxnID", "300-1603373489")); // Add other parameters as needed ... QuickBooksDataReader rdr = cmd.ExecuteReader(); while (rdr.Read()) { for (int i = 0; i < rdr.FieldCount; i++) { Console.WriteLine(rdr.GetName(i) + " --> " + rdr[i]); } Console.WriteLine(); } }
VB.NET
Dim connectionString As String = "User=test;Password=test;URL=http://localhost:8166;" Using connection As New QuickBooksConnection(connectionString) Dim cmd As New QuickBooksCommand("EXECUTE ClearTransaction TxnID = @TxnID;", connection) cmd.Parameters.Add(New QuickBooksParameter("@TxnID", "300-1603373489")) ' Add other parameters as needed ... Dim rdr As QuickBooksDataReader = cmd.ExecuteReader() While rdr.Read() For i As Integer = 0 To rdr.FieldCount - 1 Console.WriteLine(rdr.GetName(i) + " --> " + rdr(i)) Next Console.WriteLine() End While End Using