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

Stitch plan

Standard

API availability

Available

Singer GitHub repository

singer-io/tap-xero

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

Step 1: Add Xero as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Xero icon.

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

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

  5. 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:

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.

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

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:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.
  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. 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.

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

accounts

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

Replication Method

Key-based Incremental

Primary Key

AccountID

Replication Key

UpdatedDateUTC

Useful links

accounts schema on GitHub

Xero API method

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

Key-based Incremental

Primary Key

BankTransactionID

Replication Key

UpdatedDateUTC

Useful links

bank_transactions schema on GitHub

Xero API method

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

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

BankTransactionID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

ExternalLinkProviderName

STRING

HasAttachments

BOOLEAN

IsReconciled

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

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

Key-based Incremental

Primary Key

BankTransferID

Replication Key

CreatedDateUTC

Useful links

bank_transfers schema on GitHub

Xero API method

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

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

FromBankTransactionID

STRING

HasAttachments

BOOLEAN

ToBankAccount

OBJECT

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

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

branding_themes schema on GitHub

Xero API method

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

contact_groups schema on GitHub

Xero API method

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

Key-based Incremental

Primary Key

ContactID

Replication Key

UpdatedDateUTC

Useful links

contacts schema on GitHub

Xero API method

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

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

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.

Replication Method

Key-based Incremental

Primary Key

CreditNoteID

Replication Key

UpdatedDateUTC

Useful links

credit_notes schema on GitHub

Xero API method

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

Amount

NUMBER

Date

DATE-TIME

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

AppliedAmount

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

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

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

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

currencies schema on GitHub

Xero API method

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

Key-based Incremental

Primary Key

EmployeeID

Replication Key

UpdatedDateUTC

Useful links

employees schema on GitHub

Xero API method

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

Key-based Incremental

Primary Key

ExpenseClaimID

Replication Key

UpdatedDateUTC

Useful links

expense_claims schema on GitHub

Xero API method

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

Account

OBJECT

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

Amount

NUMBER

BankAmount

NUMBER

BatchPaymentID

STRING

CreditNote

OBJECT

CreditNoteNumber

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

HasAccount

BOOLEAN

HasValidationErrors

BOOLEAN

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

IsReconciled

BOOLEAN

Overpayment

ARRAY

OverpaymentID

STRING

PaymentID

STRING

PaymentType

STRING

Prepayments

ARRAY

PrepaymentID

STRING

Reference

STRING

Status

STRING

UpdatedDateUTC

DATE-TIME

Receipts

ARRAY

Attachments

ARRAY

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

Date

DATE-TIME

HasAttachments

BOOLEAN

ID

STRING

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

ReceiptID

STRING

ReceiptNumber

INTEGER

Reference

STRING

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalTax

NUMBER

UpdatedDateUTC

DATE-TIME

Url

STRING

User

OBJECT

EmailAddress

STRING

FirstName

STRING

IsSubscriber

BOOLEAN

LastName

STRING

OrganisationRole

STRING

UpdatedDateUTC

DATE-TIME

UserID

STRING

ValidationErrors

ARRAY

ValidationErrors

ARRAY

ReportingDate

DATE-TIME

Status

STRING

Total

NUMBER

UpdatedDateUTC

DATE-TIME

User

OBJECT

EmailAddress

STRING

FirstName

STRING

IsSubscriber

BOOLEAN

LastName

STRING

OrganisationRole

STRING

UpdatedDateUTC

DATE-TIME

UserID

STRING

ValidationErrors

ARRAY

invoices

The invoices table contains info about sales invoices, which are requests for payment for goods and services.

Replication Method

Key-based Incremental

Primary Key

InvoiceID

Replication Key

UpdatedDateUTC

Useful links

invoices schema on GitHub

Xero API method

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

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CreditNotes

ARRAY

Allocations

ARRAY

Amount

NUMBER

Date

DATE-TIME

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

AppliedAmount

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

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

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

Reference

STRING

RemainingCredit

NUMBER

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

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

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

Overpayments

ARRAY

Account

OBJECT

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

Amount

NUMBER

BankAmount

NUMBER

BatchPaymentID

STRING

CreditNote

OBJECT

CreditNoteNumber

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

HasAccount

BOOLEAN

HasValidationErrors

