Documentation Index

Fetch the complete documentation index at: https://docs.dataddo.com/llms.txt

Use this file to discover all available pages before exploring further.

Xero

Prev Next

Xero is a cloud-based accounting software platform designed for small and medium-sized businesses. It offers tools for financial management, including features for invoicing, payroll, expense tracking, and reporting, enabling businesses to efficiently manage their finances and stay on top of their accounting tasks.

Refer to our website for the list of metrics and attributes available in Dataddo.

Authorize Connection to Xero

To authorize this service, use OAuth 2.0 to share specific data with Dataddo while keeping usernames, passwords, and other information private.

  1. On the Authorizers page, click on Authorize New Service and select your service.
  2. Follow the on-screen prompts to grant Dataddo the necessary permissions to access and retrieve your data.
  3. [Optional] Once your authorizer is created, click on it to change the label for easier identification.

Ensure that the account you're granting access to holds at least admin-level permissions. If necessary, assign a team member with the required permissions with the authorizer role to authenticate the service for you.

For more information, see our article on authorizers.

Data Coverage

Xero exposes the following datasets. Each dataset maps to a table you can extract. Example fields are a representative sample; each dataset returns more columns.

Dataset Description Example fields Date range
Accounts Retrieve the full chart of accounts Account ID, Bank Account Number, Bank Account Type, Code, Currency Code, Description (+8 more) No
Reports - Aged Receivables Summary Aged Receivables summary report Contact, Credited, Date, Date Start, Date Stop, Description (+8 more) Yes
Balance Sheet Returns a balance sheet for the end of the month of the specified date. Closing Balance, Date Start, DateStop, Balance Sheet Item, Opening Balance, Report ID (+2 more) Yes
Balance Sheet Monthly Returns a balance sheet for the end of the month of the specified date. Closing Balance, Date Start, DateStop, Opening Balance, Report ID, ReportName (+1 more) No
Reports - Bank summary Bank summary report Bank Account, Cash Received, Cash Spent, Closing Balance, Date Start, Date Stop (+4 more) Yes
Bank Transactions Allows you to retrieve any spend or receive money transactions Bank Account Account ID, Bank Account Code, Bank Account Name, Bank Transaction ID, Contact ID, Contact Name (+20 more) Yes
Bank Transfers Allows you to retrieve any bank transfers Amount, Bank Transfer ID, Created Date, Date, From Bank Account ID, From Bank Account Name (+5 more) Yes
Batch payments Allows you to retrieve batch payments Account ID, Batch Payment ID, Date, Has Errors, Invoice ID, Is Discounted (+9 more) No
Reports - Budget summary Returns a summary of your monthly budget Report ID, Account, Xero Tenant Id, Year, April, August (+11 more) Yes
Contacts Retrieve contacts data Account Number, Accounts Payable Tax Type, Accounts Receivable Tax Type, Bank Account Details, Contact ID, Contact Status (+7 more) No
Credit notes Retrieve credit notes data Contact ID, Contact Name, Credit Note ID, Credit Note Number, Currency Code, Currency Rate (+9 more) No
Employees Retrieve employees data Employee ID, First Name, Last Name, Status, Xero Tenant Id No
History invoices Retrieve history invoices data Changes, Date, Details, Id, Invoice ID, Provider Name (+3 more) Yes
History payments Retrieve history payments data Id, Changes, Date, Details, Payment ID, Provider Name (+3 more) Yes
Invoices View all invoice records Invoice ID, Amount Credited, Amount Due, Amount Paid, Contact ID, Contact Name (+12 more) Yes
Invoice Line Items Retrieve data about each invoice line Amount Credited, Amount Due, Amount Paid, Contact ID, Contact Name, Currency Code (+28 more) Yes
Invoice Payments Retrieve data about each invoice payment Amount Credited, Amount Due, Amount Paid, Contact ID, Contact Name, Currency Code (+20 more) Yes
Items Retrieve either one or many items Code, Description, Is Purchased, Is Sold, Is Tracked As Inventory, Item ID (+10 more) No
Journals Retrieve data about each journal Created Date, Journal Date, Journal ID, Journal Number, Xero Tenant Id Yes
Journal Lines Retrieve data about each journal lines Account Code, Account ID, Account Name, Account Type, Gross Amount, Journal Date (+15 more) Yes
Journals with Tracking Retrieve data about each Journal with Tracking Categories Account Code, Account ID, Account Name, Account Type, Gross Amount, Journal Date (+15 more) Yes
Linked Transactions Retrieve data about linked transactions Contact ID, Linked Transaction ID, Source Line Item ID, Source Transaction ID, Source Transaction Type Code, Status (+5 more) No
Manual journals Retrieve data about manual journals Manual Journal ID, Date, Has Attachments, Line Amount Types, Narration, Status (+2 more) No
Organizations List organizations linked to your account Name, Organisation ID, Xero Tenant Id No
Overpayments View overpayment records Amount, Bank Amount, Contact ID, Contact Name, Currency Code, Currency Rate (+12 more) No
Payments View all payments Payment ID, Account Code, Account ID, Amount, Bank Amount, Currency Rate (+12 more) Yes
Prepayments View prepayment records Contact ID, Contact Name, Credit Note ID, Credit Note Number, Currency Code, Currency Rate (+12 more) No
Profit and Loss Retrieves profit and loss data Date Start, Date Stop, Item, Report ID, Report Name, Value (+1 more) Yes
Profit and Loss by Tracking Category Returns a profit and loss broken down by tracking category Account ID, Account Name, Date Start, Date Stop, Report Date, Report Name (+7 more) Yes
Projects View project details and statuses Contact Id, Credit Note Amount Currency, Credit Note Amount Value, Currency Code, Deposit Applied Currency, Deposit Applied Value (+29 more) Yes
Purchase orders Retrieve purchase orders data Attention To, Contact ID, Contact Name, Currency Code, Currency Rate, Date (+12 more) No
Quotes Line Items Retrieve Quotes data with line items Contact Email Address, Contact First Name, Contact ID, Contact Last Name, Contact Name, Currency Code (+25 more) No
Quotes View sales quotes Contact Email Address, Contact First Name, Contact ID, Contact Last Name, Contact Name, Currency Code (+15 more) No
Tenants List tenants you have access to Created Date, Tenant ID, Tenant Name, Tenant Type, Xero Tenant Id No
Tracking categories Retrieve tracking categories data Tracking Category ID, Name, Status, Xero Tenant Id No
Trial Balance Returns a trial balance for the current month up to the date specified. YTD values are shown too. Account Code, Account Name, Credit, Date Start, Date Stop, Debit (+5 more) Yes

