Schema Reference Simba Technologies Inc.

Transcription

1 Simba QuickBooks ODBC Driver with SQL Connector Schema Reference Simba Technologies Inc. Version June 30, 2017

2 Copyright 2016 Simba Technologies Inc. All Rights Reserved. Information in this document is subject to change without notice. Companies, names and data used in examples herein are fictitious unless otherwise noted. No part of this publication, or the software it describes, may be reproduced, transmitted, transcribed, stored in a retrieval system, decompiled, disassembled, reverse-engineered, or translated into any language in any form by any means for any purpose without the express written permission of Simba Technologies Inc. Trademarks Simba, the Simba logo, SimbaEngine, and Simba Technologies are registered trademarks of Simba Technologies Inc. in Canada, United States and/or other countries. All other trademarks and/or servicemarks are the property of their respective owners. Microsoft SQL Server, SQL Server, Microsoft, MSDN, Windows, Windows Azure, Windows Server, Windows Vista, and the Windows start button are trademarks or registered trademarks of Microsoft Corporation or its subsidiaries in Canada, United States and/or other countries. Contact Us Simba Technologies Inc. 938 West 8th Avenue Vancouver, BC Canada V5Z 1E5 Tel: +1 (604) Fax: +1 (604)

3 Simba QuickBooks ODBC Driver Reference Simba QuickBooks ODBC Driver Reference Purpose The Simba QuickBooks ODBC Driver with SQL Connector Schema Reference describes the schema tables and stored procedures available for the Simba QuickBooks ODBC Driver. Audience The guide is intended for end users of the Simba QuickBooks ODBC Driver who have already installed and configured the driver. Knowledge Prerequisites For detailed information about installing, configuring, and using the Simba QuickBooks ODBC Driver, see the Simba QuickBooks ODBC Driver Install and Configuration Guide. Document Conventions Italics are used when referring to book and document titles. Bold is used in procedures for graphical user interface elements that a user clicks and text that a user types. Monospace font indicates commands, source code, or contents of text files. Note: A text box with a pencil icon indicates a short note appended to a paragraph. Important: A text box with an exclamation mark indicates an important comment related to the preceding paragraph. 3

4 Simba QuickBooks ODBC Driver Reference Table of Contents Simba QuickBooks ODBC Driver Reference 3 QuickBooks Stored Procedures 10 CaptureChangeData() 11 CountTableRows() 12 CreateTaxService() 13 CreateTaxServiceContent() 14 DownloadAttachment() 15 DownloadEstimateAsPDF() 16 DownloadInvoiceAsPDF() 17 DownloadSalesReceiptAsPDF() 18 GenerateAccountListReport() 19 GenerateAgedPayableDetailReport() 22 GenerateAgedPayablesReport() 25 GenerateAgedReceivableDetailReport() 27 GenerateAgedReceivablesReport() 30 GenerateBalanceSheetReport() 32 GenerateCashFlowReport() 34 GenerateClassSalesReport() 36 GenerateCustomerBalanceDetailReport() 38 GenerateCustomerBalanceReport() 41 GenerateCustomerIncomeReport() 43 GenerateCustomerSalesReport() 45 GenerateDepartmentSalesReport() 47 GenerateGeneralLedgerReport() 49 GenerateInventoryValuationSummaryReport() 52 GenerateItemSalesReport() 54 GenerateJournalReport() 57 GenerateProfitAndLossDetailReport() 59 GenerateProfitAndLossReport() 62 GenerateTaxSummaryReport() 65 GenerateTrialBalanceReport() 67 GenerateVendorBalanceDetailReport() 69 GenerateVendorBalanceReport() 72 GenerateVendorExpensesReport() 74 InactivateAccount()

5 Simba QuickBooks ODBC Driver Reference InactivateAccountContent() 77 InactivateCustomer() 78 InactivateDepartment() 79 InactivateDepartmentContent() 80 InactivateEmployee() 81 InactivateEmployeeContent() 82 InactivateItem() 83 InactivateItemContent() 84 InactivatePaymentMethod() 85 InactivatePaymentMethodContent() 86 InactivateTerm() 87 InactivateTermContent() 88 InactivateVendor() 89 InactivateVendorContent() 90 ReadEntitlements() 91 SendEstimate() 93 SendInvoice() 94 SendSalesReceipt() 95 UpdatePreferences() 96 UpdatePreferencesContent() 97 UploadAttachments() 98 UpsertAttachable() 100 UpsertAttachableContent() 101 UpsertBill() 102 UpsertBillContent() 103 UpsertBillPayment() 104 UpsertBillPaymentContent() 105 UpsertCompanyCurrency() 106 UpsertCompanyCurrencyContent() 107 UpsertCreditMemo() 108 UpsertCreditMemoContent() 109 UpsertDeposit() 110 UpsertDepositContent() 111 UpsertEstimate() 112 UpsertEstimateContent() 113 UpsertInvoice() 114 UpsertInvoiceContent() 115 UpsertJournalCode()

