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 本製品 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	Accepts Output Streams	Description
ReportName	String	False	The name of the report. If this is not specified the ReportType will be used as the name.
ReportDescription	String	False	A description for the report. If one is not specified, a description based on the ReportType will be selected.
ReportType	String	False	The type of report to create a schema for. 使用できる値は次のとおりです。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	False	A boolean determining if the rowtype column should be included in the output schema. デフォルト値はFALSEです。
ReportPeriod	String	False	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	False	The specific type of account to request in the report. 使用できる値は次のとおりです。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	False	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	False	Allows the user to query for specific list accounts. 使用できる値は次のとおりです。LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN
EntityType	String	False	The specific type of entity to request in the report. 使用できる値は次のとおりです。NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR
EntityList	String	False	A comma separated list of entity names or IDs. Also specify a value for EntityListType if specifying a value for this input.
EntityListType	String	False	Allows the user to query for specific list of entities. 使用できる値は次のとおりです。LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN
ItemType	String	False	The specific type of item to request in the report. 使用できる値は次のとおりです。NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE
ItemList	String	False	A comma separated list of item names or IDs. Also specify a value for ItemListType if specifying a value for this input.
ItemListType	String	False	Allows the user to query for specific list of items. 使用できる値は次のとおりです。LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN
ClassList	String	False	A comma separated list of class names or IDs. Also specify a value for ClassListType if specifying a value for this input.
ClassListType	String	False	Allows the user to query for specific list of classes. 使用できる値は次のとおりです。LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN
ModifiedDateRange	String	False	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 使用できる値は次のとおりです。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	False	The level of detail to include in the report. 使用できる値は次のとおりです。ALL, ALLEXCEPTSUMMARY, SUMMARYONLY
SummarizeColumnsBy	String	False	Determines which data the report calculates and how the columns will be labeled across the top of the report. 使用できる値は次のとおりです。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	False	A boolean indicating if subcolumns should be included.
IncludeColumns	String	False	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	False	Indicates whether this report should include all accounts or just those that are currently in use. 使用できる値は次のとおりです。ALL, INUSE
SummarizeRowsBy	String	False	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. 使用できる値は次のとおりです。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	False	Specifies the type of year that will be used for this report. 使用できる値は次のとおりです。NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR
ReturnRows	String	False	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. 使用できる値は次のとおりです。NONE, ACTIVEONLY, NONZERO, All
ReturnColumns	String	False	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. 使用できる値は次のとおりです。NONE, ACTIVEONLY, NONZERO, All
PostingStatus	String	False	Allows you to query for posting reports, nonposting reports, or reports that are either one. 使用できる値は次のとおりです。EITHER, NONPOSTING, POSTING
ReportAsOf	String	False	The report will return open balance information up to the reportopenbalanceasof date. 使用できる値は次のとおりです。REPORTENDDATE, TODAY
TransactionTypes	String	False	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	False	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.) 使用できる値は次のとおりです。ACCRUAL, CASH, NONE
FiscalYear	String	False	The fiscal year of the budget to be queried. For example, 2014.
BudgetCriterion	String	False	Specifies what this budget covers. 使用できる値は次のとおりです。NONE, ACCOUNTS, ACCOUNTSANDCLASSES, ACCOUNTSANDCUSTOMERS
SummarizeBudgetColumnsBy	String	False	The data the report calculates and how the columns will be labeled across the top of the report. 使用できる値は次のとおりです。NONE, CLASS, CUSTOMER, DATE
SummarizeBudgetRowsBy	String	False	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. 使用できる値は次のとおりです。NONE, CLASS, CUSTOMER, ACCOUNT
FileStream	String	True	An instance of an output stream where file data is written to.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.

JDBC Driver for QuickBooks

CreateReportSchema