How Data Extraction Works

What each extraction pulls depends only on whether a dataset supports a date range (see the Date range column above):

  • Date range supported (Yes): the source reads a relative window (for example "last 7 days"), and that window slides forward with the current date. Every run re-reads the window, so a range of "1 day ago" always pulls the previous day (D-1). Each run replaces the window's data rather than adding older history. To load records from before the window, run a full data re-sync with a wider range. See Data Backfilling.
  • No date range (No): every run pulls all currently available data.

Set the relative date range when you create the source.

Metadata Columns

When you create a source, you can add these Dataddo metadata columns to the extracted data:

  • dataddo_hash - a fingerprint built from each record's key fields. It works as a natural key, so it is ideal for upserts (updating existing rows in your destination instead of creating duplicates).
  • dataddo_extraction_timestamp - the date and time the row was extracted. Use it to track how records change over time, for example to build slowly changing dimensions.

How to Create a Xero Data Source

Creating a data source takes you through six steps, shown in the progress bar at the top of the wizard. Each step is explained below.

1. Pick the connector

On the Sources page, click Create Source, then select the connector from the catalog. Use the search bar or the category tabs if you do not see it right away. You can rename the source at any time using the pencil icon next to its name.

2. Select the dataset

A dataset defines the shape of your data: which fields you get and how they relate. Select the dataset you want; you can still fine-tune the exact fields later.

  • Each dataset has a short description of what it contains. Use the search box to find a dataset, attribute, or metric by name.
  • The panel on the right previews the selected dataset's fields. For each field you can see its data type, whether it holds sensitive data (personal fields such as name or email are flagged), and which other datasets it links to, so you can see how the datasets relate.

3. Choose the account

This step selects what Dataddo reads from.

  • Authorizer: Select an account you have already authorized from the drop-down. If you have none yet, choose Add new account and follow the prompts. If no authorizer is selected, Dataddo asks you to authorize before you continue.
  • What to extract from: Select the exact entity you want to pull data from. Depending on the service this may be labelled an account, property, profile, workspace, or similar, sometimes with a sub-level to choose as well.
  • Multiple accounts: To pull the same data from every entity you can access, turn on Automatically collect data from all .... This is multi-account extraction. Leave it off to choose them by hand.

4. Refine the attributes and metrics

The dataset already sets the structure. Here you fine-tune it: tick or untick the specific attributes and metrics you want to keep, and use the search box to find a field quickly. Click Test on Sample Data at any point to preview the result before you continue.

5. Add metadata columns (optional)

Two optional columns help your destination handle the data.

  • Dataddo Hash (Include Row Hash): a fingerprint built from the columns you pick. It works as a natural key, so your destination can deduplicate rows and run upserts instead of creating duplicates. Turn it on, then select the columns that uniquely identify a row.
  • Dataddo Extraction Timestamp: the time each row was extracted. Use it to watermark the data, for example to build slowly changing dimensions or to track when a value last changed.

6. Set the schedule

Decide how often Dataddo runs the extraction.

  • Frequency: how often the pipeline runs, for example daily. Click Show advanced settings to also set the exact hour and minute (UTC).
  • Date range: the relative window each run extracts, for example "Yesterday". The window moves forward on every run.
  • Historical data: a new source starts from the current window. To load older data, run a full data re-sync after the source is created.
  • Allow Empty Data Extractions: when on, a run that returns no data records zero rows instead of failing. Turn it on if the source can legitimately have periods with no data.

Click Save. Your data source is ready.

Troubleshooting

Data Preview Unavailable

No data preview when you click on Test Data might be caused by an issue with your source configuration. The most common causes are:

  • Date range: Try a smaller date range. You can load the rest of your data afterward via manual data load.
  • Insufficient permissions: Please make sure your authorized account has at least admin-level permissions.

Related Articles

Now that you have successfully created a data source, see how you can connect your data to a dashboarding app or a data storage.

Sending Data to Dashboarding Apps

Sending Data to Data Storages

Other Resources