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. 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. Available values include: 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. 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 | Determines which data the report calculates and how the columns will be labeled across the top of 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 | Determines along with IncludeColumnList, in most cases, what data is calculated for this report and controls how the rows are organized and labeled.
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, nonposting reports, or reports that are either.
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. If Accrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered. If None, the report uses the default report basis, which is either the Reckon preference setting or the Reckon default for a given type of report. In a report response, the SDK returns None for reports that do not support a report basis. (The 1099 report, for example, has its own basis for generation.)
The allowed values are ACCRUAL, CASH, NONE. The default value is NONE. |
| Delimiter | String | Set the delimiter character for the fields
The default value is ;. |
Result Set Columns
| Name | Type | Description |
| Rowtype | String | The type of row being output. For example, TitleRow, TextRow, DataRow, SubtotalRow, or TotalRow. |
| Column_value | String | The data in this row in a semicolon separated list of the report. |