ReportCustomSummary
Generates a custom summary report.
Input
| Name | Type | Description |
| reporttype | String |
The type of the report. The allowed values are BALANCESHEETPREVYEARCOMP, BALANCESHEETSTANDARD, BALANCESHEETSUMMARY, CUSTOMERBALANCESUMMARY, EXPENSEBYVENDORSUMMARY, INCOMEBYCUSTOMERSUMMARY, INVENTORYSTOCKSTATUSBYITEM, INVENTORYSTOCKSTATUSBYVENDOR, INCOMETAXSUMMARY, INVENTORYVALUATIONSUMMARY, PHYSICALINVENTORYWORKSHEET, PROFITANDLOSSBYCLASS, PROFITANDLOSSBYJOB, PROFITANDLOSSPREVYEARCOMP, PROFITANDLOSSSTANDARD, PROFITANDLOSSYTDCOMP, PURCHASEBYITEMSUMMARY, PURCHASEBYVENDORSUMMARY, SALESBYCUSTOMERSUMMARY, SALESBYITEMSUMMARY, SALESBYREPSUMMARY, SALESTAXLIABILITY, SALESTAXREVENUESUMMARY, TRIALBALANCE, VENDORBALANCESUMMARY. The default value is BALANCESHEETPREVYEARCOMP. |
| reportperiod | String |
Report date range in the format (fromdate:todate), and either value may be omitted for an open ended range (e.g. 2009-12-25:). Supported date format: yyyy-MM-dd. |
| reportdaterangemacro | String |
Use a predefined date range. The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| accounttype | String |
Allows the user to query for a specified account type. The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. The default value is NONE. |
| accountlisttype | String |
Allows the user to query for specific list elements. The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| accountlists | String |
The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| entitytype | String |
Allows the user to query for a specified name type. The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. The default value is NONE. |
| entitylisttype | String |
Allows the user to query for specific list elements. The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| entitylists | String |
The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| itemtype | String |
Allows the user to query for a specified item type. The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. The default value is NONE. |
| itemlisttype | String |
Allows the user to query for specific list elements. The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| itemlists | String |
The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| classlisttype | String |
Allows the user to query for a specified class. The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| classlists | String |
The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| transactiontypes# | String |
A list of the transaction types you want the report to cover. The allowed values are ALL, ARREFUNDCREDITCARD, BILL, BILLPAYMENTCHECK, BILLPAYMENTCREDITCARD, BUILDASSEMBLY, CHARGE, CHECK, CREDITCARDCHARGE, CREDITCARDCREDIT, CREDITMEMO, DEPOSIT, ESTIMATE, INVENTORYADJUSTMENT, INVOICE, ITEMRECEIPT, JOURNALENTRY, LIABILITYADJUSTMENT, PAYCHECK, PAYROLLLIABILITYCHECK, PURCHASEORDER, RECEIVEPAYMENT, SALESORDER, SALESRECEIPT, SALESTAXPAYMENTCHECK, TRANSFER, VENDORCREDIT, YTDADJUSTMENT. The default value is ALL. |
| modifieddaterange | String |
Modified date range in the format (fromdate:todate), and either value may be omitted for an open ended range (e.g. 2009-12-25:). Supported date format: yyyy-MM-dd. |
| modifieddaterangemacro | String |
Use a predefined modified date range. The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| detaillevel | String |
The level of detail to include in the report. The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. The default value is ALL. |
| summarizecolumnsby | String |
SummarizeColumnsBy determines which data the report calculates and how the columns will be labeled across the top of the report. For example, if you set the value to TwoWeek, the report The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. The default value is ACCOUNT. |
| summarizerowsby | String |
SummarizeRowsBy (along with IncludeColumnList, in most cases) determines what data is calculated for this report and controls how the rows are organized and labeled. For example, if you set the value to srbAccount, the report The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TAXLINE, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. The default value is ACCOUNT. |
| includesubcolumns | String |
Determines whether to include any subcolumn information. The allowed values are TRUE, FALSE. The default value is FALSE. |
| reportcalendar | String |
Specifies the type of year that will be used for this report. The allowed values are NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR. The default value is NONE. |
| returnrows | String |
Specifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status. The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is NONE. |
| returncolumns | String |
Specifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status. The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is NONE. |
| postingstatus | String |
Allows you to query for posting reports, non-posting reports, or reports that are either one. The allowed values are EITHER, NONPOSTING, POSTING. The default value is EITHER. |
| reportbasis | String |
If reportbasis is Cash, the report bases income and expenses on the dates when money changed hands; Accrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered; None, the report uses the default ReportBasis, which is either the QuickBooks Preference setting or the QuickBooks default for a given type of report. In a report response, the SDK returns None for reports that do not support ReportBasis. (The 1099 report, for example, has its own basis for generation.) The allowed values are ACCRUAL, CASH, NONE. The default value is NONE. |
Output
| Name | Type | Description |
| reporttitle | String | The main title for this report. |
| reportsubtitle | String | No UI field map data found for this element. |
| reportbasis | String | The reportbasis can be: cash, the report bases income and expenses on the dates when money changed hands; accrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered; none, the report uses the default ReportBasis, which is either the QuickBooks Preference setting or the QuickBooks default for a given type of report. In a report response, the SDK returns rbNone for reports that do not support ReportBasis. (The 1099 report, for example, has its own basis for generation.). |
| numrows | String | The number of rows in the report. |
| numcolumns | String | The number of columns in the report. |
| numcoltitlerows | String | The number of rows to allocate for column titles. |
| column_coltype# | String | The type of data that the #(th) column contains. |
| column_datatype# | String | The #(th) column |
| titlerow_value# | String | The data in the cell of the report. |
| titlerow_rownumber | String | The row number. Rows are numbered from top to bottom, starting with 1. |
| textrow_rownumber | String | The row number. Rows are numbered from top to bottom, starting with 1. |
| textrow_value# | String | The data in the cell of the report. |
| datarow_rowNumber | String | The row number. Rows are numbered from top to bottom, starting with 1. |
| datarow_rowtype | String | The type of data that this row contains. |
| datarow_rowdatavalue | String | The data in the row of the report. |
| datarow_value# | String | The data in the cell of the report |
| subtotalrow_rownumber | String | The row number. Rows are numbered from top to bottom, starting with 1. |
| subtotalrow_rowtype | String | The type of data that this row contains. |
| subtotalrow_rowdatavalue | String | The data in the row of the report. |
| subtotalrow_value# | String | The value in this cell of the report. |
| totalrow_rownumber | String | The row number. Rows are numbered from top to bottom, starting with 1. |
| totalrow_rowtype | String | The type of data that this row contains. |
| totalrow_rowdatavalue | String | The data in this row of the report. |
| totalrow_value# | String | The data in this cell of the report. |