6 Simba QuickBooks ODBC Driver Reference UpsertJournalCodeContent() 117 UpsertJournalEntry() 118 UpsertJournalEntryContent() 119 UpsertPayment() 120 UpsertPaymentContent() 121 UpsertPurchase() 122 UpsertPurchaseContent() 123 UpsertPurchaseOrder() 124 UpsertPurchaseOrderContent() 125 UpsertRefundReceipt() 126 UpsertRefundReceiptContent() 127 UpsertSalesReceipt() 128 UpsertSalesReceiptContent() 129 UpsertVendorCredit() 130 UpsertVendorCreditContent() 131 VoidInvoice() 132 VoidPayment() 133 VoidSalesReceipt() Account 136 Attachable 138 Attachable_AttachableRef 140 Attachable_AttachableRef_CustomField 141 Bill 142 Bill_Account_Based_Expense_Line 145 Bill_Item_Based_Expense_Line 147 Bill_LinkedTxn 149 Bill_Payment 150 Bill_TxnTaxDetail_TaxLine 152 BillPayment_Line 154 BillPayment_Line_LinkedTxn 155 Budget 156 Budget_Detail 157 Class 159 Company_Currency 160 Company_Info 161 CompanyCurrency_CustomField

7 Simba QuickBooks ODBC Driver Reference CompanyInfo_NameValue 166 Credit_Memo 167 CreditMemo_CustomField 171 CreditMemo_Description_Line 172 CreditMemo_Discount_Line 173 CreditMemo_Group_Individual_Item_Line 175 CreditMemo_Group_Item_Line 177 CreditMemo_Sales_Item_Line 178 CreditMemo_Subtotal_Line 180 CreditMemo_TxnTaxDetail_TaxLine 181 Customer 183 Department 188 Deposit 189 Deposit_CustomField 191 Deposit_Line 192 Deposit_Line_CustomField 194 Deposit_Linked_Transaction_Detail 195 Deposit_Linked_Transaction_Line 196 Deposit_TxnTaxDetail_TaxLine 197 Employee 199 Estimate 202 Estimate_CustomField 206 Estimate_Description_Line 207 Estimate_Discount_Line 208 Estimate_Group_Individual_Item_Line 210 Estimate_Group_Item_Line 212 Estimate_LinkedTxn 213 Estimate_Sales_Item_Line 214 Estimate_Subtotal_Line 216 Estimate_TxnTaxDetail_TaxLine 217 Invoice 219 Invoice_CustomField 224 Invoice_Description_Line 225 Invoice_Discount_Line 226 Invoice_Group_Individual_Item_Line 228 Invoice_Group_Item_Line 230 Invoice_LinkedTxn 231 Invoice_Sales_Item_Line

8 Simba QuickBooks ODBC Driver Reference Invoice_Subtotal_Line 234 Invoice_TxnTaxDetail_TaxLine 235 Item 237 Journal_Code 240 Journal_Entry 241 JournalCode_CustomField 243 JournalEntry_Description_Line 244 JournalEntry_Line 245 JournalEntry_TxnTaxDetail_TaxLine 247 Payment 249 Payment_Line 252 Payment_Line_LinkedTxn 253 Payment_Method 254 Preferences 255 Preferences_OtherPrefs_NameValue 260 Preferences_SalesFormsPrefs_CustomField 261 Preferences_VendorAndPurchasesPrefs_POCustomField 262 Purchase 263 Purchase_Account_Based_Expense_Line 266 Purchase_Item_Based_Expense_Line 268 Purchase_Order 270 Purchase_TxnTaxDetail_TaxLine 274 PurchaseOrder_Account_Based_Expense_Line 276 PurchaseOrder_CustomField 278 PurchaseOrder_Item_Based_Expense_Line 279 PurchaseOrder_LinkedTxn 281 PurchaseOrder_TxnTaxDetail_TaxLine 282 Refund_Receipt 284 RefundReceipt_CustomField 290 RefundReceipt_Description_Line 291 RefundReceipt_Discount_Line 292 RefundReceipt_Group_Individual_Item_Line 294 RefundReceipt_Group_Item_Line 296 RefundReceipt_Sales_Item_Line 297 RefundReceipt_Subtotal_Line 299 RefundReceipt_TxnTaxDetail_TaxLine 300 Sales_Receipt 302 SalesReceipt_CustomField