BOOLEAN

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

IsReconciled

BOOLEAN

Overpayment

ARRAY

OverpaymentID

STRING

PaymentID

STRING

PaymentType

STRING

Prepayments

ARRAY

PrepaymentID

STRING

Reference

STRING

Status

STRING

UpdatedDateUTC

DATE-TIME

Payments

ARRAY

Account

OBJECT

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

Amount

NUMBER

BankAmount

NUMBER

BatchPaymentID

STRING

CreditNote

OBJECT

CreditNoteNumber

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

HasAccount

BOOLEAN

HasValidationErrors

BOOLEAN

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

IsReconciled

BOOLEAN

Overpayment

ARRAY

OverpaymentID

STRING

PaymentID

STRING

PaymentType

STRING

Prepayments

ARRAY

PrepaymentID

STRING

Reference

STRING

Status

STRING

UpdatedDateUTC

DATE-TIME

PlannedPaymentDate

DATE-TIME

PlannedPaymentDateString

DATE-TIME

Prepayments

ARRAY

Allocations

ARRAY

Amount

NUMBER

Date

DATE-TIME

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

AppliedAmount

NUMBER

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

HasAttachments

BOOLEAN

ID

STRING

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

Payments

ARRAY

Account

OBJECT

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

Amount

NUMBER

BankAmount

NUMBER

BatchPaymentID

STRING

CreditNote

OBJECT

CreditNoteNumber

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

HasAccount

BOOLEAN

HasValidationErrors

BOOLEAN

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

IsReconciled

BOOLEAN

Overpayment

ARRAY

OverpaymentID

STRING

PaymentID

STRING

PaymentType

STRING

Prepayments

ARRAY

PrepaymentID

STRING

Reference

STRING

Status

STRING

UpdatedDateUTC

DATE-TIME

PrepaymentID

STRING

Reference

STRING

RemainingCredit

NUMBER

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

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

Key-based Incremental

Primary Key

ItemID

Replication Key

UpdatedDateUTC

Useful links

items schema on GitHub

Xero API method

Code

STRING

Description

STRING

InventoryAssetAccountCode

STRING

IsPurchased

BOOLEAN

IsSold

BOOLEAN

IsTrackedAsInventory

BOOLEAN

ItemID

STRING

Name

STRING

PurchaseDescription

STRING

PurchaseDetails

OBJECT

AccountCode

STRING

COGSAccountCode

STRING

TaxType

STRING

UnitPrice

NUMBER

QuantityOnHand

NUMBER

SalesDetails

OBJECT

AccountCode

STRING

TaxType

STRING

UnitPrice

NUMBER

TotalCostPool

NUMBER

UpdatedDateUTC

DATE-TIME

journals

The journals table contains info about journal entries.

Replication Method

Key-based Incremental

Primary Key

JournalID

Replication Key

JournalNumber

Useful links

journals schema on GitHub

Xero API method

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

AccountCode

STRING

AccountID

STRING

AccountName

STRING

AccountType

STRING

Description

STRING

GrossAmount

NUMBER

JournalLineID

STRING

NetAmount

NUMBER

TaxAmount

NUMBER

TaxName

STRING

TaxType

STRING

TrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

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

Key-based Incremental

Primary Key

LinkedTransactionID

Replication Key

UpdatedDateUTC

Useful links

linked_transactions schema on GitHub

Xero API method

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

Key-based Incremental

Primary Key

ManualJournalID

Replication Key

UpdatedDateUTC

Useful links

manual_journals schema on GitHub

Xero API method

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

AccountCode

STRING

AccountID

STRING

Description

STRING

IsBlank

BOOLEAN

LineAmount

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

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

organisations schema on GitHub

Xero API method

APIKey

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

BaseCurrency

STRING

CountryCode

STRING

CreatedDateUTC

DATE-TIME

DefaultPurchasesTax

STRING

DefaultSalesTax

STRING

EndOfYearLockDate

DATE-TIME

ExternalLinks

ARRAY

FinancialYearEndDay

INTEGER

FinancialYearEndMonth

INTEGER

IsDemoCompany

BOOLEAN

LegalName

STRING

LineOfBusiness

STRING

Name

STRING

OrganisationEntityType

STRING

OrganisationID

