CreateReportSchema
Generates a report schema file.
CreateReportSchema
CreateReportSchema creates a schema file based on the specified report. This schema adds a table to your existing list that corresponds with the results of your report, which can then be queried like other tables. (Reports from the QuickBooks are not modeled by connector as queryable tables by default.)The generated schema file outlines the metadata for the report, such as columns and column data types. You can edit the file to adjust data types, rename columns, and include or exclude columns.
Updating a Report Schema
In the following example, the SP CreateReportSchema creates a new report using TestReportTest1 as a base template. It appends new columns to TestReportTest1 and creates a new report, named TestReport2. The new report is saved as ...\\TestReportTest2.rsd.EXECUTE [CreateReportSchema]
[ReportName] = "TestReportTest2",
[CustomFieldIdsPrimitive] = "1459925,1459928",
[CustomFieldIdsDropdown] = "1469785",
[CustomDimensionKeyIds] = "13539564",
[BaseReportName] = "TestReportTest1",
[FileName] = "...\\TestReportTest2.rsd"
Input
| Name | Type | Description |
| ReportName | String | The name of the report. If this is not specified the ReportType will be used as the name. |
| ReportDescription | String | A description for the report. If one is not specified, a description based on the ReportType will be selected. |
| ReportType | String | The type of report to create a schema for.
The allowed values are 1099DETAIL, APAGINGDETAIL, APAGINGSUMMARY, ARAGINGDETAIL, ARAGINGSUMMARY, AUDITTRAIL, BALANCESHEETBUDGETOVERVIEW, BALANCESHEETBUDGETVSACTUAL, BALANCESHEETDETAIL, BALANCESHEETPREVYEARCOMP, BALANCESHEETSTANDARD, BALANCESHEETSUMMARY, CHECKDETAIL, COLLECTIONSREPORT, CUSTOMDETAIL, CUSTOMERBALANCEDETAIL, CUSTOMERBALANCESUMMARY, CUSTOMSUMMARY, DEPOSITDETAIL, EMPLOYEEEARNINGSSUMMARY, EMPLOYEESTATETAXESDETAIL, ESTIMATESBYJOB, EXPENSEBYVENDORDETAIL, EXPENSEBYVENDORSUMMARY, GENERALLEDGER, INCOMEBYCUSTOMERDETAIL, INCOMEBYCUSTOMERSUMMARY, INCOMETAXDETAIL, INCOMETAXSUMMARY, INVENTORYSTOCKSTATUSBYITEM, INVENTORYSTOCKSTATUSBYVENDOR, INVENTORYVALUATIONDETAIL, INVENTORYVALUATIONSUMMARY, ITEMESTIMATESVSACTUALS, ITEMPROFITABILITY, JOBESTIMATESVSACTUALSDETAIL, JOBESTIMATESVSACTUALSSUMMARY, JOBPROFITABILITYDETAIL, JOBPROFITABILITYSUMMARY, JOBPROGRESSINVOICESVSESTIMATES, JOURNAL, MISSINGCHECKS, OPENINVOICES, OPENPOS, OPENPOSBYJOB, OPENSALESORDERBYCUSTOMER, OPENSALESORDERBYITEM, PAYROLLITEMDETAIL, PAYROLLLIABILITYBALANCES, PAYROLLREVIEWDETAIL, PAYROLLSUMMARY, PAYROLLTRANSACTIONDETAIL, PAYROLLTRANSACTIONSBYPAYEE, PENDINGSALES, PHYSICALINVENTORYWORKSHEET, PROFITANDLOSSBUDGETOVERVIEW, PROFITANDLOSSBUDGETPERFORMANCE, PROFITANDLOSSBUDGETVSACTUAL, PROFITANDLOSSBYCLASS, PROFITANDLOSSBYJOB, PROFITANDLOSSDETAIL, PROFITANDLOSSPREVYEARCOMP, PROFITANDLOSSSTANDARD, PROFITANDLOSSYTDCOMP, PURCHASEBYITEMDETAIL, PURCHASEBYITEMSUMMARY, PURCHASEBYVENDORDETAIL, PURCHASEBYVENDORSUMMARY, SALESBYCUSTOMERDETAIL, SALESBYCUSTOMERSUMMARY, SALESBYITEMDETAIL, SALESBYITEMSUMMARY, SALESBYREPDETAIL, SALESBYREPSUMMARY, SALESTAXLIABILITY, SALESTAXREVENUESUMMARY, TIMEBYITEM, TIMEBYJOBDETAIL, TIMEBYJOBSUMMARY, TIMEBYNAME, TRIALBALANCE, TXNDETAILBYACCOUNT, TXNLISTBYCUSTOMER, TXNLISTBYDATE, TXNLISTBYVENDOR, UNBILLEDCOSTSBYJOB, UNPAIDBILLSDETAIL, VENDORBALANCEDETAIL, VENDORBALANCESUMMARY. |
| IncludeRowtype | Boolean | A boolean determining if the rowtype column should be included in the output schema.
The default value is FALSE. |
| ReportPeriod | String | Report date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:) or a macro. Supported date format: yyyy-MM-dd and Supported Macro 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 |
| AccountType | String | The specific type of account to request in the report.
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. |
| AccountList | String | A comma separated list of account names or IDs. Also specify a value for AccountListType if specifying a value for this input. For instance AccountName,AccountId2,AccountId3. |
| AccountListType | String | Allows the user to query for specific list accounts.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| EntityType | String | The specific type of entity to request in the report.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. |
| EntityList | String | A comma separated list of entity names or IDs. Also specify a value for EntityListType if specifying a value for this input. |
| EntityListType | String | Allows the user to query for specific list of entities.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| ItemType | String | The specific type of item to request in the report.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. |
| ItemList | String | A comma separated list of item names or IDs. Also specify a value for ItemListType if specifying a value for this input. |
| ItemListType | String | Allows the user to query for specific list of items.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| ClassList | String | A comma separated list of class names or IDs. Also specify a value for ClassListType if specifying a value for this input. |
| ClassListType | String | Allows the user to query for specific list of classes.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| ModifiedDateRange | String | Date modified range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:) or a macro. Supported date format: yyyy-MM-dd. Support Macro
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.. |
| DetailLevel | String | The level of detail to include in the report.
The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. |
| 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. |
| IncludeSubColumns | String | A boolean indicating if subcolumns should be included. |
| IncludeColumns | String | A comma separated list of columns to include. Supported values include ACCOUNT,AGING,AMOUNT,AMOUNTDIFFERENCE,AVERAGECOST,BILLEDDATE,BILLINGSTATUS,CALCULATEDAMOUNT,CLASS,CLEAREDSTATUS,COSTPRICE,CREDIT,CURRENCY,DATE,DEBIT,DELIVERYDATE,DUEDATE,ESTIMATEACTIVE,EXCHANGERATE,FOB,INCOMESUBJECTTOTAX,INVOICED,ITEM,ITEMDESC,LASTMODIFIEDBY,LATESTORPRIORSTATE,MEMO,MODIFIEDTIME,NAME,NAMEACCOUNTNUMBER,NAMEADDRESS,NAMECITY,NAMECONTACT,NAMEEMAIL,NAMEFAX,NAMEPHONE,NAMESTATE,NAMEZIP,OPENBALANCE,ORIGINALAMOUNT,PAIDAMOUNT,PAIDSTATUS,PAIDTHROUGHDATE,PAYMENTMETHOD,PAYROLLITEM,PONUMBER,PRINTSTATUS,PROGRESSAMOUNT,PROGRESSPERCENT,QUANTITY,QUANTITYAVAILABLE,QUANTITYONHAND,QUANTITYONSALESORDER,RECEIVEDQUANTITY,REFNUMBER,RUNNINGBALANCE,SALESREP,SALESTAXCODE,SHIPDATE,SHIPMETHOD,SOURCENAME,SPLITACCOUNT,SSNORTAXID,TAXLINE,TAXTABLEVERSION,TERMS,TXNID,TXNNUMBER,TXNTYPE,UNITPRICE,USEREDIT,VALUEONHAND,WAGEBASE,WAGEBASETIPS |
| IncludeAccounts | String | Indicates whether this report should include all accounts or just those that are currently in use.
The allowed values are ALL, INUSE. |
| 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. For example, if you set the value to Account, the report's row labels might be Checking, Savings, and so on.
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. |
| ReportCalendar | String | Specifies the type of year that will be used for this report.
The allowed values are NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR. |
| 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. |
| 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. |
| PostingStatus | String | Allows you to query for posting reports, nonposting reports, or reports that are either one.
The allowed values are EITHER, NONPOSTING, POSTING. |
| ReportAsOf | String | The report will return open balance information up to the reportopenbalanceasof date.
The allowed values are REPORTENDDATE, TODAY. |
| TransactionTypes | String | A comma separated list of the transaction types you want the report to cover. 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. |
| 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 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 a report basis. (The 1099 report, for example, has its own basis for generation.)
The allowed values are ACCRUAL, CASH, NONE. |
| FiscalYear | String | The fiscal year of the budget to be queried. For example, 2014. |
| BudgetCriterion | String | Specifies what this budget covers.
The allowed values are NONE, ACCOUNTS, ACCOUNTSANDCLASSES, ACCOUNTSANDCUSTOMERS. |
| SummarizeBudgetColumnsBy | String | The data the report calculates and how the columns will be labeled across the top of the report.
The allowed values are NONE, CLASS, CUSTOMER, DATE. |
| SummarizeBudgetRowsBy | String | How rows are to be labeled in the report. For example, if you set the value to Account, the row labels of the report might be Checking, Savings, and so on.
The allowed values are NONE, CLASS, CUSTOMER, ACCOUNT. |
Result Set Columns
| Name | Type | Description |
| Result | String | Success or Failure. |
| SchemaFile | String | The generated schema file. |
| Columns | String | The number of columns found. |