9 Simba QuickBooks ODBC Driver Reference SalesReceipt_Description_Line 309 SalesReceipt_Discount_Line 310 SalesReceipt_Group_Individual_Item_Line 312 SalesReceipt_Group_Item_Line 314 SalesReceipt_Sales_Item_Line 315 SalesReceipt_Subtotal_Line 317 SalesReceipt_TxnTaxDetail_TaxLine 318 Tax_Agency 320 Tax_Code 321 Tax_Rate 322 TaxCode_PurchaseTaxRateList_TaxRateDetail 324 TaxCode_SalesTaxRateList_TaxRateDetail 325 Term 326 Time_Activity 327 Transfer 329 Vendor 330 Vendor_Credit 333 VendorCredit_Account_Based_Expense_Line 335 VendorCredit_Item_Based_Expense_Line 337 Contact Us 339 Third-Party Trademarks 340 Third-Party Licenses

10 QuickBooks Stored Procedures QuickBooks Stored Procedures The Simba QuickBooks ODBC Driver provides stored procedures that you can use to create, view, modify, and delete objects from a QuickBooks data source. The stored procedures are listed alphabetically by table name. For each stored procedure, the following information is provided: The name of the stored procedure. A brief description of the stored procedure. The name, SQL type, and description of each parameter used by the stored procedure. If the stored procedure requires a JSON input as one of the parameters, the structure of the JSON. A description of the data that is returned by the stored procedure, if any. 10

11 QuickBooks Stored Procedures CaptureChangeData() Retrieves a list of objects that have changed since the specified date and time. Note: This stored procedure is not supported for the following objects: JournalCode TimeActivity TaxAgency TaxCode TaxRate Parameters Entity_Ids A comma-separated list of entity names. Changed_Since The date/time stamp of a date that is within 30 days of the current date, used for the change data capture. The driver returns a list of objects that have changed since this date and time. Returns A table with a single row of data. Content SQL_LONGVARBINARY( ) The list of objects that have changed since the specified date and time. 11

12 QuickBooks Stored Procedures CountTableRows() Counts the number of rows that are in a non-virtual table. This stored procedure can only be used on tables that support the COUNT aggregation function. Parameters Table_Name The name of the table. Returns A table with a single cell of data. Result SQL_BIGINT The number of rows in the table. 12

13 QuickBooks Stored Procedures CreateTaxService() Creates a TaxService object, which is used to create a TaxCode or TaxRate object. The objects are created based on the details stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file containing the details for the TaxService object. For information about the structure of a TaxService object, see "taxservice" in the QuickBooks Online Accounting API Reference: Returns A table with a single cell of data. Return_Code SQL_BIT 1 for success, 0 for failure. 13

14 QuickBooks Stored Procedures CreateTaxServiceContent() Creates a TaxService object, which is used to create a TaxCode or TaxRate object. The objects are created based on the details contained in the specified JSON string. Parameters Body_Content SQL_LONGVARCHAR( ) The JSON string containing the details for the TaxService object. For information about the structure of a TaxService object, see "taxservice" in the QuickBooks Online Accounting API Reference: Returns A table with a single cell of data. Return_Code SQL_BIT 1 for success, 0 for failure. 14

15 QuickBooks Stored Procedures DownloadAttachment() Retrieves a temporary URL from which you can download the specified attachment. Parameters Attachable_Id The unique identifier for the attachable object containing the attachment that you want to download. Returns A table with a single row of data. Content SQL_LONGVARBINARY( ) The temporary URL for downloading the attachment. 15

16 QuickBooks Stored Procedures DownloadEstimateAsPDF() Downloads the specified estimate as a PDF file in binary format. Parameters Estimate_Id The unique identifier for the estimate. Returns A table with a single row of data. Content SQL_LONGVARBINARY( ) The PDF of the estimate in binary format. 16

