This integration is powered by Singer's Xero tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
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 (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on August 22, 2018 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Xero
Xero setup requirements
To set up Xero in Stitch, you need:
-
To enable Single Sign-On (SSO) authentication in your Stitch account. For more information, see Enabling SSO.
Step 1: Add Xero as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Xero icon.
-
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. - Optional: Check Include archived contacts to have Stitch replicate records for archived contacts. If left unchecked, only records for active contacts will be replicated.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Xero integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
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:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
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
Next, you’ll be directed to Xero’s website to complete the setup.
- Enter your Xero credentials and click Login.
- A screen asking for authorization to Xero will display. Note that Stitch will only ever read your data.
- From the dropdown menu, select the company you want to connect to Stitch.
- Click Authorise.
- After the authorization process successfully completes, you’ll be redirected back to Stitch.
- Click All Done.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Xero integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
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.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
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
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Xero integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
accounts
The accounts
table contains info about the various accounts (ex: banking) connected to your Xero account.
Key-based Incremental |
|
Primary Key |
AccountID |
Replication Key |
UpdatedDateUTC |
Useful links |
Join accounts with | on |
---|---|
bank_transactions |
accounts.AccountID = bank_transactions.BankAccount.AccountID accounts.CurrencyCode = bank_transactions.CurrencyCode |
bank_transfers |
accounts.AccountID = bank_transfers.FromBankAccount.AccountID accounts.AccountID = bank_transfers.ToBankAccount.AccountID |
journals |
accounts.AccountID = journals.JournalLines.AccountID |
payments |
accounts.AccountID = payments.Account.AccountID |
credit_notes |
accounts.CurrencyCode = credit_notes.CurrencyCode |
currencies |
accounts.CurrencyCode = currencies.Code |
invoices |
accounts.CurrencyCode = invoices.CurrencyCode |
prepayments |
accounts.CurrencyCode = prepayments.CurrencyCode |
purchase_orders |
accounts.CurrencyCode = purchase_orders.CurrencyCode |
repeating_invoices |
accounts.CurrencyCode = repeating_invoices.CurrencyCode |
AccountID STRING |
BankAccountNumber STRING |
BankAccountType STRING |
Class STRING |
Code STRING |
CurrencyCode STRING |
Description STRING |
EnablePaymentsToAccount BOOLEAN |
HasAttachments BOOLEAN |
Name STRING |
ReportingCode STRING |
ReportingCodeName STRING |
ShowInExpenseClaims BOOLEAN |
Status STRING |
SystemAccount STRING |
TaxType STRING |
Type STRING |
UpdatedDateUTC DATE-TIME |
bank_transactions
The bank_transactions
table contains info about the bank transactions in your Xero account.
Key-based Incremental |
|
Primary Key |
BankTransactionID |
Replication Key |
UpdatedDateUTC |
Useful links |
Join bank_transactions with | on |
---|---|
accounts |
bank_transactions.BankAccount.AccountID = accounts.AccountID bank_transactions.CurrencyCode = accounts.CurrencyCode |
bank_transfers |
bank_transactions.BankAccount.AccountID = bank_transfers.FromBankAccount.AccountID bank_transactions.BankAccount.AccountID = bank_transfers.ToBankAccount.AccountID |
journals |
bank_transactions.BankAccount.AccountID = journals.JournalLines.AccountID |
payments |
bank_transactions.BankAccount.AccountID = payments.Account.AccountID bank_transactions.OverpaymentID = payments.Overpayment.OverpaymentID bank_transactions.PrepaymentID = payments.Prepayments.PrepaymentID |
linked_transactions |
bank_transactions.BankTransactionID = linked_transactions.SourceTransactionID |
credit_notes |
bank_transactions.CurrencyCode = credit_notes.CurrencyCode |
currencies |
bank_transactions.CurrencyCode = currencies.Code |
invoices |
bank_transactions.CurrencyCode = invoices.CurrencyCode bank_transactions.OverpaymentID = invoices.Overpayments.Overpayment.OverpaymentID bank_transactions.PrepaymentID = invoices.Prepayments.PrepaymentID bank_transactions.BankTransactionID = invoices.InvoiceID |
prepayments |
bank_transactions.CurrencyCode = prepayments.CurrencyCode bank_transactions.PrepaymentID = prepayments.PrepaymentID |
purchase_orders |
bank_transactions.CurrencyCode = purchase_orders.CurrencyCode |
repeating_invoices |
bank_transactions.CurrencyCode = repeating_invoices.CurrencyCode |
overpayments |
bank_transactions.OverpaymentID = overpayments.OverpaymentID |
BankAccount OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BankTransactionID STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contact OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CurrencyCode STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CurrencyRate NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Date DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DateString DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ExternalLinkProviderName STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HasAttachments BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IsReconciled BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LineAmountTypes STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LineItems ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OverpaymentID STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PrepaymentID STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Reference STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SubTotal NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Total NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TotalTax NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UpdatedDateUTC DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Url STRING |
bank_transfers
The bank_transfers
table contains info about bank transfers.
Key-based Incremental |
|
Primary Key |
BankTransferID |
Replication Key |
CreatedDateUTC |
Useful links |
Join bank_transfers with | on |
---|---|
accounts |
bank_transfers.FromBankAccount.AccountID = accounts.AccountID bank_transfers.ToBankAccount.AccountID = accounts.AccountID |
bank_transactions |
bank_transfers.FromBankAccount.AccountID = bank_transactions.BankAccount.AccountID bank_transfers.ToBankAccount.AccountID = bank_transactions.BankAccount.AccountID |
journals |
bank_transfers.FromBankAccount.AccountID = journals.JournalLines.AccountID bank_transfers.ToBankAccount.AccountID = journals.JournalLines.AccountID |
payments |
bank_transfers.FromBankAccount.AccountID = payments.Account.AccountID bank_transfers.ToBankAccount.AccountID = payments.Account.AccountID |
Amount NUMBER |
||||||||||||||||||
BankTransferID STRING |
||||||||||||||||||
CreatedDateUTC DATE-TIME |
||||||||||||||||||
CreatedDateUTCString DATE-TIME |
||||||||||||||||||
CurrencyRate NUMBER |
||||||||||||||||||
Date DATE-TIME |
||||||||||||||||||
DateString DATE-TIME |
||||||||||||||||||
FromBankAccount OBJECT
|
||||||||||||||||||
FromBankTransactionID STRING |
||||||||||||||||||
HasAttachments BOOLEAN |
||||||||||||||||||
ToBankAccount OBJECT
|
||||||||||||||||||
ToBankTransactionID STRING |
branding_themes
The branding_themes
table contains info about your branding themes. A branding theme is customization you can apply to customer-facing documents such as invoices, statements, quotes, etc.
Full Table |
|
Primary Key |
BrandingThemeID |
Useful links |
Join branding_themes with | on |
---|---|
contacts |
branding_themes.BrandingThemeID = contacts.BrandingTheme.BrandingThemeID |
credit_notes |
branding_themes.BrandingThemeID = credit_notes.BrandingThemeID |
invoices |
branding_themes.BrandingThemeID = invoices.BrandingThemeID |
purchase_orders |
branding_themes.BrandingThemeID = purchase_orders.BrandingThemeID |
repeating_invoices |
branding_themes.BrandingThemeID = repeating_invoices.BrandingThemeID |
BrandingThemeID STRING |
CreatedDateUTC DATE-TIME |
Name STRING |
SortOrder INTEGER |
contact_groups
The contact_groups
table contains info about your contact groups. A contact group is a group of contacts that have something in common.
Note: Due to the limits of Xero’s API, only active contact groups (Status: ACTIVE
) may be retrieved.
Full Table |
|
Primary Key |
ContactGroupID |
Useful links |
Join contact_groups with | on |
---|---|
contacts |
contact_groups.ContactGroupID = contacts.ContactGroups.ContactGroupID |
ContactGroupID STRING |
HasValidationErrors BOOLEAN |
Name STRING |
Status STRING |
contacts
The contacts
table contains info about the customers and suppliers you do business with.
Key-based Incremental |
|
Primary Key |
ContactID |
Replication Key |
UpdatedDateUTC |
Useful links |
Join contacts with | on |
---|---|
branding_themes |
contacts.BrandingTheme.BrandingThemeID = branding_themes.BrandingThemeID |
credit_notes |
contacts.BrandingTheme.BrandingThemeID = credit_notes.BrandingThemeID contacts.ContactID = credit_notes.Contact.ContactID contacts.SalesTrackingCategories.TrackingCategoryID = credit_notes.LineItems.Tracking.TrackingCategoryID contacts.PurchasesTrackingCategories.TrackingCategoryID = credit_notes.LineItems.Tracking.TrackingCategoryID |
invoices |
contacts.BrandingTheme.BrandingThemeID = invoices.BrandingThemeID contacts.ContactID = invoices.Contact.ContactID contacts.SalesTrackingCategories.TrackingCategoryID = invoices.LineItems.Tracking.TrackingCategoryID contacts.PurchasesTrackingCategories.TrackingCategoryID = invoices.LineItems.Tracking.TrackingCategoryID |
purchase_orders |
contacts.BrandingTheme.BrandingThemeID = purchase_orders.BrandingThemeID contacts.SalesTrackingCategories.TrackingCategoryID = purchase_orders.LineItems.Tracking.TrackingCategoryID contacts.PurchasesTrackingCategories.TrackingCategoryID = purchase_orders.LineItems.Tracking.TrackingCategoryID |
repeating_invoices |
contacts.BrandingTheme.BrandingThemeID = repeating_invoices.BrandingThemeID contacts.ContactID = repeating_invoices.Contact.ContactID contacts.SalesTrackingCategories.TrackingCategoryID = repeating_invoices.LineItems.Tracking.TrackingCategoryID contacts.PurchasesTrackingCategories.TrackingCategoryID = repeating_invoices.LineItems.Tracking.TrackingCategoryID |
contact_groups |
contacts.ContactGroups.ContactGroupID = contact_groups.ContactGroupID |
linked_transactions |
contacts.ContactID = linked_transactions.ContactID |
overpayments |
contacts.ContactID = overpayments.Contact.ContactID contacts.SalesTrackingCategories.TrackingCategoryID = overpayments.LineItems.Tracking.TrackingCategoryID contacts.PurchasesTrackingCategories.TrackingCategoryID = overpayments.LineItems.Tracking.TrackingCategoryID |
prepayments |
contacts.ContactID = prepayments.Contact.ContactID contacts.SalesTrackingCategories.TrackingCategoryID = prepayments.LineItems.Tracking.TrackingCategoryID contacts.PurchasesTrackingCategories.TrackingCategoryID = prepayments.LineItems.Tracking.TrackingCategoryID |
receipts |
contacts.ContactID = receipts.Contact.ContactID contacts.SalesTrackingCategories.TrackingCategoryID = receipts.LineItems.Tracking.TrackingCategoryID contacts.PurchasesTrackingCategories.TrackingCategoryID = receipts.LineItems.Tracking.TrackingCategoryID |
journals |
contacts.SalesTrackingCategories.TrackingCategoryID = journals.JournalLines.TrackingCategories.TrackingCategoryID contacts.PurchasesTrackingCategories.TrackingCategoryID = journals.JournalLines.TrackingCategories.TrackingCategoryID |
manual_journals |
contacts.SalesTrackingCategories.TrackingCategoryID = manual_journals.JournalLines.Tracking.TrackingCategoryID contacts.PurchasesTrackingCategories.TrackingCategoryID = manual_journals.JournalLines.Tracking.TrackingCategoryID |
tracking_categories |
contacts.SalesTrackingCategories.TrackingCategoryID = tracking_categories.TrackingCategoryID contacts.PurchasesTrackingCategories.TrackingCategoryID = tracking_categories.TrackingCategoryID |
AccountNumber STRING |
|||||||||||||||
AccountsPayableTaxType STRING |
|||||||||||||||
AccountsReceivableTaxType STRING |
|||||||||||||||
Addresses ARRAY
|
|||||||||||||||
Attachments ARRAY |
|||||||||||||||
Balances OBJECT
|
|||||||||||||||
BankAccountDetails STRING |
|||||||||||||||
BatchPayments OBJECT
|
|||||||||||||||
BrandingTheme OBJECT
|
|||||||||||||||
ContactGroups ARRAY
|
|||||||||||||||
ContactID STRING |
|||||||||||||||
ContactNumber STRING |
|||||||||||||||
ContactPersons ARRAY
|
|||||||||||||||
ContactStatus STRING |
|||||||||||||||
DefaultCurrency STRING |
|||||||||||||||
Discount NUMBER |
|||||||||||||||
EmailAddress STRING |
|||||||||||||||
FirstName STRING |
|||||||||||||||
HasAttachments BOOLEAN |
|||||||||||||||
HasValidationErrors BOOLEAN |
|||||||||||||||
IsCustomer BOOLEAN |
|||||||||||||||
IsSupplier BOOLEAN |
|||||||||||||||
LastName STRING |
|||||||||||||||
Name STRING |
|||||||||||||||
PaymentTerms OBJECT
|
|||||||||||||||
Phones ARRAY
|
|||||||||||||||
PurchasesDefaultAccountCode STRING |
|||||||||||||||
PurchasesTrackingCategories ARRAY
|
|||||||||||||||
SalesDefaultAccountCode STRING |
|||||||||||||||
SalesTrackingCategories ARRAY
|
|||||||||||||||
SkypeUserName STRING |
|||||||||||||||
TaxNumber STRING |
|||||||||||||||
TrackingCategoryName STRING |
|||||||||||||||
TrackingCategoryOption STRING |
|||||||||||||||
UpdatedDateUTC DATE-TIME |
|||||||||||||||
ValidationErrors ARRAY
|
|||||||||||||||
Website STRING |
|||||||||||||||
XeroNetworkKey STRING |
credit_notes
The credit_notes
table contains info about credit notes. A credit note is similar to an invoice, except it reduces the amount you owe a supplier or the amount a customer owes you.
Key-based Incremental |
|
Primary Key |
CreditNoteID |
Replication Key |
UpdatedDateUTC |
Useful links |
Join credit_notes with | on |
---|---|
branding_themes |
credit_notes.BrandingThemeID = branding_themes.BrandingThemeID |
contacts |
credit_notes.BrandingThemeID = contacts.BrandingTheme.BrandingThemeID credit_notes.Contact.ContactID = contacts.ContactID credit_notes.LineItems.Tracking.TrackingCategoryID = contacts.SalesTrackingCategories.TrackingCategoryID credit_notes.LineItems.Tracking.TrackingCategoryID = contacts.PurchasesTrackingCategories.TrackingCategoryID |
invoices |
credit_notes.BrandingThemeID = invoices.BrandingThemeID credit_notes.Contact.ContactID = invoices.Contact.ContactID credit_notes.CreditNoteID = invoices.CreditNotes.CreditNoteID credit_notes.CurrencyCode = invoices.CurrencyCode credit_notes.LineItems.Tracking.TrackingCategoryID = invoices.LineItems.Tracking.TrackingCategoryID |
purchase_orders |
credit_notes.BrandingThemeID = purchase_orders.BrandingThemeID credit_notes.CurrencyCode = purchase_orders.CurrencyCode credit_notes.LineItems.Tracking.TrackingCategoryID = purchase_orders.LineItems.Tracking.TrackingCategoryID |
repeating_invoices |
credit_notes.BrandingThemeID = repeating_invoices.BrandingThemeID credit_notes.Contact.ContactID = repeating_invoices.Contact.ContactID credit_notes.CurrencyCode = repeating_invoices.CurrencyCode credit_notes.LineItems.Tracking.TrackingCategoryID = repeating_invoices.LineItems.Tracking.TrackingCategoryID |
linked_transactions |
credit_notes.Contact.ContactID = linked_transactions.ContactID |
overpayments |
credit_notes.Contact.ContactID = overpayments.Contact.ContactID credit_notes.LineItems.Tracking.TrackingCategoryID = overpayments.LineItems.Tracking.TrackingCategoryID |
prepayments |
credit_notes.Contact.ContactID = prepayments.Contact.ContactID credit_notes.CurrencyCode = prepayments.CurrencyCode credit_notes.LineItems.Tracking.TrackingCategoryID = prepayments.LineItems.Tracking.TrackingCategoryID |
receipts |
credit_notes.Contact.ContactID = receipts.Contact.ContactID credit_notes.LineItems.Tracking.TrackingCategoryID = receipts.LineItems.Tracking.TrackingCategoryID |
accounts |
credit_notes.CurrencyCode = accounts.CurrencyCode |
bank_transactions |
credit_notes.CurrencyCode = bank_transactions.CurrencyCode |
currencies |
credit_notes.CurrencyCode = currencies.Code |
journals |
credit_notes.LineItems.Tracking.TrackingCategoryID = journals.JournalLines.TrackingCategories.TrackingCategoryID |
manual_journals |
credit_notes.LineItems.Tracking.TrackingCategoryID = manual_journals.JournalLines.Tracking.TrackingCategoryID |
tracking_categories |
credit_notes.LineItems.Tracking.TrackingCategoryID = tracking_categories.TrackingCategoryID |
Allocations ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AppliedAmount NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BrandingThemeID STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contact OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CreditNoteID STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CreditNoteNumber STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CurrencyCode STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CurrencyRate NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Date DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DateString DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DueDate DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DueDateString DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FullyPaidOnDate DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HasAttachments BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ID STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LineAmountTypes STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LineItems ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Reference STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RemainingCredit NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SentToContact BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SubTotal NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Total NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TotalTax NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UpdatedDateUTC DATE-TIME |
currencies
The currencies
table contains info about the currencies available in your Xero account.
Full Table |
|
Primary Key |
Code |
Useful links |
Join currencies with | on |
---|---|
accounts |
currencies.Code = accounts.CurrencyCode |
bank_transactions |
currencies.Code = bank_transactions.CurrencyCode |
credit_notes |
currencies.Code = credit_notes.CurrencyCode |
invoices |
currencies.Code = invoices.CurrencyCode |
prepayments |
currencies.Code = prepayments.CurrencyCode |
purchase_orders |
currencies.Code = purchase_orders.CurrencyCode |
repeating_invoices |
currencies.Code = repeating_invoices.CurrencyCode |
Code STRING |
Description STRING |
employees
The employees
table contains info about employees.
Note: According to Xero’s documentation, the endpoint that produces this table is:
Used for an employee type used exclusively by the global Payrun functionality in Xero core accounting.
As a result, this table may not contain all employee data. Refer to the contacts
table if you believe you are missing records.
Key-based Incremental |
|
Primary Key |
EmployeeID |
Replication Key |
UpdatedDateUTC |
Useful links |
EmployeeID STRING |
ExternalLink STRING |
FirstName STRING |
LastName STRING |
Status STRING |
UpdatedDateUTC DATE-TIME |
expense_claims
The expense_claims
table contains info about expense claims.
Key-based Incremental |
|
Primary Key |
ExpenseClaimID |
Replication Key |
UpdatedDateUTC |
Useful links |
Join expense_claims with | on |
---|---|
invoices |
expense_claims.Payments.PaymentID = invoices.Payments.PaymentID |
overpayments |
expense_claims.Payments.PaymentID = overpayments.Payments.PaymentID |
payments |
expense_claims.Payments.PaymentID = payments.PaymentID |
receipts |
expense_claims.Receipts.ReceiptID = receipts.ReceiptID expense_claims.User.UserID = receipts.User.UserID |
AmountDue NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AmountPaid NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ExpenseClaimID STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PaymentDueDate DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Payments ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Receipts ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReportingDate DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Total NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UpdatedDateUTC DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
User OBJECT
|
invoices
The invoices
table contains info about sales invoices, which are requests for payment for goods and services.
Key-based Incremental |
|
Primary Key |
InvoiceID |
Replication Key |
UpdatedDateUTC |
Useful links |
Join invoices with | on |
---|---|
branding_themes |
invoices.BrandingThemeID = branding_themes.BrandingThemeID |
contacts |
invoices.BrandingThemeID = contacts.BrandingTheme.BrandingThemeID invoices.Contact.ContactID = contacts.ContactID invoices.LineItems.Tracking.TrackingCategoryID = contacts.SalesTrackingCategories.TrackingCategoryID invoices.LineItems.Tracking.TrackingCategoryID = contacts.PurchasesTrackingCategories.TrackingCategoryID |
credit_notes |
invoices.BrandingThemeID = credit_notes.BrandingThemeID invoices.Contact.ContactID = credit_notes.Contact.ContactID invoices.CreditNotes.CreditNoteID = credit_notes.CreditNoteID invoices.CurrencyCode = credit_notes.CurrencyCode invoices.LineItems.Tracking.TrackingCategoryID = credit_notes.LineItems.Tracking.TrackingCategoryID |
purchase_orders |
invoices.BrandingThemeID = purchase_orders.BrandingThemeID invoices.CurrencyCode = purchase_orders.CurrencyCode invoices.LineItems.Tracking.TrackingCategoryID = purchase_orders.LineItems.Tracking.TrackingCategoryID |
repeating_invoices |
invoices.BrandingThemeID = repeating_invoices.BrandingThemeID invoices.Contact.ContactID = repeating_invoices.Contact.ContactID invoices.CurrencyCode = repeating_invoices.CurrencyCode invoices.LineItems.Tracking.TrackingCategoryID = repeating_invoices.LineItems.Tracking.TrackingCategoryID |
linked_transactions |
invoices.Contact.ContactID = linked_transactions.ContactID invoices.InvoiceID = linked_transactions.SourceTransactionID invoices.InvoiceID = linked_transactions.TargetTransactionID |
overpayments |
invoices.Contact.ContactID = overpayments.Contact.ContactID invoices.InvoiceID = overpayments.Allocations.Invoice.InvoiceID invoices.Overpayments.Overpayment.OverpaymentID = overpayments.OverpaymentID invoices.Payments.PaymentID = overpayments.Payments.PaymentID invoices.LineItems.Tracking.TrackingCategoryID = overpayments.LineItems.Tracking.TrackingCategoryID |
prepayments |
invoices.Contact.ContactID = prepayments.Contact.ContactID invoices.CurrencyCode = prepayments.CurrencyCode invoices.InvoiceID = prepayments.Allocations.Invoice.InvoiceID invoices.Prepayments.PrepaymentID = prepayments.PrepaymentID invoices.LineItems.Tracking.TrackingCategoryID = prepayments.LineItems.Tracking.TrackingCategoryID |
receipts |
invoices.Contact.ContactID = receipts.Contact.ContactID invoices.LineItems.Tracking.TrackingCategoryID = receipts.LineItems.Tracking.TrackingCategoryID |
accounts |
invoices.CurrencyCode = accounts.CurrencyCode |
bank_transactions |
invoices.CurrencyCode = bank_transactions.CurrencyCode invoices.Overpayments.Overpayment.OverpaymentID = bank_transactions.OverpaymentID invoices.Prepayments.PrepaymentID = bank_transactions.PrepaymentID invoices.InvoiceID = bank_transactions.BankTransactionID |
currencies |
invoices.CurrencyCode = currencies.Code |
payments |
invoices.InvoiceID = payments.Invoice.InvoiceID invoices.Overpayments.Overpayment.OverpaymentID = payments.Overpayment.OverpaymentID invoices.Payments.PaymentID = payments.PaymentID invoices.Prepayments.PrepaymentID = payments.Prepayments.PrepaymentID |
expense_claims |
invoices.Payments.PaymentID = expense_claims.Payments.PaymentID |
journals |
invoices.LineItems.Tracking.TrackingCategoryID = journals.JournalLines.TrackingCategories.TrackingCategoryID |
manual_journals |
invoices.LineItems.Tracking.TrackingCategoryID = manual_journals.JournalLines.Tracking.TrackingCategoryID |
tracking_categories |
invoices.LineItems.Tracking.TrackingCategoryID = tracking_categories.TrackingCategoryID |
AmountCredited NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AmountDue NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AmountPaid NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BrandingThemeID STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contact OBJECT
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CreditNotes ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CurrencyCode STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CurrencyRate NUMBER |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Date DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DateString DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DueDate DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DueDateString DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ExpectedPaymentDate DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ExpectedPaymentDateString DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FullyPaidOnDate DATE-TIME |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HasAttachments BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HasErrors BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InvoiceID STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InvoiceNumber STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IsDiscounted BOOLEAN |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LineAmountTypes STRING |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LineItems ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Overpayments ARRAY
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Payments ARRAY
|