This integration is powered by Singer's Xero tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
Xero integration summary
Stitch’s Xero integration replicates data using the Xero Accounting API. Refer to the Schema section for a list of objects available for replication.
Xero feature snapshot
A high-level look at Stitch's Xero (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on August 22, 2018 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Xero
Step 1: Add Xero as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Xero icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Xero” would create a schema called
stitch_xero
in the destination. Note: Schema names cannot be changed after you save the integration. - Optional: Check Include archived contacts to have Stitch replicate records for archived contacts. If left unchecked, only records for active contacts will be replicated.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Xero integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond Xero’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Xero integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Authorize Stitch to access Xero
Next, you’ll be directed to Xero’s website to complete the setup.
- Enter your Xero credentials and click Login.
- A screen asking for authorization to Xero will display. Note that Stitch will only ever read your data.
- From the dropdown menu, select the company you want to connect to Stitch.
- Click Authorise.
- After the authorization process successfully completes, you’ll be redirected back to Stitch.
- Click All Done.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Xero integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Xero, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Xero table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Xero integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
accounts
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
AccountId |
API endpoint : |
The accounts
table contains info about the various accounts (ex: banking) connected to your Xero account.
AccountId
The account ID. Reference: |
UpdatedDateUTC
The date the account was last modified, in UTC. |
Code
The alpha-numeric account code. |
Name
The name of the account. |
Type
The account type. Refer to Xero’s documentation for a list of possible account types. |
ReportingCodeName
The name of the account’s reporting code, if set. |
SystemAccount
If a system account, this field will contain the type of system account. Refer to Xero’s documentation for a list of possible system account types. |
BankAccountType
For bank accounts only. Possible values are:
|
TaxType
The account’s tax type. Refer to Xero’s documentation for a list of possible tax types. |
Description
Not applicable to bank accounts. The description of the account. |
Class
The account’s class. Possible values are:
|
BankAccountNumber
For bank accounts only. If the account is a bank account ( |
Status
The status of the account. Possible values are:
|
ShowInExpenseClaims
If |
CurrencyCode
For bank accounts only. The currency code the account uses. Reference: |
ReportingCode
The reporting code for the account, if set. |
EnablePaymentsToAccount
If |
HasAttachments
If |
bank_transactions
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
BankTransactionId |
API endpoint : |
The bank_transactions
table contains info about the bank transactions in your Xero account.
BankTransactionId
The bank transaction ID. Reference: |
||||||||||||
UpdatedDateUTC
The date the bank transaction was last modified, in UTC. |
||||||||||||
Type
The bank transaction type. Refer to Xero’s documentation for possible transaction types. |
||||||||||||
Contact
|
||||||||||||
LineItems
Details about the line items in the bank transaction.
|
||||||||||||
BankAccount
Details about the bank account used in the bank transaction.
|
||||||||||||
IsReconciled
If |
||||||||||||
Date
The date of the transaction. |
||||||||||||
DateString
The date of the transaction. |
||||||||||||
Reference
The reference for the transaction. Only applicable to |
||||||||||||
CurrencyCode
The currency that the bank transaction has been raised in. Reference: |
||||||||||||
CurrencyRate
The exchange rate to base currency when money is spent or received. Only used for bank transactions in non-base currency. |
||||||||||||
Url
The URL link to a source document. |
||||||||||||
Status
The status of the bank transaction. Possible values are:
|
||||||||||||
LineAmountTypes
The type of amounts that the line items in the transaction contain. Possible values are:
|
||||||||||||
SubTotal
The total of the bank transaction, excluding taxes. |
||||||||||||
TotalTax
The total tax of the bank transaction. |
||||||||||||
Total
The total of the bank transaction, tax inclusive. |
||||||||||||
PrepaymentID
The prepayment ID associated with the transaction. Applicable to bank transactions with Reference: |
||||||||||||
OverpaymentID
The overpayment ID associated with the transaction. Applicable to bank transactions with Reference: |
||||||||||||
HasAttachments
If |
bank_transfers
Replication Method : |
Key-based Incremental |
Replication Key |
CreatedDateUTC |
Primary Key |
BankTransferID |
API endpoint : |
The bank_transfers
table contains info about bank transfers.
BankTransferID
The bank transfer ID. |
|
CreatedDateUTC
The date the bank transfer was created, in UTC. |
|
FromBankAccount
Details about the source bank account.
|
|
ToBankAccount
Details about the destination bank account.
|
|
Amount
The amount that was transferred. |
|
Date
The date of the transfer. |
|
DateString
The date of the transfer. |
|
CurrencyRate
The currency rate of the transfer. |
|
FromBankTransactionID
The bank transaction ID for the source account. Reference: |
|
ToBankTransactionID
The bank transaction ID for the destination account. Reference: |
|
HasAttachments
If |
|
CreatedDateUTCString
The date the bank transfer was created. |
branding_themes
Replication Method : |
Full Table |
Primary Key |
BrandingThemeID |
API endpoint : |
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.
BrandingThemeID
The branding theme ID. Reference: |
Name
The name of the branding theme. |
CreatedDateUTC
The date the branding theme was created, in UTC. |
SortOrder
The ranked order of the branding theme. The default branding theme has a value of |
contacts
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
ContactID |
API endpoint : |
The contacts
table contains info about the customers and suppliers you do business with.
ContactID
The contact ID. Reference: |
||||||||||||
UpdatedDateUTC
The date the contact was last updated, in UTC. |
||||||||||||
ContactNumber
An identifier for the contact used in an external system. In Xero, this is the Contact Code field in the Contacts UI. |
||||||||||||
AccountNumber
The account number associated with the contact. |
||||||||||||
ContactStatus
The current status of the contact. Possible values are:
|
||||||||||||
Name
The full name of the contact/organisation. |
||||||||||||
FirstName
The first name of the contact. |
||||||||||||
LastName
The last name of the contact. |
||||||||||||
EmailAddress
The email address of the contact. |
||||||||||||
SkypeUserName
The Skype username of the contact. |
||||||||||||
BankAccountDetails
The bank account number of the contact. |
||||||||||||
TaxNumber
The tax number of the contact. Depending on the version of Xero you’re using, this could be one of the following in the Xero UI:
|
||||||||||||
AccountsReceivableTaxType
The default tax type used on AR invoices for the contact. |
||||||||||||
AccountsPayableTaxType
The default tax type used on AP invoices for the contact. |
||||||||||||
Addresses
Details about the contact’s addresses.
|
||||||||||||
Phones
Details about the contact’s phone numbers.
|
||||||||||||
IsSupplier
If |
||||||||||||
IsCustomer
If |
||||||||||||
DefaultCurrency
The default currency for raising invoices against the contact. |
||||||||||||
ContactPersons
Details about the contact persons associated with the contact.
|
||||||||||||
SalesDefaultAccountCode
The default sales account code for the contact. |
||||||||||||
PurchasesDefaultAccountCode
The default purchases account code for the contact. |
||||||||||||
SalesTrackingCategories
Details about the default sales tracking categories for the contact. |
||||||||||||
PurchasesTrackingCategories
Details about the default purchases tracking categories for the contact.
|
||||||||||||
TrackingCategoryName
The name of the Tracking Category assigned to the contact. |
||||||||||||
TrackingCategoryOption
The name of the Tracking Option assigned to the contact. |
||||||||||||
PaymentTerms
Details about the contact’s payment terms.
|
||||||||||||
ContactGroups
Details about the contact groups the contact is included in.
|
||||||||||||
Website
The website address of the contact. |
||||||||||||
BrandingTheme
Details about the branding theme applied to documents sent to the contact.
|
||||||||||||
BatchPayments
Details about the batch payment details for the contact.
|
||||||||||||
Discount
The default discount rate for the contact. |
||||||||||||
Balances
Details about the raw AR (sales invoices) and AP (bills) outstanding and overdue amounts associated with the contact.
|
||||||||||||
HasAttachments
If |
||||||||||||
HasValidationErrors
Details about any validation errors associated with the contact.
|
contact_groups
Replication Method : |
Full Table |
Primary Key |
ContactGroupID |
API endpoint : |
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.
ContactGroupID
The contact group ID. Reference: |
Name
The name of the contact group. |
Status
The status of the contact group. This will always be |
HasValidationErrors
If |
credit_notes
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
CreditNoteID |
API endpoint : |
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.
CreditNoteID
The credit note ID. Reference: |
||||||||||||
UpdatedDateUTC
The date the credit note was last updated, in UTC. |
||||||||||||
Type
The credit note type. Possible values are:
|
||||||||||||
Contact
Details about the contact associated with the credit note.
|
||||||||||||
Date
The date the credit note was issued. |
||||||||||||
DueDate
The due date associated with the credit note. |
||||||||||||
DueDateString
The due date associated with the credit note. |
||||||||||||
Status
The status of the credit note. Possible values are:
|
||||||||||||
LineAmountTypes
The type of amounts that the line items in the credit note contain. Possible values are:
|
||||||||||||
LineItems
Details about the line items contained in the credit note.
|
||||||||||||
SubTotal
The subtotal of the credit note, excluding taxes. |
||||||||||||
AppliedAmount
|
||||||||||||
TotalTax
The total tax on the credit note. |
||||||||||||
Total
The total of the credit note, calculated as |
||||||||||||
CurrencyCode
The currency code used for the credit note. Reference: |
||||||||||||
FullyPaidOnDate
The date that the credit note was fully paid, in UTC. |
||||||||||||
CreditNoteNumber
An identifier for the credit note. The value this field contains varies depending on the credit note
|
||||||||||||
Reference
Applicable only to |
||||||||||||
SentToContact
If |
||||||||||||
CurrencyRate
The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. |
||||||||||||
RemainingCredit
The remaining credit balance on the credit note. |
||||||||||||
Allocations
Details about allocations associated with the credit note.
|
||||||||||||
BrandingThemeID
The ID of the branding theme applied to the credit note. Reference: |
||||||||||||
HasAttachments
If |
||||||||||||
DateString
The date the credit note was issued. |
currencies
Replication Method : |
Full Table |
Primary Key |
Code |
API endpoint : |
The currencies
table contains info about the currencies available in your Xero account.
Code
The three letter alpha code for the currency. Refer to XE.com for a list of codes. Reference: |
Description
The name of the currency. |
employees
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
EmployeeID |
API endpoint : |
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.
EmployeeID
The employee ID. |
UpdatedDateUTC
The date the employee was last updated, in UTC. |
Status
The current status of the employee. Possible values are:
|
FirstName
The first name of the employee. |
LastName
The last name of the employee. |
ExternalLink
A link to an external resource for the employee. For example: An employee record in an external system. |
expense_claims
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
ExpenseClaimID |
API endpoint : |
The expense_claims
table contains info about expense claims.
ExpenseClaimID
The expense claim ID. |
|
UpdatedDateUTC
The date when the expense claim was last updated, in UTC. |
|
User
Details about the user(s) who submitted the expense claim.
|
|
Receipts
Details about the receipt(s) associated with the expense claim.
|
|
Payments
Details about the payment(s) associated with the expense claim.
|
|
Status
The current status of the expense claim. Possible values are:
|
|
Total
The total of the expense claim being paid. |
|
AmountDue
The amount due to be paid for the expense claim. |
|
AmountPaid
The amount still to pay for an expense claim. |
|
PaymentDueDate
The date when the expense claim is due to be paid. |
|
ReportingDate
The date when the expense claim will be reported in Xero. |
invoices
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
InvoiceID |
API endpoint : |
The invoices
table contains info about sales invoices, which are requests for payment for goods and services.
InvoiceID
The invoice ID. Reference: |
||||||||||||
UpdatedDateUTC
The date the invoice was last updated, in UTC. |
||||||||||||
Type
The type of the invoice. Possible values are:
|
||||||||||||
Contact
Details about the contact(s) associated with the invoice.
|
||||||||||||
Date
The date the invoice was issued. |
||||||||||||
DueDate
The date the invoice is due. |
||||||||||||
Status
The status of the invoice. Possible values are:
|
||||||||||||
LineAmountTypes
The type of amounts that the line items in the invoice contain. Possible values are:
|
||||||||||||
LineItems
Details about the line items contained in the invoice.
|
||||||||||||
SubTotal
The total of the invoice, excluding taxes. |
||||||||||||
TotalTax
The total tax on the invoice. |
||||||||||||
Total
The total of the invoice, calculated as |
||||||||||||
TotalDiscount
The total of discounts applied to invoice line items. |
||||||||||||
CurrencyCode
The currency that the invoice has been raised in. Reference: |
||||||||||||
CurrencyRate
The currency rate, if the invoice is a multicurrency invoice. |
||||||||||||
InvoiceNumber
An identifier for the invoice. The value this field contains varies depending on the invoice
|
||||||||||||
Reference
Applicable only to |
||||||||||||
BrandingThemeID
The ID of the branding theme applied to the invoice. Reference: |
||||||||||||
Url
The URL link to a source document. |
||||||||||||
SentToContact
IF |
||||||||||||
ExpectedPaymentDate
For sales invoices ( |
||||||||||||
ExpectedPaymentDateString
For sales invoices, the expected payment date. |
||||||||||||
PlannedPaymentDate
For bills ( |
||||||||||||
PlannedPaymentDateString
For bills, the planned payment date. |
||||||||||||
HasAttachments
If |
||||||||||||
Payments
Details about the payments associated with the invoice.
|
||||||||||||
CreditNotes
Details about the credit notes associated with the invoice.
|
||||||||||||
Prepayments
Details about the prepayments associated with the invoice.
|
||||||||||||
Overpayments
Details about the overpayments associated with the invoice.
|
||||||||||||
AmountDue
The amount remaining to be paid on the invoice. |
||||||||||||
AmountPaid
The sum of payments received for the invoice. |
||||||||||||
FullyPaidOnDate
The date the invoice was fully paid. |
||||||||||||
AmountCredited
The sum of all credit notes, overpayments, and prepayments applied to the invoice. |
||||||||||||
DueDateString
The date the invoice is due. |
||||||||||||
DateString
The date the invoice was issued. |
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
ItemID |
API endpoint : |
The items
table contains info about the products and services you buy and sell.
ItemID
The item ID. |
||||
UpdatedDateUTC
The date the item was last updated. |
||||
Code
The user-defined code for the item. |
||||
IsSold
If |
||||
IsPurchased
If |
||||
Description
The sales description of the item. |
||||
PurchaseDescription
The purchase description of the item. |
||||
PurchaseDetails
The item’s purchase details.
|
||||
SalesDetails
The item’s sales details.
|
||||
IsTrackedAsInventory
If Note: This field will only be |
||||
InventoryAssetAccountCode
The inventory asset account for the item, if applicable. |
||||
TotalCostPool
The value of the item on hand, calculated using average cost accounting. |
||||
QuantityOnHand
The quantity of the item on hand. |
journals
Replication Method : |
Key-based Incremental |
Replication Key |
JournalNumber |
Primary Key |
JournalID |
API endpoint : |
The journals
table contains info about journal entries.
JournalID
The journal ID. |
||||||||||||
JournalNumber
A Xero-generated journal number. |
||||||||||||
JournalDate
The date the journal was posted. |
||||||||||||
CreatedDateUTC
The date the journal was created, in UTC. |
||||||||||||
Reference
The reference for the journal. |
||||||||||||
SourceID
The identifier for the source transaction. Use the For example: If |
||||||||||||
SourceType
The type of transaction that created the journal. Refer to Xero’s documentation for a list of possible values. |
||||||||||||
JournalLines
Details about the journal lines in the journal.
|
linked_transactions
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
LinkedTransactionID |
API endpoint : |
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.
LinkedTransactionID
The linked transaction ID. |
UpdatedDateUTC
The date the linked transaction was last updated, in UTC. |
Status
The status of the linked transaction, which is derived from the statuses of the source and target transactions. Possible values are:
|
Type
The type of the linked transaction. This value will always be |
SourceTransactionID
The ID of the source transaction, or the purchase component of a billable expense. The value this field contains varies depending on the value of
Reference: |
SourceLineItemID
The ID of the associated line item from the source transaction. |
SourceTransactionTypeCode
The type of the source transaction. Possible values are:
|
ContactID
The ID of the contact on the target transaction, i.e. the customer that the expense is being billed to. Reference: |
TargetTransactionID
The ID of the target transaction, or the sale component of a billable expense. Note: Only invoices with Reference: |
TargetLineItemID
The ID of the line item on the target transaction. |
manual_journals
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
ManualJournalID |
API endpoint : |
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.
ManualJournalID
The manual journal ID. |
|||||||
UpdatedDateUTC
The date the manual journal was last updated, in UTC. |
|||||||
Date
The date the journal was posted. |
|||||||
LineAmountTypes
The type of amounts that the line items in the manual journal contain. Possible values are:
|
|||||||
Status
The status of the manual journal. Possible values are:
|
|||||||
Narration
A description of the journal being posted. |
|||||||
JournalLines
Details about the journal lines in the manual journal.
|
|||||||
Url
A URL link to a source document. |
|||||||
ShowOnCashBasisReports
If |
|||||||
HasAttachments
If |
organisations
Replication Method : |
Full Table |
Primary Key |
OrganisationID |
API endpoint : |
The organisations
table contains info about the organisations in your Xero account.
OrganisationID
The organisation ID. |
||||||||||
APIKey
The organisation’s unique key for Xero-to-Xero transactions. |
||||||||||
Name
The display name of the organisation in Xero. |
||||||||||
LegalName
The legal name of the organisation, as shown in reports. |
||||||||||
PaysTax
If |
||||||||||
Version
The version of the organisation. Refer to Xero’s documentation for possible versions. |
||||||||||
OrganisationType
The type of the organisation. Possible values are:
|
||||||||||
BaseCurrency
The default currency (ISO 4217) of the organisation. Refer to XE.com for a list currency codes. |
||||||||||
CountryCode
The country code (ISO 3166-2 of the organisation. Refer to XE.com for a list currency codes. |
||||||||||
IsDemoCompany
If |
||||||||||
OrganisationStatus
This value will be |
||||||||||
RegistrationNumber
Only applicable to New Zealand, Australian, and UK organisations. The registration number of the organisation. |
||||||||||
TaxNumber
The organisation’s tax number. Depending on the version of Xero you’re using, this could be one of the following in the Xero UI:
|
||||||||||
FinancialYearEndDay
The calendar day that the organisation’s financial year end occurs. Possible values are |
||||||||||
FinancialYearEndMonth
The calendar month that the organisation’s financial year end occurs. Possible values are |
||||||||||
SalesTaxBasis
The accounting basis used for tax returns. Refer to Xero’s documentation for a list of possible values. |
||||||||||
SalesTaxPeriod
The frequency with which tax returns are processed. Refer to Xero’s documentation for a list of possible values. |
||||||||||
DefaultSalesTax
The default tax used for line amounts on sales transactions. |
||||||||||
DefaultPurchaseTax
The default tax used for line amounts on purchase transactions. |
||||||||||
PeriodLockDate
The period lock date for the organisation, if set. |
||||||||||
EndOfYearLockDate
The year end lock date for the organisation, if set. |
||||||||||
CreatedDateUTC
The date the organisation was created, in UTC. |
||||||||||
Timezone
The timezone the organisation is in. Refer to Xero’s documenation for a list of possible timezone values. |
||||||||||
OrganisationEntityType
The entity type of the organisation. Possible values are:
|
||||||||||
ShortCode
A unique ID for the organisation. |
||||||||||
LineOfBusiness
The description of the business, as defined in the organisation’s settings. |
||||||||||
Addresses
Details about the addresses associated with the organisation.
|
||||||||||
Phones
Details about the phone numbers associated with the organisation.
|
||||||||||
ExternalLinks
Details about profile links for the organisation, such as Facebook, Twitter, LinkedIn, etc. These are set in the organisation’s settings.
|
||||||||||
PaymentTerms
Details about the default payment terms for the organisation.
|
overpayments
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
OverpaymentID |
API endpoint : |
The overpayments
table contains info about overpayments, which are transactions where a customer pays too much or you mistakenly overpay a supplier.
OverpaymentID
The overpayment ID. Reference: |
||||||||||||
UpdatedDateUTC
The date the overpayment was last updated, in UTC. |
||||||||||||
Type
The overpayment type. Possible values are:
|
||||||||||||
Contact
Details about the contact(s) associated with the overpayment.
|
||||||||||||
Date
The date the overpayment was made. |
||||||||||||
Status
The status of the overpayment. Possible values are:
|
||||||||||||
AppliedAmount
The amount of the overpayment that has been applied. |
||||||||||||
LineAmountTypes
The type of amounts of the line items in the overpayment. Possible values are:
|
||||||||||||
LineItems
Details about the line items contained in the overpayment.
|
||||||||||||
SubTotal
The subtotal of the overpayment, excluding taxes. |
||||||||||||
TotalTax
The total tax on the overpayment. |
||||||||||||
Total
The total of the overpayment, calculated as |
||||||||||||
CurrencyCode
The currency used for the overpayment. Reference: |
||||||||||||
CurrencyRate
The currency rate for a multicurrency overpayment. |
||||||||||||
RemainingCredit
The remaining credit balance on the overpayment. |
||||||||||||
Allocations
Details about the allocations associated with the overpayment.
|
||||||||||||
Payments
Details about the payments associated with the overpayment.
|
||||||||||||
Reference
The overpayment’s reference. |
||||||||||||
HasAttachments
If |
||||||||||||
DateString
The date the overpayment was made. |
payments
Replication Method : |
Key-based Incremental |
Replication Key |
UpdateDateUTC |
Primary Key |
PaymentID |
API endpoint : |
The payments
table contains info about the payments recorded in your Xero account.
PaymentID
The payment ID. Reference: |
|
UpdateDateUTC
The date the payment was last updated, in UTC. |
|
Date
The date the payment is being made. |
|
CurrencyRate
The exchange rate when the payment was received. |
|
Amount
The amount of the payment. |
|
Reference
An optional reference for the payment. For example: |
|
IsReconciled
If |
|
Status
The status of the payment. Possible values are:
|
|
PaymentType
The type of the payment. Possible values are:
|
|
Account
Details about the account the payment was made from. |
|
Invoice
Details about the invoice the payment was made against. |
|
CreditNote
Details about the credit note the payment was made against.
|
|
Prepayments
Details about the prepayment the payment was made against.
|
|
Overpayment
Details about the overpayment the payment was made against.
|
|
BankAmount
The bank amount of the payment. |
|
HasValidationErrors
If |
|
BatchPaymentID
The ID of the batch the payment was included in, if applicable. |
prepayments
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
PrepaymentID |
API endpoint : |
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.
PrepaymentID
The prepayment ID. Reference: |
||||||||||||
UpdatedDateUTC
The date the prepayment was last updated, in UTC. |
||||||||||||
Type
The prepayment type. Possible values are:
|
||||||||||||
Contact
Details about the contact(s) associated with the prepayment.
|
||||||||||||
Date
The date the prepayment was created. |
||||||||||||
Status
The status of the prepayment. Possible values are:
|
||||||||||||
LineAmountTypes
The type of amounts of the line items in the prepayment. Possible values are:
|
||||||||||||
LineItems
Details about the line items contained in the prepayment.
|
||||||||||||
SubTotal
The subtotal of the prepayment. |
||||||||||||
TotalTax
The total tax on the prepayment. |
||||||||||||
Total
The total amount of the prepayment, calculated as |
||||||||||||
CurrencyCode
The currency used for the prepayment. Reference: |
||||||||||||
CurrencyRate
The currency rate for a multicurrency prepayment. |
||||||||||||
Reference
If available, the number of the invoice associated with the prepayment. |
||||||||||||
RemainingCredit
The remaining credit balance on the prepayment. |
||||||||||||
Allocations
Details about the allocation of the prepayment.
|
||||||||||||
HasAttachments
If |
||||||||||||
DateString
The date the prepayment was made. |
purchase_orders
Replication Method : |
Key-based Incremental |
Replication Key |
UpdatedDateUTC |
Primary Key |
PurchaseOrderID |
API endpoint : |
The purchase_orders
table contains info about your purchase orders. Purchase orders are requests sent to suppliers for specific goods and services.
PurchaseOrderID
The purchase order ID. |
||||||||||||
UpdatedDateUTC
The date the purchase order was last updated, in UTC. |
||||||||||||
Date
The date the purchase order was issued. |
||||||||||||
DeliveryDate
The date the goods are to be delivered. |
||||||||||||
LineAmountTypes
The type of amounts of the line items in the purchase order. Possible values are:
|
||||||||||||
PurchaseOrderNumber
The unique alpha numeric code identifying the purchase order. |
||||||||||||
Reference
An additional reference number for the purchase order. |
||||||||||||
LineItems
Details about the line items contained in the purchase order.
|
||||||||||||
BrandingThemeID
The ID of the branding theme applied to the purchase order. Reference: |
||||||||||||
CurrencyCode
The currency that the purchase order has been raised in. Reference: |