Xero
Xero is an online accounting software for small businesses, automating invoicing, bank reconciliations, and reporting.
Xero integration replicates data using the Xero Accounting API.
See the Schema section for a list of objects available for replication. 進一步查看此連接器，包括實用的連結和支援的功能。
| 功能 | 支援詳細資訊 |
|---|---|
| 支援的 Qlik Talend Data Integration 專案 | 僅複寫專案。不支援資料管道專案。 |
複寫任務：
在資料湖中登陸資料任務：
| |
| 不需要手動產生中繼資料。 | |
| 僅支援變更欄資料類型操作。 | |
| LOB 欄 (NCLOB、CLOB 和 BLOB) 複寫 | 不支援。 |
| 已排程 CDC | 必填。此為目標與來源的變更保持同步的方式。 對於複寫任務，請參閱 排程任務 對於湖登陸任務，請參閱 排程湖登陸任務的 CDC |
| 通知 | 部分支援 |
| 監控 | 僅限 CDC，因為此連接器與完整載入無關。 |
| 自動解除 JSON 欄裝載的巢狀結構 | 不支援。來源資料集中的 JSON 欄裝載不會在目標上自動解除巢狀結構。 |
Preparing for authentication
To access your data, you need to authenticate the connection with your account credentials.
資訊備註確認您使用的帳戶可讀取您要擷取的表格。
To connect to the Xero integration, you need to have your client ID, client secret, user ID, and tenant ID. Follow the procedures below to copy each setting.
To obtain your client ID and secret:
- Log into your Xero account.
- Create a new app.
- Click Configuration on the left. The client ID and secret are displayed.
- As the client secret is displayed only once, copy and paste it to a secured file. Otherwise, you have to create a new app.
- Make sure Authorized Redirect URIs is set to https://connector.qlik.com/auth/oauth/v3.htm.
To obtain your user ID:
- Log into your Xero account.
- Select the organization in the drop-down list in the top-left corner.
- Select User from the menu.
- Select the user account you want to use.
The user ID is part of the URL
https://go.xero.com/app/.../settings/users/edit?userId=%7BTHIS_IS_THE_USER_ID%7D).
To obtain your tenant ID:
- Log into your Xero account.
- To display the tenant ID, select Show auto-generated headers.
Creating the connection
For more information, see 連線到 SaaS 應用程式.
Click Authenticate when you have filled in the required connection settings.
You may be asked to log in to the source application.
A window is displayed with an authentication code.
Copy the code to the clipboard and return to the connection dialog.
Paste the code in Complete authentication with the code provided by the source and click Verify.
提示備註You may need to scroll down to see this field.When status is Verified, the authentication is verified.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
| Setting | Description |
|---|---|
| Data gateway | 如您的使用情況有需要，選取 資料移動閘道。 資訊備註 此欄位無法用於 Qlik Talend Cloud 啟動器 訂閱，因為不支援 資料移動閘道。若您有另一個訂閱層級且不想使用 資料移動閘道，選取無。 如需關於 資料移動閘道 福利的資訊以及需要此項的使用案例，請參閱 Qlik 資料閘道 - 資料移動。 |
| Start Date | 以 |
| Include Archived Contacts | Select the check box to include archive contacts. |
| Client ID | Client ID. |
| Access Token | Access token. |
| Organization Name | Organization name. |
| Xero User ID | Xero user ID. |
| Tenant ID | Tenant ID. |
Schema
資訊備註
Schemas and versioning
Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.
The schema and info displayed below is for version 1.
accounts
The accounts table contains info about the various accounts (ex: banking) connected to your Xero account.
Replication Method | CDC |
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.
Replication Method | CDC |
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 This is a nested data structure:
|
BankTransactionID STRING |
Contact OBJECT This is a nested data structure:
|
CurrencyCode STRING |
CurrencyRate NUMBER |
Date DATE-TIME |
DateString DATE-TIME |
ExternalLinkProviderName STRING |
HasAttachments BOOLEAN |
IsReconciled BOOLEAN |
LineAmountTypes STRING |
LineItems ARRAY This is a nested data structure:
|
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.
Replication Method | CDC |
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 This is a nested data structure:
|
FromBankTransactionID STRING |
HasAttachments BOOLEAN |
ToBankAccount OBJECT This is a nested data structure:
|
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.
Replication Method | 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.
Replication Method | 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.
Replication Method | CDC |
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 This is a nested data structure:
|
Attachments ARRAY |
Balances OBJECT This is a nested data structure:
|
BankAccountDetails STRING |
BatchPayments OBJECT This is a nested data structure:
|
BrandingTheme OBJECT This is a nested data structure:
|
ContactGroups ARRAY This is a nested data structure:
|
ContactID STRING |
ContactNumber STRING |
ContactPersons ARRAY This is a nested data structure:
|
ContactStatus STRING |
DefaultCurrency STRING |
Discount NUMBER |
EmailAddress STRING |
FirstName STRING |
HasAttachments BOOLEAN |
HasValidationErrors BOOLEAN |
IsCustomer BOOLEAN |
IsSupplier BOOLEAN |
LastName STRING |
Name STRING |
PaymentTerms OBJECT This is a nested data structure:
|
Phones ARRAY This is a nested data structure:
|
PurchasesDefaultAccountCode STRING |
PurchasesTrackingCategories ARRAY This is a nested data structure:
|
SalesDefaultAccountCode STRING |
SalesTrackingCategories ARRAY This is a nested data structure:
|
SkypeUserName STRING |
TaxNumber STRING |
TrackingCategoryName STRING |
TrackingCategoryOption STRING |
UpdatedDateUTC DATE-TIME |
ValidationErrors ARRAY This is a nested data structure:
|
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.
Replication Method | CDC |
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 This is a nested data structure:
|
AppliedAmount NUMBER |
BrandingThemeID STRING |
Contact OBJECT This is a nested data structure:
|
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 This is a nested data structure:
|
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.
Replication Method | 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.
Replication Method | CDC |
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.
Replication Method | CDC |
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 This is a nested data structure:
|
Receipts ARRAY This is a nested data structure:
|
ReportingDate DATE-TIME |
Status STRING |
Total NUMBER |
UpdatedDateUTC DATE-TIME |
User OBJECT This is a nested data structure:
|
invoices
The invoices table contains info about sales invoices, which are requests for payment for goods and services.
Replication Method | CDC |
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 This is a nested data structure:
|
CreditNotes ARRAY This is a nested data structure:
|
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 This is a nested data structure:
|
Overpayments ARRAY This is a nested data structure:
|
Payments ARRAY This is a nested data structure:
|
PlannedPaymentDate DATE-TIME |
PlannedPaymentDateString DATE-TIME |
Prepayments ARRAY This is a nested data structure:
|
Reference STRING |
SentToContact BOOLEAN |
Status STRING |
SubTotal NUMBER |
Total NUMBER |
TotalDiscount NUMBER |
TotalTax NUMBER |
Type STRING |
UpdatedDateUTC DATE-TIME |
Url STRING |
items
The items table contains info about the products and services you buy and sell.
Replication Method | CDC |
Primary Key | ItemID |
Replication Key | UpdatedDateUTC |
| Useful links |
Code STRING |
Description STRING |
InventoryAssetAccountCode STRING |
IsPurchased BOOLEAN |
IsSold BOOLEAN |
IsTrackedAsInventory BOOLEAN |
ItemID STRING |
Name STRING |
PurchaseDescription STRING |
PurchaseDetails OBJECT This is a nested data structure:
|
QuantityOnHand NUMBER |
SalesDetails OBJECT This is a nested data structure:
|
TotalCostPool NUMBER |
UpdatedDateUTC DATE-TIME |
journals
The journals table contains info about journal entries.
Replication Method | CDC |
Primary Key | JournalID |
Replication Key | JournalNumber |
| Useful links |
| Join journals with | on |
|---|---|
| accounts | journals.JournalLines.AccountID = accounts.AccountID |
| bank_transactions | journals.JournalLines.AccountID = bank_transactions.BankAccount.AccountID |
| bank_transfers | journals.JournalLines.AccountID = bank_transfers.FromBankAccount.AccountID journals.JournalLines.AccountID = bank_transfers.ToBankAccount.AccountID |
| payments | journals.JournalLines.AccountID = payments.Account.AccountID |
| tax_rates | journals.JournalLines.TaxName = tax_rates.Name |
| contacts | journals.JournalLines.TrackingCategories.TrackingCategoryID = contacts.SalesTrackingCategories.TrackingCategoryID journals.JournalLines.TrackingCategories.TrackingCategoryID = contacts.PurchasesTrackingCategories.TrackingCategoryID |
| credit_notes | journals.JournalLines.TrackingCategories.TrackingCategoryID = credit_notes.LineItems.Tracking.TrackingCategoryID |
| invoices | journals.JournalLines.TrackingCategories.TrackingCategoryID = invoices.LineItems.Tracking.TrackingCategoryID |
| manual_journals | journals.JournalLines.TrackingCategories.TrackingCategoryID = manual_journals.JournalLines.Tracking.TrackingCategoryID |
| overpayments | journals.JournalLines.TrackingCategories.TrackingCategoryID = overpayments.LineItems.Tracking.TrackingCategoryID |
| prepayments | journals.JournalLines.TrackingCategories.TrackingCategoryID = prepayments.LineItems.Tracking.TrackingCategoryID |
| purchase_orders | journals.JournalLines.TrackingCategories.TrackingCategoryID = purchase_orders.LineItems.Tracking.TrackingCategoryID |
| receipts | journals.JournalLines.TrackingCategories.TrackingCategoryID = receipts.LineItems.Tracking.TrackingCategoryID |
| repeating_invoices | journals.JournalLines.TrackingCategories.TrackingCategoryID = repeating_invoices.LineItems.Tracking.TrackingCategoryID |
| tracking_categories | journals.JournalLines.TrackingCategories.TrackingCategoryID = tracking_categories.TrackingCategoryID |
CreatedDateUTC DATE-TIME |
JournalDate DATE-TIME |
JournalID STRING |
JournalLines ARRAY This is a nested data structure:
|
JournalNumber INTEGER |
Reference STRING |
SourceID STRING |
SourceType STRING |
linked_transactions
The linked_transactions table contains info about linked transactions. Linked transactions are transactions where line items from a purchase transaction to a customer are linked to a sales transaction.
Replication Method | CDC |
Primary Key | LinkedTransactionID |
Replication Key | UpdatedDateUTC |
| Useful links |
| Join linked_transactions with | on |
|---|---|
| bank_transactions | linked_transactions.SourceTransactionID = bank_transactions.BankTransactionID |
| contacts | linked_transactions.ContactID = contacts.ContactID |
| credit_notes | linked_transactions.ContactID = credit_notes.Contact.ContactID |
| invoices | linked_transactions.ContactID = invoices.Contact.ContactID linked_transactions.SourceTransactionID = invoices.InvoiceID linked_transactions.TargetTransactionID = invoices.InvoiceID |
| overpayments | linked_transactions.ContactID = overpayments.Contact.ContactID linked_transactions.SourceTransactionID = overpayments.Allocations.Invoice.InvoiceID linked_transactions.TargetTransactionID = overpayments.Allocations.Invoice.InvoiceID |
| prepayments | linked_transactions.ContactID = prepayments.Contact.ContactID linked_transactions.SourceTransactionID = prepayments.Allocations.Invoice.InvoiceID linked_transactions.TargetTransactionID = prepayments.Allocations.Invoice.InvoiceID |
| receipts | linked_transactions.ContactID = receipts.Contact.ContactID |
| repeating_invoices | linked_transactions.ContactID = repeating_invoices.Contact.ContactID |
| payments | linked_transactions.SourceTransactionID = payments.Invoice.InvoiceID linked_transactions.TargetTransactionID = payments.Invoice.InvoiceID |
ContactID STRING |
LinkedTransactionID STRING |
SourceLineItemID STRING |
SourceTransactionID STRING |
SourceTransactionTypeCode STRING |
Status STRING |
TargetLineItemID STRING |
TargetTransactionID STRING |
Type STRING |
UpdatedDateUTC DATE-TIME |
manual_journals
The manual_journals table contains info about manual journals, which are used by accountants or bookkeepers to work directly with a general ledger. For example: To record accrued expenses or completed work that wasn’t invoiced.
Replication Method | CDC |
Primary Key | ManualJournalID |
Replication Key | UpdatedDateUTC |
| Useful links |
| Join manual_journals with | on |
|---|---|
| contacts | manual_journals.JournalLines.Tracking.TrackingCategoryID = contacts.SalesTrackingCategories.TrackingCategoryID manual_journals.JournalLines.Tracking.TrackingCategoryID = contacts.PurchasesTrackingCategories.TrackingCategoryID |
| credit_notes | manual_journals.JournalLines.Tracking.TrackingCategoryID = credit_notes.LineItems.Tracking.TrackingCategoryID |
| invoices | manual_journals.JournalLines.Tracking.TrackingCategoryID = invoices.LineItems.Tracking.TrackingCategoryID |
| journals | manual_journals.JournalLines.Tracking.TrackingCategoryID = journals.JournalLines.TrackingCategories.TrackingCategoryID |
| overpayments | manual_journals.JournalLines.Tracking.TrackingCategoryID = overpayments.LineItems.Tracking.TrackingCategoryID |
| prepayments | manual_journals.JournalLines.Tracking.TrackingCategoryID = prepayments.LineItems.Tracking.TrackingCategoryID |
| purchase_orders | manual_journals.JournalLines.Tracking.TrackingCategoryID = purchase_orders.LineItems.Tracking.TrackingCategoryID |
| receipts | manual_journals.JournalLines.Tracking.TrackingCategoryID = receipts.LineItems.Tracking.TrackingCategoryID |
| repeating_invoices | manual_journals.JournalLines.Tracking.TrackingCategoryID = repeating_invoices.LineItems.Tracking.TrackingCategoryID |
| tracking_categories | manual_journals.JournalLines.Tracking.TrackingCategoryID = tracking_categories.TrackingCategoryID |
Date DATE-TIME |
HasAttachments BOOLEAN |
JournalLines ARRAY This is a nested data structure:
|
LineAmountTypes STRING |
ManualJournalID STRING |
Narration STRING |
ShowOnCashBasisReports BOOLEAN |
Status STRING |
UpdatedDateUTC DATE-TIME |
Url STRING |
organisations
The organisations table contains info about the organisations in your Xero account.
Replication Method | Full Table |
Primary Key | OrganisationID |
| Useful links |
APIKey STRING |
Addresses ARRAY This is a nested data structure:
|
BaseCurrency STRING |
CountryCode STRING |
CreatedDateUTC DATE-TIME |
DefaultPurchasesTax STRING |
DefaultSalesTax STRING |
EndOfYearLockDate DATE-TIME |
ExternalLinks ARRAY This is a nested data structure:
|
FinancialYearEndDay INTEGER |
FinancialYearEndMonth INTEGER |
IsDemoCompany BOOLEAN |
LegalName STRING |
LineOfBusiness STRING |
Name STRING |
OrganisationEntityType STRING |
OrganisationID STRING |
OrganisationStatus STRING |
OrganisationType STRING |
PaymentTerms OBJECT
|
PaysTax BOOLEAN |
PeriodLockDate DATE-TIME |
Phones ARRAY This is a nested data structure:
|
RegistrationNumber STRING |
SalesTaxBasis STRING |
SalesTaxPeriod STRING |
ShortCode STRING |
TaxNumber STRING |
Timezone STRING |
Version STRING |
overpayments
The overpayments table contains info about overpayments, which are transactions where a customer pays too much or you mistakenly overpay a supplier.
Replication Method | CDC |
Primary Key | OverpaymentID |
Replication Key | UpdatedDateUTC |
| Useful links |
| Join overpayments with | on |
|---|---|
| contacts | overpayments.Contact.ContactID = contacts.ContactID overpayments.LineItems.Tracking.TrackingCategoryID = contacts.SalesTrackingCategories.TrackingCategoryID overpayments.LineItems.Tracking.TrackingCategoryID = contacts.PurchasesTrackingCategories.TrackingCategoryID |
| credit_notes | overpayments.Contact.ContactID = credit_notes.Contact.ContactID overpayments.LineItems.Tracking.TrackingCategoryID = credit_notes.LineItems.Tracking.TrackingCategoryID |
| invoices | overpayments.Contact.ContactID = invoices.Contact.ContactID overpayments.Allocations.Invoice.InvoiceID = invoices.InvoiceID overpayments.OverpaymentID = invoices.Overpayments.Overpayment.OverpaymentID overpayments.Payments.PaymentID = invoices.Payments.PaymentID overpayments.LineItems.Tracking.TrackingCategoryID = invoices.LineItems.Tracking.TrackingCategoryID |
| linked_transactions | overpayments.Contact.ContactID = linked_transactions.ContactID overpayments.Allocations.Invoice.InvoiceID = linked_transactions.SourceTransactionID overpayments.Allocations.Invoice.InvoiceID = linked_transactions.TargetTransactionID |
| prepayments | overpayments.Contact.ContactID = prepayments.Contact.ContactID overpayments.Allocations.Invoice.InvoiceID = prepayments.Allocations.Invoice.InvoiceID overpayments.LineItems.Tracking.TrackingCategoryID = prepayments.LineItems.Tracking.TrackingCategoryID |
| receipts | overpayments.Contact.ContactID = receipts.Contact.ContactID overpayments.LineItems.Tracking.TrackingCategoryID = receipts.LineItems.Tracking.TrackingCategoryID |
| repeating_invoices | overpayments.Contact.ContactID = repeating_invoices.Contact.ContactID overpayments.LineItems.Tracking.TrackingCategoryID = repeating_invoices.LineItems.Tracking.TrackingCategoryID |
| payments | overpayments.Allocations.Invoice.InvoiceID = payments.Invoice.InvoiceID overpayments.OverpaymentID = payments.Overpayment.OverpaymentID overpayments.Payments.PaymentID = payments.PaymentID |
| bank_transactions | overpayments.OverpaymentID = bank_transactions.OverpaymentID |
| expense_claims | overpayments.Payments.PaymentID = expense_claims.Payments.PaymentID |
| journals | overpayments.LineItems.Tracking.TrackingCategoryID = journals.JournalLines.TrackingCategories.TrackingCategoryID |
| manual_journals | overpayments.LineItems.Tracking.TrackingCategoryID = manual_journals.JournalLines.Tracking.TrackingCategoryID |
| purchase_orders | overpayments.LineItems.Tracking.TrackingCategoryID = purchase_orders.LineItems.Tracking.TrackingCategoryID |
| tracking_categories | overpayments.LineItems.Tracking.TrackingCategoryID = tracking_categories.TrackingCategoryID |
Allocations ARRAY This is a nested data structure:
|
AppliedAmount NUMBER |
Contact OBJECT This is a nested data structure:
|
CurrencyCode STRING |
CurrencyRate NUMBER |
Date DATE-TIME |
DateString DATE-TIME |
HasAttachments BOOLEAN |
ID STRING |
LineAmountTypes STRING |
LineItems ARRAY This is a nested data structure:
|
OverpaymentID STRING |
Payments ARRAY This is a nested data structure:
|
Reference STRING |
RemainingCredit NUMBER |
Status STRING |
SubTotal NUMBER |
Total NUMBER |
TotalTax NUMBER |
Type STRING |
UpdatedDateUTC DATE-TIME |
payments
The payments table contains info about the payments recorded in your Xero account.
Replication Method | CDC |
Primary Key | PaymentID |
Replication Key | UpdatedDateUTC |
| Useful links |
| Join payments with | on |
|---|---|
| accounts | payments.Account.AccountID = accounts.AccountID |
| bank_transactions | payments.Account.AccountID = bank_transactions.BankAccount.AccountID payments.Overpayment.OverpaymentID = bank_transactions.OverpaymentID payments.Prepayments.PrepaymentID = bank_transactions.PrepaymentID |
| bank_transfers | payments.Account.AccountID = bank_transfers.FromBankAccount.AccountID payments.Account.AccountID = bank_transfers.ToBankAccount.AccountID |
| journals | payments.Account.AccountID = journals.JournalLines.AccountID |
| invoices | payments.Invoice.InvoiceID = invoices.InvoiceID payments.Overpayment.OverpaymentID = invoices.Overpayments.Overpayment.OverpaymentID payments.PaymentID = invoices.Payments.PaymentID payments.Prepayments.PrepaymentID = invoices.Prepayments.PrepaymentID |
| linked_transactions | payments.Invoice.InvoiceID = linked_transactions.SourceTransactionID payments.Invoice.InvoiceID = linked_transactions.TargetTransactionID |
| overpayments | payments.Invoice.InvoiceID = overpayments.Allocations.Invoice.InvoiceID payments.Overpayment.OverpaymentID = overpayments.OverpaymentID payments.PaymentID = overpayments.Payments.PaymentID |
| prepayments | payments.Invoice.InvoiceID = prepayments.Allocations.Invoice.InvoiceID payments.Prepayments.PrepaymentID = prepayments.PrepaymentID |
| expense_claims | payments.PaymentID = expense_claims.Payments.PaymentID |
Account OBJECT This is a nested data structure:
|
Amount NUMBER |
BankAmount NUMBER |
BatchPaymentID STRING |
CreditNote OBJECT This is a nested data structure:
|
CurrencyRate NUMBER |
Date DATE-TIME |
HasAccount BOOLEAN |
HasValidationErrors BOOLEAN |
Invoice OBJECT This is a nested data structure:
|
IsReconciled BOOLEAN |
Overpayment ARRAY This is a nested data structure:
|
PaymentID STRING |
PaymentType STRING |
Prepayments ARRAY This is a nested data structure:
|
Reference STRING |
Status STRING |
UpdatedDateUTC DATE-TIME |
prepayments
The prepayments table contains info about prepayments, which are payments made in advance of an invoice being raised for a customer or a bill being received from a supplier.
Replication Method | CDC |
Primary Key | PrepaymentID |
Replication Key | UpdatedDateUTC |
| Useful links |
| Join prepayments with | on |
|---|---|
| contacts | prepayments.Contact.ContactID = contacts.ContactID prepayments.LineItems.Tracking.TrackingCategoryID = contacts.SalesTrackingCategories.TrackingCategoryID prepayments.LineItems.Tracking.TrackingCategoryID = contacts.PurchasesTrackingCategories.TrackingCategoryID |
| credit_notes | prepayments.Contact.ContactID = credit_notes.Contact.ContactID prepayments.CurrencyCode = credit_notes.CurrencyCode prepayments.LineItems.Tracking.TrackingCategoryID = credit_notes.LineItems.Tracking.TrackingCategoryID |
| invoices | prepayments.Contact.ContactID = invoices.Contact.ContactID prepayments.CurrencyCode = invoices.CurrencyCode prepayments.Allocations.Invoice.InvoiceID = invoices.InvoiceID prepayments.PrepaymentID = invoices.Prepayments.PrepaymentID prepayments.LineItems.Tracking.TrackingCategoryID = invoices.LineItems.Tracking.TrackingCategoryID |
| linked_transactions | prepayments.Contact.ContactID = linked_transactions.ContactID prepayments.Allocations.Invoice.InvoiceID = linked_transactions.SourceTransactionID prepayments.Allocations.Invoice.InvoiceID = linked_transactions.TargetTransactionID |
| overpayments | prepayments.Contact.ContactID = overpayments.Contact.ContactID prepayments.Allocations.Invoice.InvoiceID = overpayments.Allocations.Invoice.InvoiceID prepayments.LineItems.Tracking.TrackingCategoryID = overpayments.LineItems.Tracking.TrackingCategoryID |
| receipts | prepayments.Contact.ContactID = receipts.Contact.ContactID prepayments.LineItems.Tracking.TrackingCategoryID = receipts.LineItems.Tracking.TrackingCategoryID |
| repeating_invoices | prepayments.Contact.ContactID = repeating_invoices.Contact.ContactID prepayments.CurrencyCode = repeating_invoices.CurrencyCode prepayments.LineItems.Tracking.TrackingCategoryID = repeating_invoices.LineItems.Tracking.TrackingCategoryID |
| accounts | prepayments.CurrencyCode = accounts.CurrencyCode |
| bank_transactions | prepayments.CurrencyCode = bank_transactions.CurrencyCode prepayments.PrepaymentID = bank_transactions.PrepaymentID |
| currencies | prepayments.CurrencyCode = currencies.Code |
| purchase_orders | prepayments.CurrencyCode = purchase_orders.CurrencyCode prepayments.LineItems.Tracking.TrackingCategoryID = purchase_orders.LineItems.Tracking.TrackingCategoryID |
| payments | prepayments.Allocations.Invoice.InvoiceID = payments.Invoice.InvoiceID prepayments.PrepaymentID = payments.Prepayments.PrepaymentID |
| journals | prepayments.LineItems.Tracking.TrackingCategoryID = journals.JournalLines.TrackingCategories.TrackingCategoryID |
| manual_journals | prepayments.LineItems.Tracking.TrackingCategoryID = manual_journals.JournalLines.Tracking.TrackingCategoryID |
| tracking_categories | prepayments.LineItems.Tracking.TrackingCategoryID = tracking_categories.TrackingCategoryID |
Allocations ARRAY This is a nested data structure:
|
AppliedAmount NUMBER |
Contact OBJECT
|
CurrencyCode STRING |
CurrencyRate NUMBER |
Date DATE-TIME |
DateString DATE-TIME |
HasAttachments BOOLEAN |
ID STRING |
LineAmountTypes STRING |
LineItems ARRAY This is a nested data structure:
|
Payments ARRAY This is a nested data structure:
|
PrepaymentID STRING |
Reference STRING |
RemainingCredit NUMBER |
Status STRING |
SubTotal NUMBER |
Total NUMBER |
TotalTax NUMBER |
Type STRING |
UpdatedDateUTC DATE-TIME |
purchase_orders
The purchase_orders table contains info about your purchase orders. Purchase orders are requests sent to suppliers for specific goods and services.
Replication Method | CDC |
Primary Key | PurchaseOrderID |
Replication Key | UpdatedDateUTC |
| Useful links |
| Join purchase_orders with | on |
|---|---|
| branding_themes | purchase_orders.BrandingThemeID = branding_themes.BrandingThemeID |
| contacts | purchase_orders.BrandingThemeID = contacts.BrandingTheme.BrandingThemeID purchase_orders.LineItems.Tracking.TrackingCategoryID = contacts.SalesTrackingCategories.TrackingCategoryID purchase_orders.LineItems.Tracking.TrackingCategoryID = contacts.PurchasesTrackingCategories.TrackingCategoryID |
| credit_notes | purchase_orders.BrandingThemeID = credit_notes.BrandingThemeID purchase_orders.CurrencyCode = credit_notes.CurrencyCode purchase_orders.LineItems.Tracking.TrackingCategoryID = credit_notes.LineItems.Tracking.TrackingCategoryID |
| invoices | purchase_orders.BrandingThemeID = invoices.BrandingThemeID purchase_orders.CurrencyCode = invoices.CurrencyCode purchase_orders.LineItems.Tracking.TrackingCategoryID = invoices.LineItems.Tracking.TrackingCategoryID |
| repeating_invoices | purchase_orders.BrandingThemeID = repeating_invoices.BrandingThemeID purchase_orders.CurrencyCode = repeating_invoices.CurrencyCode purchase_orders.LineItems.Tracking.TrackingCategoryID = repeating_invoices.LineItems.Tracking.TrackingCategoryID |
| accounts | purchase_orders.CurrencyCode = accounts.CurrencyCode |
| bank_transactions | purchase_orders.CurrencyCode = bank_transactions.CurrencyCode |
| currencies | purchase_orders.CurrencyCode = currencies.Code |
| prepayments | purchase_orders.CurrencyCode = prepayments.CurrencyCode purchase_orders.LineItems.Tracking.TrackingCategoryID = prepayments.LineItems.Tracking.TrackingCategoryID |
| journals | purchase_orders.LineItems.Tracking.TrackingCategoryID = journals.JournalLines.TrackingCategories.TrackingCategoryID |
| manual_journals | purchase_orders.LineItems.Tracking.TrackingCategoryID = manual_journals.JournalLines.Tracking.TrackingCategoryID |
| overpayments | purchase_orders.LineItems.Tracking.TrackingCategoryID = overpayments.LineItems.Tracking.TrackingCategoryID |
| receipts | purchase_orders.LineItems.Tracking.TrackingCategoryID = receipts.LineItems.Tracking.TrackingCategoryID |
| tracking_categories | purchase_orders.LineItems.Tracking.TrackingCategoryID = tracking_categories.TrackingCategoryID |
AttentionTo STRING |
BrandingThemeID STRING |
Contact OBJECT This is a nested data structure:
|
CurrencyCode STRING |
CurrencyRate NUMBER |
Date DATE-TIME |
DateString DATE-TIME |
DeliveryAddress STRING |
DeliveryDate DATE-TIME |
DeliveryDateString DATE-TIME |
DeliveryInstructions STRING |
ExpectedArrivalDate DATE-TIME |
ExpectedArrivalDateString DATE-TIME |
HasAttachments BOOLEAN |
HasErrors BOOLEAN |
IsDiscounted BOOLEAN |
LineAmountTypes STRING |
LineItems ARRAY This is a nested data structure:
|
PurchaseOrderID STRING |
PurchaseOrderNumber STRING |
Reference STRING |
SentToContact BOOLEAN |
Status STRING |
SubTotal NUMBER |
Telephone STRING |
Total NUMBER |
TotalDiscount NUMBER |
TotalTax NUMBER |
Type STRING |
UpdatedDateUTC DATE-TIME |
receipts
The receipts table contains info about invoice receipts, which are receipts sent to customers after an invoice has been received.
Replication Method | CDC |
Primary Key | ReceiptID |
Replication Key | UpdatedDateUTC |
| Useful links |
| Join receipts with | on |
|---|---|
| contacts | receipts.Contact.ContactID = contacts.ContactID receipts.LineItems.Tracking.TrackingCategoryID = contacts.SalesTrackingCategories.TrackingCategoryID receipts.LineItems.Tracking.TrackingCategoryID = contacts.PurchasesTrackingCategories.TrackingCategoryID |
| credit_notes | receipts.Contact.ContactID = credit_notes.Contact.ContactID receipts.LineItems.Tracking.TrackingCategoryID = credit_notes.LineItems.Tracking.TrackingCategoryID |
| invoices | receipts.Contact.ContactID = invoices.Contact.ContactID receipts.LineItems.Tracking.TrackingCategoryID = invoices.LineItems.Tracking.TrackingCategoryID |
| linked_transactions | receipts.Contact.ContactID = linked_transactions.ContactID |
| overpayments | receipts.Contact.ContactID = overpayments.Contact.ContactID receipts.LineItems.Tracking.TrackingCategoryID = overpayments.LineItems.Tracking.TrackingCategoryID |
| prepayments | receipts.Contact.ContactID = prepayments.Contact.ContactID receipts.LineItems.Tracking.TrackingCategoryID = prepayments.LineItems.Tracking.TrackingCategoryID |
| repeating_invoices | receipts.Contact.ContactID = repeating_invoices.Contact.ContactID receipts.LineItems.Tracking.TrackingCategoryID = repeating_invoices.LineItems.Tracking.TrackingCategoryID |
| expense_claims | receipts.ReceiptID = expense_claims.Receipts.ReceiptID receipts.User.UserID = expense_claims.User.UserID |
| journals | receipts.LineItems.Tracking.TrackingCategoryID = journals.JournalLines.TrackingCategories.TrackingCategoryID |
| manual_journals | receipts.LineItems.Tracking.TrackingCategoryID = manual_journals.JournalLines.Tracking.TrackingCategoryID |
| purchase_orders | receipts.LineItems.Tracking.TrackingCategoryID = purchase_orders.LineItems.Tracking.TrackingCategoryID |
| tracking_categories | receipts.LineItems.Tracking.TrackingCategoryID = tracking_categories.TrackingCategoryID |
Attachments ARRAY |
Contact OBJECT This is a nested data structure:
|
Date DATE-TIME |
HasAttachments BOOLEAN |
ID STRING |
LineAmountTypes STRING |
LineItems ARRAY This is a nested data structure:
|
ReceiptID STRING |
ReceiptNumber INTEGER |
Reference STRING |
Status STRING |
SubTotal NUMBER |
Total NUMBER |
TotalTax NUMBER |
UpdatedDateUTC DATE-TIME |
Url STRING |
User OBJECT This is a nested data structure:
|
ValidationErrors ARRAY This is a nested data structure:
|
repeating_invoices
The repeating_invoices table contains info about invoices set up to repeat in your Xero account. A repeating invoice is a recurring transaction, or a transaction that occurs on a regular basis.
Replication Method | Full Table |
Primary Key | RepeatingInvoiceID |
| Useful links |
| Join repeating_invoices with | on |
|---|---|
| branding_themes | repeating_invoices.BrandingThemeID = branding_themes.BrandingThemeID |
| contacts | repeating_invoices.BrandingThemeID = contacts.BrandingTheme.BrandingThemeID repeating_invoices.Contact.ContactID = contacts.ContactID repeating_invoices.LineItems.Tracking.TrackingCategoryID = contacts.SalesTrackingCategories.TrackingCategoryID repeating_invoices.LineItems.Tracking.TrackingCategoryID = contacts.PurchasesTrackingCategories.TrackingCategoryID |
| credit_notes | repeating_invoices.BrandingThemeID = credit_notes.BrandingThemeID repeating_invoices.Contact.ContactID = credit_notes.Contact.ContactID repeating_invoices.CurrencyCode = credit_notes.CurrencyCode repeating_invoices.LineItems.Tracking.TrackingCategoryID = credit_notes.LineItems.Tracking.TrackingCategoryID |
| invoices | repeating_invoices.BrandingThemeID = invoices.BrandingThemeID repeating_invoices.Contact.ContactID = invoices.Contact.ContactID repeating_invoices.CurrencyCode = invoices.CurrencyCode repeating_invoices.LineItems.Tracking.TrackingCategoryID = invoices.LineItems.Tracking.TrackingCategoryID |
| purchase_orders | repeating_invoices.BrandingThemeID = purchase_orders.BrandingThemeID repeating_invoices.CurrencyCode = purchase_orders.CurrencyCode repeating_invoices.LineItems.Tracking.TrackingCategoryID = purchase_orders.LineItems.Tracking.TrackingCategoryID |
| linked_transactions | repeating_invoices.Contact.ContactID = linked_transactions.ContactID |
| overpayments | repeating_invoices.Contact.ContactID = overpayments.Contact.ContactID repeating_invoices.LineItems.Tracking.TrackingCategoryID = overpayments.LineItems.Tracking.TrackingCategoryID |
| prepayments | repeating_invoices.Contact.ContactID = prepayments.Contact.ContactID repeating_invoices.CurrencyCode = prepayments.CurrencyCode repeating_invoices.LineItems.Tracking.TrackingCategoryID = prepayments.LineItems.Tracking.TrackingCategoryID |
| receipts | repeating_invoices.Contact.ContactID = receipts.Contact.ContactID repeating_invoices.LineItems.Tracking.TrackingCategoryID = receipts.LineItems.Tracking.TrackingCategoryID |
| accounts | repeating_invoices.CurrencyCode = accounts.CurrencyCode |
| bank_transactions | repeating_invoices.CurrencyCode = bank_transactions.CurrencyCode |
| currencies | repeating_invoices.CurrencyCode = currencies.Code |
| journals | repeating_invoices.LineItems.Tracking.TrackingCategoryID = journals.JournalLines.TrackingCategories.TrackingCategoryID |
| manual_journals | repeating_invoices.LineItems.Tracking.TrackingCategoryID = manual_journals.JournalLines.Tracking.TrackingCategoryID |
| tracking_categories | repeating_invoices.LineItems.Tracking.TrackingCategoryID = tracking_categories.TrackingCategoryID |
BrandingThemeID STRING |
Contact OBJECT This is a nested data structure:
|
CurrencyCode STRING |
HasAttachments BOOLEAN |
ID STRING |
LineAmountTypes STRING |
LineItems ARRAY This is a nested data structure:
|
Reference STRING |
RepeatingInvoiceID STRING |
Schedule OBJECT This is a nested data structure:
|
Status STRING |
SubTotal NUMBER |
Total NUMBER |
TotalDiscount NUMBER |
TotalTax NUMBER |
Type STRING |
tax_rates
The tax_rates table contains info about the tax rates set up in your Xero account.
Replication Method | Full Table |
Primary Key | Name |
| Useful links |
| Join tax_rates with | on |
|---|---|
| journals | tax_rates.Name = journals.JournalLines.TaxName |
CanApplyToAssets BOOLEAN |
CanApplyToEquity BOOLEAN |
CanApplyToExpenses BOOLEAN |
CanApplyToLiabilities BOOLEAN |
CanApplyToRevenue BOOLEAN |
DisplayTaxRate NUMBER |
EffectiveRate NUMBER |
Name STRING |
ReportTaxType STRING |
Status STRING |
TaxComponents ARRAY This is a nested data structure:
|
TaxType STRING |
tracking_categories
The tracking_categories table contains info about the tracking categories in your Xero account. Tracking categories are used to track the performance of different areas of a business.
Replication Method | Full Table |
Primary Key | TrackingCategoryID |
| Useful links |
| Join tracking_categories with | on |
|---|---|
| contacts | tracking_categories.TrackingCategoryID = contacts.SalesTrackingCategories.TrackingCategoryID tracking_categories.TrackingCategoryID = contacts.PurchasesTrackingCategories.TrackingCategoryID |
| credit_notes | tracking_categories.TrackingCategoryID = credit_notes.LineItems.Tracking.TrackingCategoryID |
| invoices | tracking_categories.TrackingCategoryID = invoices.LineItems.Tracking.TrackingCategoryID |
| journals | tracking_categories.TrackingCategoryID = journals.JournalLines.TrackingCategories.TrackingCategoryID |
| manual_journals | tracking_categories.TrackingCategoryID = manual_journals.JournalLines.Tracking.TrackingCategoryID |
| overpayments | tracking_categories.TrackingCategoryID = overpayments.LineItems.Tracking.TrackingCategoryID |
| prepayments | tracking_categories.TrackingCategoryID = prepayments.LineItems.Tracking.TrackingCategoryID |
| purchase_orders | tracking_categories.TrackingCategoryID = purchase_orders.LineItems.Tracking.TrackingCategoryID |
| receipts | tracking_categories.TrackingCategoryID = receipts.LineItems.Tracking.TrackingCategoryID |
| repeating_invoices | tracking_categories.TrackingCategoryID = repeating_invoices.LineItems.Tracking.TrackingCategoryID |
Name STRING |
Option STRING |
Options ARRAY This is a nested data structure:
|
Status STRING |
TrackingCategoryID STRING |
TrackingCategoryName STRING |
TrackingOptionID STRING |
TrackingOptionName STRING |
users
The users table contains info about the users in an organisation.
Replication Method | CDC |
Primary Key | UserID |
Replication Key | UpdatedDateUTC |
| Useful links |
EmailAddress STRING |
FirstName STRING |
IsSubscriber BOOLEAN |
LastName STRING |
OrganisationRole STRING |
UpdatedDateUTC DATE-TIME |
UserID STRING |
ValidationErrors ARRAY This is a nested data structure:
|