17 QuickBooks Stored Procedures DownloadInvoiceAsPDF() Downloads the specified invoice as a PDF file in binary format. Parameters Invoice_Id The unique identifier for the invoice. Returns A table with a single row of data. Content SQL_LONGVARBINARY( ) The PDF of the invoice in binary format. 17

18 QuickBooks Stored Procedures DownloadSalesReceiptAsPDF() Downloads the specified sales receipt as a PDF file in binary format. Parameters Sales_Receipt_Id The unique identifier for the sales receipt. Returns A table with a single row of data. Content SQL_LONGVARBINARY( ) The PDF of the sales receipt in binary format. 18

19 QuickBooks Stored Procedures GenerateAccountListReport() Generates an Account List Report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Account_Status The status of the account. The default value is Not_Deleted. Account_Type The account type from which to include transactions. By default, transactions from all account types are included. Columns The column types to include in the report. Createdate_Macro A predefined date range for account creation dates. Set this parameter if you want the report to only include data from accounts that were created within the specified standard date range. The default value is This Fiscal Year-to-date. Moddate_Macro 19

20 QuickBooks Stored Procedures A predefined date range for the dates when the accounts were last modified. Set this parameter if you want the report to only include data from accounts that were last modified within the specified standard date range. Otherwise, use Start_ Moddate and End_Moddate to specify a custom date range. The default value is This Fiscal Year-to-date. Sort_By The column type on which to base sorting for the rows in the report. The default value is txn_type. Sort_Order The sort order for the rows in the report. By default, the rows are sorted in ascending order based on the column type specified in the sort_by parameter. Start_Date The start date to use for the report. End_Date The end date to use for the report. Start_Moddate The start date for filtering accounts based on when they were last modified. The report only includes data for accounts that were last modified at or after the specified date. End_Moddate The end date for filtering accounts based on when they were last modified. The report only includes data for accounts that were last modified at or before the specified date. Returns A table with a single row of data. 20

21 QuickBooks Stored Procedures AccountListReport SQL_LONGVARCHAR( ) The Account List Report. 21

22 QuickBooks Stored Procedures GenerateAgedPayableDetailReport() Generates an A/P Aging Detail Report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Accounting_Method The accounting method used in the report. Aging_Period SQL_Numeric(15,2) The number of days in the aging period. The default value is 30. Columns The column types to show in the report. Custom1 The CustomField attribute in transaction entities, used for filtering. Custom2 The CustomField attribute in transaction entities, used for filtering. Custom3 22

23 QuickBooks Stored Procedures The CustomField attribute in transaction entities, used for filtering. Num_Periods SQL_INTEGER(signed) The number of periods to show in the report. The default value is 4. Past_Due SQL_INTEGER(signed) The number of days past due, used for filtering the report data. The report only includes data for items that have been overdue for the specified number of days or longer. The default value is null. Report_Date The start date to use for the report. The default value is the current date. Shipvia The shipping method on which to filter the report data. By default, the report includes data for all shipping methods. Start_Duedate The start date for filtering receivables due. The report only includes data for receivables that have due dates at or after the specified date. By default, the report includes data for all receivables due. End_Duedate Term The end date used for filtering receivables due. The report only includes data for receivables that have due dates at or before the specified date. By default, the report includes data for all receivables due. A comma-separated list of terms used for filtering. The report only includes data that is related to the specified terms. By default, the report includes data for all terms. 23

24 QuickBooks Stored Procedures Vendor A comma-separated list of vendor names used for filtering. The report only includes data that is related to the specified vendors. By default, the report includes data for all vendors. Returns A table with a single row of data. AgedPayableDetailReport SQL_LONGVARCHAR( ) The A/P Aging Detail Report. 24

25 QuickBooks Stored Procedures GenerateAgedPayablesReport() Generates an A/P Aging Summary Report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Aging_Method The date upon which aging is determined. The default value is Report_Date. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. Department A comma-separated list of department names used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. 25

26 QuickBooks Stored Procedures Qzurl A Boolean value specifying whether Quick Zoom URL information is generated for the rows in the report. The default value is false. Report_Date The start date to use for the report. The default value is the current date. Summarize_Column_By Vendor The criteria to use for grouping the report results. The default value is Total. A comma-separated list of vendor names used for filtering. The report only includes data that is related to the specified vendors. By default, the report includes data for all vendors. Returns A table with a single row of data. AgedPayablesReport SQL_LONGVARCHAR( ) The A/P Aging Summary Report. 26