STRING

OrganisationStatus

STRING

OrganisationType

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

PaysTax

BOOLEAN

PeriodLockDate

DATE-TIME

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

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

Key-based Incremental

Primary Key

OverpaymentID

Replication Key

UpdatedDateUTC

Useful links

overpayments schema on GitHub

Xero API method

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

Amount

NUMBER

Date

DATE-TIME

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

AppliedAmount

NUMBER

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

HasAttachments

BOOLEAN

ID

STRING

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

OverpaymentID

STRING

Payments

ARRAY

Account

OBJECT

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

Amount

NUMBER

BankAmount

NUMBER

BatchPaymentID

STRING

CreditNote

OBJECT

CreditNoteNumber

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

HasAccount

BOOLEAN

HasValidationErrors

BOOLEAN

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

IsReconciled

BOOLEAN

Overpayment

ARRAY

OverpaymentID

STRING

PaymentID

STRING

PaymentType

STRING

Prepayments

ARRAY

PrepaymentID

STRING

Reference

STRING

Status

STRING

UpdatedDateUTC

DATE-TIME

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

Key-based Incremental

Primary Key

PaymentID

Replication Key

UpdatedDateUTC

Useful links

payments schema on GitHub

Xero API method

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

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

Amount

NUMBER

BankAmount

NUMBER

BatchPaymentID

STRING

CreditNote

OBJECT

CreditNoteNumber

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

HasAccount

BOOLEAN

HasValidationErrors

BOOLEAN

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

IsReconciled

BOOLEAN

Overpayment

ARRAY

OverpaymentID

STRING

PaymentID

STRING

PaymentType

STRING

Prepayments

ARRAY

PrepaymentID

STRING

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

Key-based Incremental

Primary Key

PrepaymentID

Replication Key

UpdatedDateUTC

Useful links

prepayments schema on GitHub

Xero API method

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

Amount

NUMBER

Date

DATE-TIME

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

AppliedAmount

NUMBER

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

HasAttachments

BOOLEAN

ID

STRING

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

Payments

ARRAY

Account

OBJECT

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

Amount

NUMBER

BankAmount

NUMBER

BatchPaymentID

STRING

CreditNote

OBJECT

CreditNoteNumber

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

HasAccount

BOOLEAN

HasValidationErrors

BOOLEAN

Invoice

OBJECT

AmountCredited

NUMBER

AmountDue

NUMBER

AmountPaid

NUMBER

BrandingThemeID

STRING

Contact

OBJECT

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

CurrencyRate

NUMBER

Date

DATE-TIME

DateString

DATE-TIME

DueDate

DATE-TIME

DueDateString

DATE-TIME

ExpectedPaymentDate

DATE-TIME

FullyPaidOnDate

DATE-TIME

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

InvoiceID

STRING

InvoiceNumber

STRING

IsDiscounted

BOOLEAN

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

PlannedPaymentDate

DATE-TIME

Reference

STRING

SentToContact

BOOLEAN

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalDiscount

NUMBER

TotalTax

NUMBER

Type

STRING

UpdatedDateUTC

DATE-TIME

Url

STRING

IsReconciled

BOOLEAN

Overpayment

ARRAY

OverpaymentID

STRING

PaymentID

STRING

PaymentType

STRING

Prepayments

ARRAY

PrepaymentID

STRING

Reference

STRING

Status

STRING

UpdatedDateUTC

DATE-TIME

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

Key-based Incremental

Primary Key

PurchaseOrderID

Replication Key

UpdatedDateUTC

Useful links

purchase_orders schema on GitHub

Xero API method

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

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

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

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

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

Key-based Incremental

Primary Key

ReceiptID

Replication Key

UpdatedDateUTC

Useful links

receipts schema on GitHub

Xero API method

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

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

Date

DATE-TIME

HasAttachments

BOOLEAN

ID

STRING

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

ReceiptID

STRING

ReceiptNumber

INTEGER

Reference

STRING

Status

STRING

SubTotal

NUMBER

Total

NUMBER

TotalTax

NUMBER

UpdatedDateUTC

DATE-TIME

Url

STRING

User

OBJECT

EmailAddress

STRING

FirstName

STRING

IsSubscriber

BOOLEAN

LastName

STRING

OrganisationRole

