Xero Reports parameters

Parameters by report

Aged Payables by Contact

Returns aged payables up to the end of the current month by default.

  • Required parameters
    • Contact ID

How to get contactID
  1. Go to Contacts => All Contacts in the drop-down menu.
  2. Find and click on the contact you need to filter aged payables data by.
  3. Copy the contactID from the URL.
  • Optional parameters:
    • Date - Imports payables up to the specified date, e.g. 2020-04-30. Defaults to the end of the current month.
    • Start date - Imports payables from the specified date.
    • End date - Imports payables to the specified date.

Example:

  • Below is an example of the output you will get in Google Sheets.

Aged Receivables by Contact

Returns aged receivables up to the end of the current month by default.

  • Required parameters
    • Contact ID

How to get contactID
  1. Go to Contacts => All Contacts in the drop-down menu.
  2. Find and click on the contact you need to filter aged payables data by.
  3. Copy the contactID from the URL.
  • Optional parameters:
    • Date - Imports payables up to the specified date, e.g. 2020-04-30. Defaults to the end of the current month.
    • Start date - Imports payables from the specified date.
    • End date - Imports payables to the specified date.

Example:

  • Below is an example of the output you will get in Google Sheets.

Balance sheet

Returns a balance sheet for the end of the month of the specified date. YTD values are shown too.

  • Required parameters:
    • No
  • Optional parameters:
    • Date - Imports the balance sheet for the end of the month of the specified date, e.g. 2020-04-30. Defaults to the end of the current month.
    • Tracking Option ID - Imports the balance sheet filtered by Region.
    • Tracking Option ID 2 - if you want to filter by more than one tracking option, you can specify it as a separate parameter. For more about Tracking Options, check out Xero official documentation.
    • Standard layout - If true, custom report layouts will not be imported.
    • Show cash payments only - If true, cash transactions only will be imported.
How to get Tracking Option ID

1. Go to Accounting => Reports => More reports => Balance Sheet.

Do not confuse the new version of Balance Sheet with the older one that we need.

2. Click on More options and filter the Balance Sheet by Region you need.

3. Click on Update and find TC1=**************** in the page URL. For example, TC1=5e2974a2-097d-4f3b-bfd5-605d78c4a282

Copy the ID part, 5e2974a2-097d-4f3b-bfd5-605d78c4a282, and insert trackingOptionID1.

Example:

Below is an example of the output you will get in Google Sheets.

Bank Statement

Returns a bank statement for the specified bank account.

  • Required parameters
    • Bank Account ID

How to get bankAccountID
  1. Go to Business Bank Account => Bank Statements.
  2. Find accountID=**************** in the page URL. For example, accountID=CEEF66A5-A545-413B-9312-78A53CAADBC4

Copy the ID part, CEEF66A5-A545-413B-9312-78A53CAADBC4, and insert it as the bankAccountID parameter value.

  • Optional parameters:
    • Start date - Imports the bank statement from the specified date.
    • End date - Imports the bank statement to the specified date.

Example:


Below is an example of the output you will get in Google Sheets.

Bank Summary

Returns the balances and cash movements for each bank account.

  • Required parameters:
    • No
  • Optional parameters:
    • Start date - Imports the balances and cash movements for each bank account from the specified date.
    • End date - Imports the balances and cash movements for each bank account to the specified date.

Example:

Below is an example of the output you will get in Google Sheets.

Budget Summary

Returns a summary of your monthly budget.

  • Required parameters:
    • No
  • Optional parameters:
    • Date - Imports the budget summary FROM the specified date, e.g. 2020-04-30. Defaults to the current month.
    • Number of periods to compare - Imports the budget summary for the number of periods to compare. Insert the integer between 1 and 12.
    • Period - Specifies the size of the period used in the periods parameter:
      • 1 - month
      • 3 - quarter
      • 12 - year

Example:

Below is an example of the output you will get in Google Sheets.

Executive Summary

A summary including monthly totals and some common business ratios.

  • Required parameters:
    • No
  • Optional parameters:
    • Date - Imports the executive summary (monthly totals and some common business ratios) up to the specified date, e.g. 2020-04-30. Defaults to the end of the current month.

Example:

Below is an example of the output you will get in Google Sheets.

Profit and Loss

Returns a profit and loss for the current month by default. An alternate date range can also be specified using the optional parameters listed below.

  • Required parameters:
    • No
  • Optional parameters:
    • Start date - Imports the P&L data from the specified date, e.g. 2020-03-01
    • End date - Imports the P&L data to the specified date, e.g. 2020-03-31

To get correct P&L values for previous months, specify only one of the following days as the End Date value:

  • 01-31
  • 03-31
  • 05-31
  • 07-31
  • 08-31
  • 10-31
  • 12-31

Reason: Xero API treats the End Date  parameter as the last day of transactions for the current month, as well as other months in the report. So, if you specify 09-30 as End Date, the P&L report will contain transactions as of September 30, August 30, July 30, June 30, and May 30. If the current month of your P&L report doesn't have 31 days, specify the next month as reporting. This will return correct values for all months including the current one.

  • Number of periods to compare - Imports the P&L data for the specified number of periods to compare. Insert the integer between 1 and 11.
  • Period - Specifies the size of the period used in the periods parameter. Available values are MONTH, QUARTER, and YEAR.
Note:  Number of periods to compare  and Period work if used together only.
  • Tracking Category ID - Imports Profit and Loss report filtered by a tracking category.
  • Tracking Option ID - Use the tracking option imported along with trackingCategoryID.
  • Tracking Category ID -2  - Use the second tracking category if available.
  • Tracking Option ID - 2 - Use the tracking option for the second tracking category.
  • Standard Layout - If true, custom report layouts will not be imported.
  • Show cash payments only - If true, cash transactions only will be imported.
How to get trackingCategoryID

A Xero organization can have a maximum of two ACTIVE tracking categories. To learn yours, as well as their IDs and tracking options, import them with the Xero importer (NOT Xero Reports). Use the following parameters:

Data Entity: Tracking Categories
Report type: Simple
Split By: Options

Here is the  Tracking Category ID that you can use as a parameter value. In our case, this is the filter by Region with four tracking options: Eastside, North, South, and West Coast.

Example:

Below is an example of the output you will get in Google Sheets.

Trial Balance

Returns a trial balance for the current month up to the date specified. YTD values are shown too.

  • Required parameters:
    • No
  • Optional parameters:
    • Date - Imports the trial balance for the current month up to the specified date, e.g. 2020-04-30. Defaults to the end of the current month.
    • Include cash transactions only - If true, cash transactions only will be imported.

Example:

Below is an example of the output you will get in Google Sheets.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.