27 QuickBooks Stored Procedures GenerateAgedReceivableDetailReport() Generates an AR Aging Detail Report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Aging_Method The date upon which aging is determined. The default value is Report_Date. Aging_Period SQL_Numeric(15,2) The number of days in the aging period. The default value is 30. Columns The column types to show in the report. Custom1 The CustomField attribute in transaction entities, used for filtering. Custom2 The CustomField attribute in transaction entities, used for filtering. Custom3 27

28 QuickBooks Stored Procedures The CustomField attribute in transaction entities, used for filtering. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Num_Periods SQL_INTEGER(signed) The number of periods to show in the report. The default value is 4. Past_Due SQL_INTEGER(signed) The number of days past due, used for filtering the report data. The report only includes data for items that have been overdue for the specified number of days or longer. The default value is null. Report_Date The start date to use for the report. The default value is the current date. Shipvia The shipping method on which to filter the report data. By default, the report includes data for all shipping methods. Start_Duedate The start date for filtering receivables due. The report only includes data for receivables that have due dates at or after the specified date. By default, the report includes data for all receivables due. End_Duedate The end date used for filtering receivables due. The report only includes data for receivables that have due dates at or before the specified date. By default, the report includes data for all receivables due. 28

29 QuickBooks Stored Procedures Term A comma-separated list of terms used for filtering. The report only includes data that is related to the specified terms. By default, the report includes data for all terms. Returns A table with a single row of data. AgedReceivableDetailReport SQL_LONGVARCHAR( ) The AR Aging Detail Report. 29

30 QuickBooks Stored Procedures GenerateAgedReceivablesReport() Generates an AR Aging Summary Report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Aging_Method The date upon which aging is determined. The default value is Report_Date. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. Department A comma-separated list of department names used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. 30

31 QuickBooks Stored Procedures Qzurl A Boolean value specifying whether Quick Zoom URL information is generated for the rows in the report. The default value is false. Report_Date The start date to use for the report. The default value is the current date. Summarize_Column_By The criteria to use for grouping the report results. The default value is Total. Returns A table with a single row of data. AgedReceivablesReport SQL_LONGVARCHAR( ) The AR Aging Summary Report. 31

32 QuickBooks Stored Procedures GenerateBalanceSheetReport() Generates a balance sheet report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Accounting_Method Class The accounting method used in the report. A comma-separated list of classes used for filtering. The report only includes data that is related to the specified classes. By default, the report includes data for all classes. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. 32

33 QuickBooks Stored Procedures Department Qzurl A comma-separated list of department names used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. A Boolean value specifying whether Quick Zoom URL information is generated for the rows in the report. The default value is false. Start_Date The start date to use for the report. End_Date The end date to use for the report. Summarize_Column_By Vendor The criteria to use for grouping the report results. The default value is Total. A comma-separated list of vendor names used for filtering. The report only includes data that is related to the specified vendors. By default, the report includes data for all vendors. Returns A table with a single row of data. BalanceSheetReport SQL_LONGVARCHAR( ) The balance sheet report. 33

34 QuickBooks Stored Procedures GenerateCashFlowReport() Generates a cash flow report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Class A comma-separated list of classes used for filtering. The report only includes data that is related to the specified classes. By default, the report includes data for all classes. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. Department 34

35 QuickBooks Stored Procedures Item A comma-separated list of department names used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. A comma-separated list of item names used for filtering. The report only includes data that is related to the specified items. By default, the report includes data for all items. Start_Date The start date to use for the report. End_Date The end date to use for the report. Summarize_Column_By Vendor The criteria to use for grouping the report results. The default value is Total. A comma-separated list of vendor names used for filtering. The report only includes data that is related to the specified vendors. By default, the report includes data for all vendors. Returns A table with a single row of data. CashFlowReport SQL_LONGVARCHAR( ) The cash flow report. 35

36 QuickBooks Stored Procedures GenerateClassSalesReport() Generates a class sales report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Accounting_Method Class The accounting method used in the report. A comma-separated list of classes used for filtering. The report only includes data that is related to the specified classes. By default, the report includes data for all classes. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. 36

37 QuickBooks Stored Procedures Department Item A comma-separated list of department names, used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. A comma-separated list of items used for filtering. The report only includes data that is related to the specified items. By default, the report includes data for all items. Start_Date The start date to use for the report. End_Date The end date to use for the report. Summarize_Column_By The criteria to use for grouping the report results. The default value is Total. Returns A table with a single row of data. ClassSalesReport SQL_LONGVARCHAR( ) The class sales report. 37