STRING

UpdatedDateUTC

DATE-TIME

UserID

STRING

ValidationErrors

ARRAY

ValidationErrors

ARRAY

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

repeating_invoices schema on GitHub

Xero API method

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

AccountNumber

STRING

AccountsPayableTaxType

STRING

AccountsReceivableTaxType

STRING

Addresses

ARRAY

AddressLine1

STRING

AddressLine2

STRING

AddressLine3

STRING

AddressLine4

STRING

AddressType

STRING

AttentionTo

STRING

City

STRING

Country

STRING

PostalCode

STRING

Region

STRING

Attachments

ARRAY

Balances

OBJECT

AccountsPayable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

AccountsReceivable

OBJECT

Outstanding

NUMBER

Overdue

NUMBER

BankAccountDetails

STRING

BatchPayments

OBJECT

BankAccountName

STRING

BankAccountNumber

STRING

Code

STRING

Details

STRING

Reference

STRING

BrandingTheme

OBJECT

BrandingThemeID

STRING

CreatedDateUTC

DATE-TIME

Name

STRING

SortOrder

INTEGER

ContactGroups

ARRAY

ContactGroupID

STRING

HasValidationErrors

BOOLEAN

Name

STRING

Status

STRING

ContactID

STRING

ContactNumber

STRING

ContactPersons

ARRAY

EmailAddress

STRING

FirstName

STRING

IncludeInEmails

BOOLEAN

LastName

STRING

ContactStatus

STRING

DefaultCurrency

STRING

Discount

NUMBER

EmailAddress

STRING

FirstName

STRING

HasAttachments

BOOLEAN

HasValidationErrors

BOOLEAN

IsCustomer

BOOLEAN

IsSupplier

BOOLEAN

LastName

STRING

Name

STRING

PaymentTerms

OBJECT

Bills

OBJECT

Day

INTEGER

Type

STRING

Sales

OBJECT

Day

INTEGER

Type

STRING

Phones

ARRAY

PhoneAreaCode

STRING

PhoneCountryCode

STRING

PhoneNumber

STRING

PhoneType

STRING

PurchasesDefaultAccountCode

STRING

PurchasesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SalesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

SkypeUserName

STRING

TaxNumber

STRING

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

UpdatedDateUTC

DATE-TIME

ValidationErrors

ARRAY

Website

STRING

XeroNetworkKey

STRING

CurrencyCode

STRING

HasAttachments

BOOLEAN

ID

STRING

LineAmountTypes

STRING

LineItems

ARRAY

AccountCode

STRING

Description

STRING

DiscountRate

NUMBER

ItemCode

STRING

LineAmount

NUMBER

LineItemID

STRING

Quantity

NUMBER

TaxAmount

NUMBER

TaxType

STRING

Tracking

ARRAY

Name

STRING

Option

STRING

Options

ARRAY

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

UnitAmount

NUMBER

Reference

STRING

RepeatingInvoiceID

STRING

Schedule

OBJECT

DueDate

INTEGER

DueDateType

STRING

EndDate

STRING

NextScheduledDate

DATE-TIME

Period

INTEGER

StartDate

DATE-TIME

Unit

STRING

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

tax_rates schema on GitHub

Xero API method

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

IsCompound

BOOLEAN

IsNonRecoverable

BOOLEAN

Name

STRING

Rate

NUMBER

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

tracking_categories schema on GitHub

Xero API method

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

HasValidationErrors

BOOLEAN

IsActive

BOOLEAN

IsArchived

BOOLEAN

IsDeleted

BOOLEAN

Name

STRING

Status

STRING

TrackingOptionID

STRING

Status

STRING

TrackingCategoryID

STRING

TrackingCategoryName

STRING

TrackingOptionID

STRING

TrackingOptionName

STRING

users

The users table contains info about the users in an organisation.

Replication Method

Key-based Incremental

Primary Key

UserID

Replication Key

UpdatedDateUTC

Useful links

users schema on GitHub

Xero API method

EmailAddress

STRING

FirstName

STRING

IsSubscriber

BOOLEAN

LastName

STRING

OrganisationRole

STRING

UpdatedDateUTC

DATE-TIME

UserID

STRING

ValidationErrors

ARRAY


Questions? Feedback?

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