Skip to content

List Reports

Endpoint

http
GET /unified/accounting/reports
Integrations supported
  • QuickBooks
  • Xero

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string
By default the `result` attribute is an array of objects. This parameter allows you to specify a field in each `result` objects to use as key, which transforms the `result` array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
Example: id
truto_ignore_limit
boolean
Ignores the `limit` query parameter.
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar
contact
object
The contact to filter the report by. Supported in aged_payable_detail (vendor only), aged_payable_summary, aged_receivable_detail (customer only), aged_receivable_summary (customer only), balance_sheet, cash_flow, customer_balance (customer only), customer_balance_detail (customer only), customer_income, general_ledger, general_ledger_fr, profit_and_loss, profit_and_loss_detail, sales_by_class (customer only), sales_by_customer (customer only), sales_by_department (customer only), sales_by_product (customer only), transaction_list, transaction_list_by_vendor (vendor only), transaction_list_by_customer (customer only), vendor_balance (vendor only), vendor_balance_detail (vendor only), vendor_expense
Supported in
  • QuickBooks
id
string
The unique identifier for the contact
type
string
The type of the contact
All possible enum values:
  • customer
  • vendor
end_date
string · date-time
The end date of the report
Integration specific notes
  • QuickBooksIt should be given along with start_date. This field can be used in all reports except customer_balance and customer_balance_detail
  • XeroIt should be given along with start_date if it is used with report type bank_summary and profit_and_loss.
Supported in
  • QuickBooks
  • Xero
start_date
string · date-time
The start date of the report
Integration specific notes
  • QuickBooksIt should be given along with end_date. This field can be used in all reports except customer_balance and customer_balance_detail
  • XeroIt should be given along with end_date. Can be used in aged_payable_by_contact, aged_receivable_by_contact, bank_summary and profit_and_loss.
Supported in
  • QuickBooks
  • Xero
report_name
string
The type of the report
All possible enum values:
  • account_list_detail
  • aged_payable_by_contact
  • aged_payable_detail
  • aged_payable_summary
  • aged_receivable_by_contact
  • aged_receivable_detail
  • aged_receivable_summary
  • balance_sheet
  • bank_summary
  • budget_summary
  • cash_flow
  • customer_balance
  • customer_balance_detail
  • customer_income
  • executive_summary
  • fec_report
  • general_ledger
  • general_ledger_fr
  • inventory_valuation_summary
  • journal_report
  • journal_report_fr
  • profit_and_loss
  • profit_and_loss_detail
  • sales_by_class
  • sales_by_customer
  • sales_by_department
  • sales_by_product
  • tax_summary
  • transaction_list
  • transaction_list_by_customer
  • transaction_list_by_vendor
  • transaction_list_with_splits
  • trial_balance
  • trial_balance_fr
  • vendor_balance
  • vendor_balance_detail
  • vendor_expense
Enum support by integration
  • QuickBooks
    • profit_and_loss
    • profit_and_loss_detail
    • account_list_detail
    • aged_payable_detail
    • aged_payable_summary
    • aged_receivable_detail
    • aged_receivable_summary
    • balance_sheet
    • cash_flow
    • customer_balance
    • customer_balance_detail
    • customer_income
    • fec_report
    • general_ledger
    • general_ledger_fr
    • inventory_valuation_summary
    • journal_report
    • journal_report_fr
    • sales_by_class
    • sales_by_customer
    • sales_by_department
    • sales_by_product
    • tax_summary
    • transaction_list
    • transaction_list_by_vendor
    • transaction_list_by_customer
    • transaction_list_with_splits
    • trial_balance
    • trial_balance_fr
    • vendor_balance
    • vendor_balance_detail
    • vendor_expense
  • Xero
    • aged_payable_by_contact
    • aged_receivable_by_contact
    • balance_sheet
    • bank_summary
    • budget_summary
    • executive_summary
    • profit_and_loss
    • trial_balance
Required in
  • QuickBooks
  • Xero
contact_id
string
The unique contact identifier for report. This field is required for aged_payable_by_contact and aged_receivable_by_contact.
Supported in
  • Xero

Response Body

result
object[]
List of Reports
id
string
REQUIRED · The unique identifier for report
Supported in
  • QuickBooks
  • Xero
name
string
The name of the report
Supported in
  • QuickBooks
  • Xero
company
string
The company the report belongs to
start_date
string · date-time
The start date of the report
Supported in
  • QuickBooks
end_date
string · date-time
The end date of the report
Supported in
  • QuickBooks
currency
string
The currency of the report
Supported in
  • QuickBooks
created_at
string · date-time
This represents the date when the report was created
Supported in
  • Xero
report_data
object
The data of the report
Supported in
  • QuickBooks
  • Xero
columns
string[]
The columns of the report
rows
object[]
The rows of the report
data
any[]
The data of the row. The data is in the same order as the columns.
rows
object[]
The sub-rows of the row. They have the same schema as the parent row.
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.