38 QuickBooks Stored Procedures GenerateCustomerBalanceDetailReport() Generates a customer balance detail report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Accounting_Method The accounting method used in the report. Aging_Method Arpaid The date upon which aging is determined. The default value is Report_Date. Whether the balance is paid or unpaid. The default value is Unpaid. Columns The column types to show in the report. Custom1 The CustomField attribute in transaction entities, used for filtering. Customer 38

39 QuickBooks Stored Procedures A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Department A comma-separated list of department names used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. Report_Date The start date to use for the report. The default value is the current date. Shipvia The shipping method on which to filter the report data. By default, the report includes data for all shipping methods. Sort_By The column type on which to base sorting for the rows in the report. The default value is txn_type. Sort_Order The sort order for the rows in the report. By default, the rows are sorted in ascending order based on the column type specified in the Sort_By parameter. Start_Duedate The start date for filtering receivables due. The report only includes data for receivables that have due dates at or after the specified date. By default, the report includes data for all receivables due. End_Duedate 39

40 QuickBooks Stored Procedures Term The end date used for filtering receivables due. The report only includes data for receivables that have due dates at or before the specified date. By default, the report includes data for all receivables due. A comma-separated list of terms used for filtering. The report only includes data that is related to the specified terms. By default, the report includes data for all terms. Returns A table with a single row of data. CustomerBalanceDetailReport SQL_LONGVARCHAR( ) The customer balance detail report. 40

41 QuickBooks Stored Procedures GenerateCustomerBalanceReport() Generates a customer balance report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Accounting_Method Arpaid The accounting method used in the report. Whether the balance is paid or unpaid. The default value is Unpaid. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. 41

42 QuickBooks Stored Procedures Department A comma-separated list of department names used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. Report_Date The start date to use for the report. The default value is the current date. Summarize_Column_By Vendor The criteria to use for grouping the report results. The default value is Total. A comma-separated list of vendor names used for filtering. The report only includes data that is related to the specified vendors. By default, the report includes data for all vendors. Returns A table with a single row of data. CustomerBalanceReport SQL_LONGVARCHAR( ) The customer balance report. 42

43 QuickBooks Stored Procedures GenerateCustomerIncomeReport() Generates a customer income report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Accounting_Method Class The accounting method used in the report. A comma-separated list of classes used for filtering. The report only includes data that is related to the specified classes. By default, the report includes data for all classes. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. 43

44 QuickBooks Stored Procedures Department A comma-separated list of department names used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. Start_Date The start date to use for the report. End_Date The end date to use for the report. Summarize_Column_By Term The criteria to use for grouping the report results. The default value is Total. A comma-separated list of terms used for filtering. The report only includes data that is related to the specified terms. By default, the report includes data for all terms. Vendor A comma-separated list of vendor names used for filtering. The report only includes data that is related to the specified vendors. By default, the report includes data for all vendors. Returns A table with a single row of data. CustomerIncomeReport SQL_LONGVARCHAR( ) The customer income report. 44

45 QuickBooks Stored Procedures GenerateCustomerSalesReport() Generates a customer sales report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Accounting_Method Class The accounting method used in the report. A comma-separated list of classes used for filtering. The report only includes data that is related to the specified classes. By default, the report includes data for all classes. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. 45

46 QuickBooks Stored Procedures Department Item Qzurl A comma-separated list of department names, used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. A comma-separated list of items used for filtering. The report only includes data that is related to the specified items. By default, the report includes data for all items. A Boolean value specifying whether Quick Zoom URL information is generated for the rows in the report. The default value is false. Start_Date The start date to use for the report. End_Date The end date to use for the report. Summarize_Column_By The criteria to use for grouping the report results. The default value is Total. Returns A table with a single row of data. CustomerSalesReport SQL_LONGVARCHAR( ) The customer sales report. 46

47 QuickBooks Stored Procedures GenerateDepartmentSalesReport() Generates a department sales report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Accounting_Method Class The accounting method used in the report. A comma-separated list of classes used for filtering. The report only includes data that is related to the specified classes. By default, the report includes data for all classes. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. 47

