GetReport
Retrieves a specified QuickBooks Online report using parameters that you define, enabling flexible on-demand reporting.
Input
| Name | Type | Description |
| ReportType | String | Specifies the type of report to generate. Provide a valid QuickBooks Online report name, such as BalanceSheet or ProfitAndLoss, to return the corresponding report data.
使用できる値は次のとおりです。AccountList, APAging, APAgingSummary, ARAgingDetail, ARAgingSummary, BalanceSheetDetail, BalanceSheetSummary, CustomerBalanceDetail, CustomerBalance, CustomerIncome, CustomerSales, ExpensesByVendor, GeneralLedgerDetail, InventoryValuationDetail, InventoryValuationSummary, Journal, ProfitAndLossDetail, ProfitAndLossSummary, SalesByClass, SalesByDepartment, SalesByProduct, StatementofCashFlow, TaxSummary, TransactionList, TransactionListWithSplits, TrialBalance, VendorBalanceDetail, VendorBalance |
| AccountingMethod | String | Specifies the accounting method that is applied to the report calculations, such as Cash or Accrual. This method determines how income and expenses are recognized in the report.
使用できる値は次のとおりです。Cash, Accrual |
| AgingPeriod | String | Specifies the number of days that define each aging period in the report. This setting determines how outstanding balances are segmented into aging buckets. |
| Columns | String | Specifies the column types that are displayed in the report. Provide a comma-separated list (with a space after each comma) of one or more valid column types supported by the selected report. |
| NumPeriods | String | Specifies the number of periods to include in the report. This setting determines how many discrete time periods are returned. |
| PastDue | String | Filters the report contents to include only transactions past a minimum number of days overdue. This setting restricts the report to a specified past-due threshold. |
| ReportDate | Date | Specifies the report date to use as the basis for calculations and filtering. |
| ShipVia | String | Filters the report contents by the shipping method that is specified in an invoice's ShipMethodRef. Provide the name of the shipping method. |
| Term | String | Filters the report contents to include transactions for specified terms. Provide a comma-separated list (with a space after each comma) of one or more Term identifiers (Ids). |
| Vendor | String | Filters the report contents to include transactions for specified vendors. Provide a comma-separated list (with a space after each comma) of one or more Vendor Ids. |
| AgingMethod | String | Specifies the method that is used for aging balances in the report, such as by invoice date or due date.
使用できる値は次のとおりです。Report_Date, Current |
| CustomerID | String | Filters the report contents to include transactions for specified customers. Provide a comma-separated list (with a space after each comma) of one or more Customer Ids. |
| Department | String | Filters the report contents to include transactions for specified departments. Provide a comma-separated list (with a space after each comma) of one or more Department Ids. |
| Class | String | Filters the report contents to include transactions for specified classes. Provide a comma-separated list (with a space after each comma) of one or more Class Ids. |
| Item | String | Filters the report contents to include transactions for specified items. Provide a comma-separated list (with a space after each comma) of one or more Item Ids. |
| IncludeUnrealizedGainOrLoss | Boolean | Specifies whether unrealized gains and losses are included in the report. Supported values are true or false. This input is supported only in Canada-based accounts. |
| ARPaid | String | Specifies the accounts receivable paid status that is used to filter the report contents.
使用できる値は次のとおりです。Paid, Unpaid, All デフォルト値はUnpaidです。 |
| Account | String | Filters the report contents by account identifiers. Provide a comma-separated list (with a space after each comma) of one or more Ids. |
| AccountType | String | Specifies the account type from which transactions are included in the report, such as Bank, Expense, or Income.
使用できる値は次のとおりです。Bank, AccountsReceivable, OtherCurrentAsset, FixedAsset, OtherAsset, AccountsPayable, CreditCard, OtherCurrentLiability, LongTermLiability, Equity, Income, CostOfGoodsSold, Expense, OtherIncome, OtherExpense, NonPosting |
| SourceAccountType | String | Specifies the type of source account to include in the report.
使用できる値は次のとおりです。Bank, AccountsReceivable, OtherCurrentAsset, FixedAsset, OtherAsset, AccountsPayable, CreditCard, OtherCurrentLiability, LongTermLiability, Equity, Income, CostOfGoodsSold, Expense, OtherIncome, OtherExpense, NonPosting |
| Locale | String | Specifies the locale to use for the report output. This ensures that the report content matches regional formatting and language requirements. |
| JournalCode | String | Filters the report contents by journal codes. Provide one or more comma-separated journal codes (with a space after each comma), such as AN, BQ1, or VT. By default, data for all journal codes is included. |
| Employee | String | Filters the report contents to include transactions for specified employees. Provide a comma-separated list (with a space after each comma) of one or more Employee Ids. |
| PaymentMethod | String | Filters the report contents by payment method. Provide a comma-separated list (with a space after each comma) of one or more values, such as Cash, Check, Dinners Club, American Express, Discover, Master Card, or Visa. |
| TaxAgencyId | String | Specifies the unique identifier (Id) of the tax agency for which to generate the report. Retrieve valid Ids by querying the TaxAgency entity. |
| BothAmount | String | Filters the report contents to include transactions for a specified transaction amount. |
| Cleared | String | Filters the report contents to include transactions based on check status, such as cleared or uncleared.
使用できる値は次のとおりです。Cleared, Uncleared, Reconciled, Deposited |
| DocNum | String | Filters the report contents to include transactions for a specified transaction number, as found in the DocNum parameter of the transaction object. |
| Printed | String | Filters the report contents based on whether checks are printed or not.
使用できる値は次のとおりです。All, Printed, To_be_printed |
| Memo | String | Filters the report contents to include transactions for a specified memo. Provide one or more comma-separated memo identifiers (Ids). |
| TransactionType | String | Specifies the transaction type to filter by, such as Invoice, Payment, or CreditMemo.
使用できる値は次のとおりです。CreditCardCharge, Check, Invoice, ReceivePayment, JournalEntry, Bill, CreditCardCredit, VendorCredit, Credit, BillPaymentCheck, BillPaymentCreditCard, Charge, Transfer, Deposit, Statement, BillableCharge, TimeActivity, CashPurchase, SalesReceipt, CreditMemo, CreditRefund, Estimate, InventoryQuantityAdjustment, PurchaseOrder, GlobalTaxPayment, GlobalTaxAdjustment, Service Tax Refund, Service Tax Gross Adjustment, Service Tax Reversal, Service Tax Defer, Service Tax Partial Utilisation |
| APPaid | String | Specifies the accounts payable balance status that is used to filter the report contents.
使用できる値は次のとおりです。Paid, Unpaid, All デフォルト値はUnpaidです。 |
| SortBy | String | Specifies the column type that is used to sort the report rows. Provide one of the column values specified in the Columns input. |
| SortOrder | String | Specifies the order in which to sort the report results, such as ascending or descending.
使用できる値は次のとおりです。ascend, descend デフォルト値はascendです。 |
| SummarizeColumnsBy | String | Specifies the criteria by which the report results are grouped into columns. Use this to control how data is summarized or categorized across multiple columns.
使用できる値は次のとおりです。Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices |
| GroupBy | String | Specifies the field in the transaction by which to group the report results. This determines how rows are organized in the output, such as grouping by Customer, Vendor, or Account.
使用できる値は次のとおりです。Name, Account, Transaction Type, Customer, Vendor, Employee, Location, Payment Method, Day, Week, Month, Quarter, Year, None |
| DateMacro | String | Specifies a predefined date range that is automatically applied to the report timeframe. Use this parameter for standard date periods. Otherwise, specify the StartDate and EndDate inputs for a custom range.
使用できる値は次のとおりです。Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year |
| StartDate | Date | Specifies the starting date of the report. This parameter defines the earliest transaction date to include and must be earlier than the ending date. |
| EndDate | Date | Specifies the ending date of the report. This parameter defines the latest transaction date to include and must be later than the starting date. |
| CreateDateMacro | String | Specifies a predefined account creation date range that is automatically applied to the report. Use this parameter for standard date periods. Otherwise, specify the StartCreateDate and EndCreateDate inputs for a custom range.
使用できる値は次のとおりです。Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year |
| StartCreateDate | Date | Specifies the starting date for account creation to include in the report. This parameter defines the earliest account-creation date to include and must be earlier than the ending date. |
| EndCreateDate | Date | Specifies the ending date for account creation to include in the report. This parameter defines the latest account-creation date to include and must be later than the starting date. |
| DueDateMacro | String | Specifies a predefined due date range that is automatically applied to the report timeframe. Use this parameter for standard due date periods. Otherwise, specify the StartDueDate and EndDueDate inputs for a custom range.
使用できる値は次のとおりです。Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year |
| StartDueDate | Date | Specifies the starting date of receivables that are due and included in the report. This parameter defines the earliest due date to include and must be earlier than the ending date. |
| EndDueDate | Date | Specifies the ending date of receivables that are due and included in the report. This parameter defines the latest due date to include and must be later than the starting date. |
| ModDateMacro | String | Specifies a predefined account modification date range that is automatically applied to the report. Use this parameter for standard date periods when accounts were modified. Otherwise, specify the StartModDate and EndModDate inputs for a custom range.
使用できる値は次のとおりです。Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year |
| StartModDate | Date | Specifies the starting date of accounts that were modified and included in the report. This parameter defines the earliest modification date to include and must be earlier than the ending date. |
| EndModDate | Date | Specifies the ending date of accounts that were modified and included in the report. This parameter defines the latest modification date to include and must be later than the starting date. |
| SvcDateMacro | String | Specifies a predefined service date range that is automatically applied to the report. Use this parameter for standard date periods; otherwise, specify the SvcStartDate and SvcEndDate inputs for a custom range.
使用できる値は次のとおりです。Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year |
| SvcStartDate | Date | Specifies the starting service date of the items included in the report. This parameter defines the earliest service date to include and must be earlier than the ending date. |
| SvcEndDate | Date | Specifies the ending service date of the items included in the report. This parameter defines the latest service date to include and must be later than the starting date. |
| Indentation | Boolean | Indicates whether to add leading spaces to values that are displayed in the report. This setting helps visually differentiate groupings and totals within the output for improved readability. |
Result Set Columns
| Name | Type | Description |
| * | String | Contains the parsed response returned by the report. This output includes the structured data generated from the specified inputs. |