Xero integration summary

Stitch’s Xero integration replicates data using the Xero Accounting API. Refer to the Schema section for a list of objects available for replication.

Xero feature snapshot

A high-level look at Stitch's Xero (v19-10-2016) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Deprecated on October 22, 2018

 Supported by

[Stitch] (https://community.qlik.com/t5/Support/ct-p/qlikSupport)
Stitch plan

Standard

 API availability

Not available
Singer GitHub repository

Not applicable
REPLICATION SETTINGS
Anchor Scheduling

Unsupported

 Advanced Scheduling

Unsupported
Table-level reset

Unsupported

 Configurable Replication Methods

Unsupported
DATA SELECTION
Table selection

Unsupported

 Column selection

Unsupported
Select all

Unsupported
TRANSPARENCY
Extraction Logs

Unsupported

 Loading Reports

Supported

Connecting Xero

Step 1: Add Xero as a Stitch data source

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Xero icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Xero” would create a schema called stitch_xero in the destination. Note: Schema names cannot be changed after you save the integration.

Step 2: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Xero integration. This means that:

  • For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
  • For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.

Change this setting if you want to replicate data beyond Xero’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 3: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Xero integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 4: Authorize Stitch to access Xero

Lastly, you’ll be directed to Xero’s website to complete the setup.

  1. Enter your Xero credentials and click Login.
  2. A screen asking for authorization to Xero will display. Note that Stitch will only ever read your data.
  3. From the dropdown menu, select the company you want to connect to Stitch.
  4. Click Authorise.
  5. After the authorization process successfully completes, you’ll be redirected back to Stitch.
  6. Click All Done.

Initial and historical replication jobs

After you finish setting up Xero, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Xero table reference


xero_accounts

Replication Method: Key-based Incremental
Primary Key: accountid
Contains Nested Structures?: No

The xero_accounts table contains info about the various accounts (ex: banking) connected to your Xero account.

Table Info & Attributes

xero_accounts Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Account ID (accountid)

  • code

  • name

  • type

  • bankaccountnumber

  • taxtype

  • enablepaymentstoaccount

  • bankaccounttype

  • currencycode

  • systemaccount

  • reportingcode

  • reportingcodename

  • hasattachments

  • updateddateutc

xero_bank_transactions

Replication Method: Key-based Incremental
Primary Key: banktransactionid
Contains Nested Structures?: Yes

The xero_bank_transactions table contains information about any bank transactions - for example, overpayments, prepayments, spend, etc. - in your Xero account.

Table Info & Attributes

xero_bank_transactions & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

xero_bank_transactions Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Bank Transaction ID (banktransactionid)

  • contact__contactid

  • contact__contactstatus

  • lineitems*

  • bankaccount

  • isreconciled

  • date

  • reference

  • currencycode

  • currencyrate

  • url

  • status

  • lineamounttypes

  • subtotal

  • totaltax

  • total

  • overpaymentid

  • updateddateutc

  • hasattachments

xero_bank_transfers

Replication Method: Key-based Incremental
Primary Key: banktransferid
Contains Nested Structures?: No

The xero_bank_transfers table contains info about bank transfers.

Table Info & Attributes

xero_bank_transfers Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Bank Transfer ID (banktransferid)

  • frombankaccount*

  • tobankaccount*

  • amount

  • date

  • currencyrate

  • frombanktransactionid

  • tobanktransactionid

  • hasattachments

  • createddateutc

xero_branding_themes

Replication Method: Full Table
Primary Key: brandingthemeid
Contains Nested Structures?: No

The xero_branding_themes table contains info about the branding themes defined for a Xero organisation.

Table Info & Attributes

xero_branding_themes Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Branding Theme ID (brandingthemeid)

  • name

  • sortorder

  • createddateutc

xero_contacts

Replication Method: Key-based Incremental
Primary Key: contactid
Contains Nested Structures?: Yes

The xero_contacts table contains info about the contacts in a Xero organisation.

Table Info & Attributes

xero_contacts & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

xero_contacts Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Contact ID (contactid)

  • accountnumber

  • accountspayabletaxtype

  • accountsreceivabletaxtype

  • addresses*

  • balances__accountspayable__outstanding

  • balances__accountspayable__overdue

  • balances__accountsreceivable__outstanding

  • balances__accountsreceivable__overdue

  • bankaccountdetails

  • batchpayments__bankaccountname

  • batchpayments__bankaccountnumber

  • batchpayments__code

  • batchpayments__details

  • batchpayments__reference

  • batchpayments__brandingthemeid

  • batchpayments__name

  • contactstatus

  • contactgroups*

  • contactpersons

  • defaultcurrency

  • emailaddress

  • firstname

  • hasattachments

  • hasvalidationerrors

  • iscustomer

  • issupplier

  • lastname

  • name

  • phone*

  • skypeusername

  • taxnumber

  • updateddateutc

xero_contact_groups

Replication Method: Full Table
Primary Key: contactgroupid
Contains Nested Structures?: No

The xero_contact_groups table contains info about the contact groups in a Xero organisation.

Table Info & Attributes

xero_contact_groups Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Contact Group ID (contactgroupid)

  • name

  • status

  • contacts

xero_credit_notes

Replication Method: Key-based Incremental
Primary Key: creditnoteid
Contains Nested Structures?: Yes

The xero_credit_notes table contains info about the credit notes in your Xero organisation.

Table Info & Attributes

xero_credit_notes & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

xero_credit_notes Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Credit Note ID (creditnoteid)

  • type

  • contact__id

  • contact__hasvalidationerrors

  • name

  • date

  • status

  • lineamounttypes

  • lineitems*

  • subtotal

  • totaltax

  • total

  • updateddateutc

  • currencycode

  • fullypaidondate

  • creditnotenumber

  • reference

  • senttocontact

  • currencyrate

  • remainingcredit

  • allocations*

  • brandingthemeid

  • hasattachments

xero_currencies

Replication Method: Full Table
Primary Key: code
Contains Nested Structures?: No

The xero_currencies table contains info about the currencies set up for your Xero organisation.

Table Info & Attributes

xero_currencies Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Currency Code (code)

  • description

xero_employees

Replication Method: Key-based Incremental
Primary Key: employeeid
Contains Nested Structures?: No

The xero_employees table contains info about the employees used in Xero payrun.

Table Info & Attributes

xero_employees Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Employee ID (employeeid)

  • status

  • firstname

  • lastname

  • updateddateutc

xero_expense_claims

Replication Method: Key-based Incremental
Primary Key: expenseclaimid
Contains Nested Structures?: No

The xero_expense_claims table contains info about the expense claims for your Xero organisation.

Table Info & Attributes

xero_expense_claims Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Expense Claim ID (expenseclaimid)

  • user__emailaddress

  • user__firstname

  • user__lastname

  • user__issubscriber

  • user__organisationrole

  • user__updateddateutc

  • user__userid

  • receipts

  • payments

  • status

  • total

  • amountdue

  • amountpaid

  • paymentduedate

  • reportingdate

  • updateddateutc

xero_invoices

Replication Method: Key-based Incremental
Primary Key: invoiceid
Contains Nested Structures?: Yes

The xero_invoices table contains info about the sales invoices and purchase bills for your Xero organisation.

Table Info & Attributes

xero_invoices & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

xero_invoices Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Invoice ID (invoiceid)

  • amountcredited

  • amountdue

  • amountpaid

  • brandingthemeid

  • contact__contactid

  • contact__hasvalidationerrors

  • contact__name

  • creditnotes*

  • currencycode

  • currencyrate

  • date

  • duedate

  • fullypaidondate

  • hasattachments

  • haserrors

  • invoicenumber

  • isdiscounted

  • lineamounttypes

  • lineitems*

  • payments

  • prepayments

  • overpayments

  • reference

  • senttocontact

  • status

  • subtotal

  • total

  • totaldiscount

  • totaltax

  • type

  • updateddateutc

xero_items

Replication Method: Key-based Incremental
Primary Key: itemid
Contains Nested Structures?: No

The xero_items table contains info about the goods and services in your Xero account.

Table Info & Attributes

xero_items Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Item ID (itemid)

  • code

  • inventoryassetaccountcode

  • name

  • issold

  • ispurchased

  • description

  • purchasedescription

  • purchasedetails__accountcode

  • purchasedetails__cogsaccountcode

  • purchasedetails__taxtype

  • purchasedetails__unitprice

  • salesdetails__accountcode

  • salesdetails__taxtype

  • salesdetails__unitprice

  • istrackedasinventory

  • totalcostpool

  • quantityonhand

  • updateddateutc

xero_journals

Replication Method: Key-based Incremental
Primary Key: journalid
Contains Nested Structures?: Yes

The xero_journals table contains info about the journals in your Xero account.

Table Info & Attributes

xero_journals & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

xero_journals Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Journal ID (journalid)

  • createddateutc

  • journaldate

  • journallines*

  • journalnumber

  • reference

  • sourceid

  • sourcetype

xero_linked_transactions

Replication Method: Full Table
Primary Key: linkedtransactionid
Contains Nested Structures?: No

The xero_linked_transactions table contains info about the billable expenses in your Xero account.

Table Info & Attributes

xero_linked_transactions Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Linked Transaction ID (linkedtransactionid)

  • sourcetransactionid

  • sourcelineitemid

  • contactid

  • targettransactionid

  • targetlineitemid

  • status

  • type

  • sourcetransactiontypecode

  • updateddateutc

xero_manual_journals

Replication Method: Key-based Incremental
Primary Key: manualjournalid
Contains Nested Structures?: Yes

The xero_manual_journals table contains info about the manual journals in your Xero account.

Table Info & Attributes

xero_manual_journals & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

xero_manual_journals Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Manual Journal ID (manualjournalid)

  • narration

  • journallines*

  • date

  • lineamounttypes

  • status

  • url

  • showoncashbasisreports

  • hasattachments

  • updateddateutc

xero_organisation

Replication Method: Full Table
Primary Key: taxnumber
Contains Nested Structures?: Yes

The xero_organisation table contains info about your Xero organisation.

Table Info & Attributes

xero_organisation & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

xero_organisation Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • taxnumber

  • addresses*

  • basecurrency

  • countrycode

  • createddateutc

  • defaultpurchasetax

  • defaultsalestax

  • financialyearendday

  • financialyearendmonth

  • isdemocompany

  • legalname

  • lineofbusiness

  • name

  • organisationentitytype

  • organisationstatus

  • organisationtype

  • paymentterms__bills__day

  • paymentterms__bills__type

  • paymentterms__sales__day

  • paymentterms__sales__type

  • paystax

  • periodlockdate

  • phones*

  • salestaxbasis

  • salestaxperiod

  • shortcode

  • timezone

  • version

xero_overpayments

Replication Method: Key-based Incremental
Primary Key: overpaymentid
Contains Nested Structures?: Yes

The xero_overpayments table contains info about overpayments in your Xero account.

Table Info & Attributes

xero_overpayments & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

xero_overpayments Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Overpayment ID (overpaymentid)

  • type

  • contact__contactid

  • contact__name

  • date

  • status

  • lineamounttypes

  • lineitems*

  • subtotal

  • totaltax

  • total

  • currencycode

  • currencyrate

  • remainingcredit

  • allocations*

  • payments

  • hasattachments

xero_payments

Replication Method: Key-based Incremental
Primary Key: paymentid
Contains Nested Structures?: No

The xero_payments table contains info about the payments - invoice, credit note, prepayment, or overpayment - in your Xero account.

Table Info & Attributes

xero_payments Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Payment ID (paymentid)

  • accountid

  • code

  • date

  • currencyrate

  • amount

  • reference

  • status

  • paymenttype

  • updateddateutc

xero_prepayments

Replication Method: Key-based Incremental
Primary Key: prepaymentid
Contains Nested Structures?: No

The xero_prepayments table contains info about the preypayments in your Xero account.

Table Info & Attributes

xero_prepayments Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Prepayment ID (prepaymentid)

  • type

  • contact__contactid

  • contact__name

  • date

  • status

  • lineamounttypes

  • lineitems*

  • subtotal

  • totaltax

  • total

  • currencycode

  • currencyrate

  • remainingcredit

  • allocations*

  • hasattachments

  • updateddateutc

xero_purchase_orders

Replication Method: Key-based Incremental
Primary Key: purchaseorderid
Contains Nested Structures?: No

The xero_purchase_orders table contains info about the purchase orders in your Xero account.

Table Info & Attributes

xero_purchase_orders Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Purchase Order ID (purchaseorderid)

  • contact__contactid

  • contact__name

  • lineitems*

  • date

  • deliverydate

  • lineamounttypes

  • reference

  • brandingthemeid

  • currencycode

  • status

  • senttocontact

  • deliveryaddress

  • attentionto

  • telephone

  • deliveryinstructions

  • expectedarrivaldate

  • purchaseordernumber

  • currencyrate

  • subtotal

  • totaltax

  • totaldiscount

  • hasattachments

  • updateddateutc

xero_receipts

Replication Method: Key-based Incremental
Primary Key: receiptid
Contains Nested Structures?: Yes

The xero_receipts table contains info about the expense claim receipts in your Xero account.

Table Info & Attributes

xero_receipts & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

xero_receipts Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Receipt ID (receiptid)

  • date

  • contact__contactid

  • contact__name

  • lineitems*

  • user

  • reference

  • lineamounttypes

  • subtotal

  • totaltax

  • total

  • status

  • receiptnumber

  • hasattachments

  • url

  • updateddateutc

xero_repeating_invoices

Replication Method: Full Table
Primary Key: repeatinginvoiceid
Contains Nested Structures?: No

The xero_repeating_invoices table contains info about repeating invoices in your Xero account.

Table Info & Attributes

xero_repeating_invoices Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

xero_tax_rates

Replication Method: Full Table
Primary Key: name
Contains Nested Structures?: Yes

The xero_tax_rates table contains info about the tax rates in your Xero account.

Table Info & Attributes

xero_tax_rates & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

xero_tax_rates Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Tax Rate Name (name)

  • taxtype

  • taxcomponents*

  • status

  • reporttaxtype

  • canapplytoassets

  • canapplytoequity

  • canapplytoexpenses

  • canapplytoliabilities

  • canapplytorevenue

  • displaytaxrate

  • effectiverate

xero_tracking_categories

Replication Method: Full Table
Primary Key: trackingcategoryid
Contains Nested Structures?: Yes

The xero_tracking_categories table contains info the tracking categories and options in your Xero account.

Table Info & Attributes

xero_tracking_categories & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

xero_tracking_categories Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • Tracking Category ID (trackingcategoryid)

  • name

  • status

  • options*

xero_users

Replication Method: Key-based Incremental
Primary Key: userid
Contains Nested Structures?: No

The xero_users table contains info about the users in your Xero account.

Table Info & Attributes

xero_users Attributes

While we try to include everything Xero has here, this may not be a full list of attributes. Refer to Xero's documentation for a full list and description of each attribute.

  • User ID (userid)

  • emailaddress

  • firstname

  • lastname

  • issubscriber

  • organisationrole

  • updateddateutc

Related Troubleshooting
Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.