48 QuickBooks Stored Procedures Department Item A comma-separated list of department names, used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. A comma-separated list of items used for filtering. The report only includes data that is related to the specified items. By default, the report includes data for all items. Start_Date The start date to use for the report. End_Date The end date to use for the report. Summarize_Column_By The criteria to use for grouping the report results. The default value is Total. Returns A table with a single row of data. DepartmentSalesReport SQL_LONGVARCHAR( ) The department sales report. 48

49 QuickBooks Stored Procedures GenerateGeneralLedgerReport() Generates a general ledger report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Account A comma-separated list of accounts used for filtering. The report only includes data that is related to the specified accounts. By default, the report includes data for all accounts. Accounting_Method The accounting method used in the report. Account_Type The account type from which to include transactions in the report. By default, transactions from all account types are included. Source_Account_Type Class The source account type from which to include transactions in the report. 49

50 QuickBooks Stored Procedures A comma-separated list of classes used for filtering. The report only includes data that is related to the specified classes. By default, the report includes data for all classes. Columns The column types to show in the report. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. Department A comma-separated list of department names used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. Sort_By The column type on which to base sorting for the rows in the report. The default value is txn_type. Sort_Order The sort order for the rows in the report. By default, the rows are sorted in ascending order based on the column type specified in the Sort_By parameter. 50

51 QuickBooks Stored Procedures Source_Account A comma-separated list of source accounts used for filtering. The report only includes data that is related to the specified source accounts. By default, the report includes data for all source accounts. Start_Date The start date to use for the report. End_Date Vendor The end date to use for the report. A comma-separated list of vendor names used for filtering. The report only includes data that is related to the specified vendors. By default, the report includes data for all vendors. Returns A table with a single row of data. GeneralLedgerReport SQL_LONGVARCHAR( ) The general ledger report. 51

52 QuickBooks Stored Procedures GenerateInventoryValuationSummaryReport() Generates an inventory valuation summary report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Date_Macro Item Qzurl A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. A comma-separated list of items used for filtering. The report only includes data that is related to the specified items. By default, the report includes data for all items. A Boolean value specifying whether Quick Zoom URL information is generated for the rows in the report. The default value is false. Report_Date The start date to use for the report. The default value is the current date. 52

53 QuickBooks Stored Procedures Summarize_Column_By The criteria to use for grouping the report results. The default value is Total. Returns A table with a single row of data. InventoryValuationSummaryReport SQL_LONGVARCHAR( ) The inventory valuation summary report. 53

54 QuickBooks Stored Procedures GenerateItemSalesReport() Generates a Sales By Product report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Accounting_Method Class The accounting method used in the report. A comma-separated list of classes used for filtering. The report only includes data that is related to the specified classes. By default, the report includes data for all classes. Customer A comma-separated list of customer names used for filtering. The report only includes data that is related to the specified customers. By default, the report includes data for all customers. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. 54

55 QuickBooks Stored Procedures Department Item A comma-separated list of department names, used for filtering. The report only includes data that is related to the specified departments. By default, the report includes data for all departments. A comma-separated list of items used for filtering. The report only includes data that is related to the specified items. By default, the report includes data for all items. Start_Date The start date to use for the report. End_Date The end date to use for the report. Start_Duedate The start date for filtering receivables due. The report only includes data for receivables that have due dates at or after the specified date. By default, the report includes data for all receivables due. End_Duedate The end date used for filtering receivables due. The report only includes data for receivables that have due dates at or before the specified date. By default, the report includes data for all receivables due. Summarize_Column_By The criteria to use for grouping the report results. The default value is Total. 55

56 QuickBooks Stored Procedures Returns A table with a single row of data. ItemSalesReport SQL_LONGVARCHAR( ) The Sales By Product report. 56

57 QuickBooks Stored Procedures GenerateJournalReport() Generates a journal report based on the specified details. Note: All of the parameters for this stored procedure are optional query parameters. If you do not specify a value for a parameter, the driver uses the default value instead. For complete information about the default and supported values for these parameters, see the "Query Parameters" section for the report resource that you are using the stored procedure for in the QuickBooks Online Accounting API Reference: Parameters Columns The column types to show in the report. Date_Macro A predefined date range for the report. Set this parameter if you want the report to only include data from the specified standard date range. Otherwise, use Start_ Date and End_Date to specify a custom date range. The default value is This Fiscal Year-to-date. Journal_Code A comma-separated list of journal codes used for filtering. The report only includes data that is related to the specified journal codes. By default, the report includes data for all journal codes. Sort_By The column type on which to base sorting for the rows in the report. The default value is txn_type. 57