Xero is a cloud-based accounting platform for small and medium businesses, covering invoicing, bank reconciliation, expenses, payments, and financial reporting. This connector extracts your accounting data through the Xero Accounting API, landing organizations, contacts, invoices, payments, journals, and related entities in your Catalog.

Configuring Xero as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Xero option from the list of connectors. Click Next and you’ll be prompted to add your access.

1. Add account access

Xero uses managed OAuth2, so you do not need to create an app or copy any credentials. Click the Authorization button and sign in with your Xero account, then choose the organisation you want Nekt to access. Nekt requests read-only scopes, so the connector can only read your data — it cannot modify anything in Xero. The following configurations are available:

Start date: The earliest date from which records will be synced. Records created or updated after this date will be extracted.

Optionally, under advanced settings you can define:

Tenant ID: The Xero tenant (organisation) ID to extract. Leave this empty to use the first organisation connected during authorization.
Include archived contacts: (Default: false) When enabled, archived contacts are included in the contacts stream.

Once you’re done, click Next.

2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.

Tip: The stream can be found more easily by typing its name.

Select the streams and click Next.

3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.

Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.

Once you are done configuring, click Next.

4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:

Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.

Once you are ready, click Next to finalize the setup.

5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

For you to be able to see it on your Catalog, you need at least one successful source run.

API Behaviors and Limitations

Incremental extraction

Most streams are extracted incrementally. The connector tracks the last value of each stream’s replication key and, on the next run, sends an If-Modified-Since header to Xero so only records changed after that point are fetched. The replication key is updated_date_utc for most streams, created_date_utc for bank_transfers, and journal_number for journals. The following streams do not support incremental filtering and are always synced as full table: branding_themes, contact_groups, currencies, organisations, repeating_invoices, tax_rates, and tracking_categories.

Access limitations

The connector gracefully handles access limitations to specific Xero products or data. For instance, the Journals stream requires a specific scope that is not universally granted, and the Payroll AU streams (employees, pay_runs, pay_run_payslips) require an Australian Xero organisation with Payroll enabled as well as the payroll.*.read scopes. When Xero denies access to these resources (HTTP 401, 403, or 404), the connector will skip the stream automatically with a warning rather than failing the entire data extraction run.

Many complex fields (such as line_items, contact, addresses, phones, allocations, payments, and journal_lines) are delivered as JSON-encoded strings rather than native nested objects. To work with their contents, parse the string downstream (for example with JSON_PARSE/JSON_EXTRACT on AWS or JSON_VALUE/JSON_QUERY on GCP).

Streams and Fields

Available streams

The table below lists every stream, its slug (the exact identifier to pass when creating the source via API) and a short description.

Stream	Slug	Description
Accounts	`accounts`	The chart of accounts in the organisation.
Bank Transactions	`bank_transactions`	Spend and receive money transactions against bank accounts.
Bank Transfers	`bank_transfers`	Transfers of money between two bank accounts.
Branding Themes	`branding_themes`	Branding themes used on invoices and other documents.
Contact Groups	`contact_groups`	Groups used to organize contacts.
Contacts	`contacts`	Customers and suppliers in the organisation.
Credit Notes	`credit_notes`	Credit notes issued to customers or received from suppliers.
Currencies	`currencies`	Currencies set up in the organisation.
Employees	`employees`	Payroll employees (Australia).
Invoices	`invoices`	Sales invoices (ACCREC) and bills (ACCPAY).
Items	`items`	Inventory and non-inventory items.
Journals	`journals`	Posted journals representing the underlying double-entry transactions.
Linked Transactions	`linked_transactions`	Links between billable expenses and the invoices they are charged on.
Manual Journals	`manual_journals`	Manual journal entries posted directly to the ledger.
Organisations	`organisations`	The Xero organisation(s) connected to the credentials.
Overpayments	`overpayments`	Overpayments recorded against contacts.
Pay Run Payslips	`pay_run_payslips`	Payslip summaries of each pay run (Australia).
Pay Runs	`pay_runs`	Pay runs of the organisation (Australia).
Payments	`payments`	Payments applied to invoices, credit notes, prepayments, and overpayments.
Prepayments	`prepayments`	Prepayments recorded against contacts.
Purchase Orders	`purchase_orders`	Purchase orders raised against suppliers.
Quotes	`quotes`	Quotes issued to customers.
Repeating Invoices	`repeating_invoices`	Templates for recurring invoices.
Tax Rates	`tax_rates`	Tax rates configured in the organisation.
Tracking Categories	`tracking_categories`	Tracking categories and their options for reporting.
Users	`users`	Users with access to the organisation.

Fields by stream

Below you’ll find all available data streams from Xero and their corresponding fields.

Accounts

The chart of accounts in the organisation.Primary key: account_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`account_id`	String	Unique identifier for the account
`code`	String	Account code
`name`	String	Account name
`type`	String	Account type
`class`	String	Account class
`status`	String	Account status
`description`	String	Description of the account
`system_account`	Boolean	System account indicator
`bank_account_type`	String	Type of bank account
`bank_account_number`	String	Bank account number
`currency_code`	String	Currency code of the account
`tax_type`	String	Default tax type
`reporting_code`	String	Reporting code
`reporting_code_name`	String	Reporting code name
`show_in_expense_claims`	Boolean	Whether the account appears in expense claims
`enable_payments_to_account`	Boolean	Whether payments can be made to this account
`has_attachments`	Boolean	Whether the account has attachments
`add_to_watchlist`	Boolean	Whether the account is on the watchlist
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Bank Transactions

Spend and receive money transactions against bank accounts.Primary key: bank_transaction_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`bank_transaction_id`	String	Unique identifier for the bank transaction
`type`	String	Transaction type (e.g. SPEND, RECEIVE)
`status`	String	Transaction status
`contact`	JSON String	Associated contact
`line_items`	JSON String	Transaction line items
`bank_account`	JSON String	Bank account the transaction belongs to
`is_reconciled`	Boolean	Whether the transaction is reconciled
`date`	DateTime	Transaction date
`date_string`	String	Transaction date as string
`reference`	String	Reference
`currency_code`	String	Currency code
`currency_rate`	Number	Currency exchange rate
`url`	String	Source URL
`line_amount_types`	String	Whether line amounts are tax inclusive, exclusive, or no tax
`sub_total`	Number	Sub-total
`total_tax`	Number	Total tax
`total`	Number	Total amount
`prepayment_id`	String	Related prepayment ID
`overpayment_id`	String	Related overpayment ID
`has_attachments`	Boolean	Whether the transaction has attachments
`external_link_provider_name`	String	External link provider name
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Bank Transfers

Transfers of money between two bank accounts.Primary key: bank_transfer_id
Sync: Incremental on created_date_utc

Field	Type	Description
`bank_transfer_id`	String	Unique identifier for the bank transfer
`from_bank_account`	JSON String	Source bank account
`to_bank_account`	JSON String	Destination bank account
`amount`	Number	Transfer amount
`date`	DateTime	Transfer date
`date_string`	String	Transfer date as string
`currency_rate`	Number	Currency exchange rate
`from_bank_transaction_id`	String	Source bank transaction ID
`to_bank_transaction_id`	String	Destination bank transaction ID
`has_attachments`	Boolean	Whether the transfer has attachments
`created_date_utc`	DateTime	Creation timestamp (replication key)
`created_date_utc_string`	String	Creation timestamp as string

Branding Themes

Branding themes used on invoices and other documents.Primary key: branding_theme_id
Sync: Full table

Field	Type	Description
`branding_theme_id`	String	Unique identifier for the branding theme
`name`	String	Branding theme name
`type`	String	Branding theme type
`logo_url`	String	Logo URL
`sort_order`	Integer	Sort order
`created_date_utc`	DateTime	Creation timestamp

Contact Groups

Groups used to organize contacts.Primary key: contact_group_id
Sync: Full table

Field	Type	Description
`contact_group_id`	String	Unique identifier for the contact group
`name`	String	Contact group name
`status`	String	Contact group status
`has_validation_errors`	Boolean	Whether the group has validation errors
`contacts`	JSON String	Contacts in the group

Contacts

Customers and suppliers in the organisation. Archived contacts are included only when “Include archived contacts” is enabled.Primary key: contact_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`contact_id`	String	Unique identifier for the contact
`contact_number`	String	Contact number
`account_number`	String	Account number
`contact_status`	String	Contact status
`name`	String	Contact name
`first_name`	String	First name
`last_name`	String	Last name
`email_address`	String	Email address
`skype_user_name`	String	Skype username
`bank_account_details`	String	Bank account details
`tax_number`	String	Tax number
`accounts_receivable_tax_type`	String	Accounts receivable tax type
`accounts_payable_tax_type`	String	Accounts payable tax type
`addresses`	JSON String	Contact addresses
`phones`	JSON String	Contact phone numbers
`is_supplier`	Boolean	Whether the contact is a supplier
`is_customer`	Boolean	Whether the contact is a customer
`default_currency`	String	Default currency
`contact_persons`	JSON String	Additional contact persons
`xero_network_key`	String	Xero network key
`sales_default_account_code`	String	Default sales account code
`purchases_default_account_code`	String	Default purchases account code
`sales_tracking_categories`	JSON String	Sales tracking categories
`purchases_tracking_categories`	JSON String	Purchases tracking categories
`tracking_category_name`	String	Tracking category name
`tracking_category_option`	String	Tracking category option
`payment_terms`	JSON String	Payment terms
`contact_groups`	JSON String	Groups the contact belongs to
`website`	String	Website
`branding_theme`	JSON String	Default branding theme
`batch_payments`	JSON String	Batch payment details
`discount`	Number	Default discount
`balances`	JSON String	Outstanding and overdue balances
`has_attachments`	Boolean	Whether the contact has attachments
`attachments`	JSON String	Attachments
`has_validation_errors`	Boolean	Whether the contact has validation errors
`validation_errors`	JSON String	Validation errors
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Credit Notes

Credit notes issued to customers or received from suppliers.Primary key: credit_note_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`credit_note_id`	String	Unique identifier for the credit note
`id`	String	Identifier alias
`credit_note_number`	String	Credit note number
`type`	String	Credit note type
`status`	String	Credit note status
`contact`	JSON String	Associated contact
`date`	DateTime	Credit note date
`date_string`	String	Credit note date as string
`due_date`	DateTime	Due date
`due_date_string`	String	Due date as string
`line_amount_types`	String	Whether line amounts are tax inclusive, exclusive, or no tax
`line_items`	JSON String	Line items
`invoice_addresses`	JSON String	Invoice addresses
`sub_total`	Number	Sub-total
`applied_amount`	Number	Applied amount
`total_tax`	Number	Total tax
`total`	Number	Total amount
`currency_code`	String	Currency code
`currency_rate`	Number	Currency exchange rate
`remaining_credit`	Number	Remaining credit
`allocations`	JSON String	Allocations against invoices
`branding_theme_id`	String	Branding theme ID
`reference`	String	Reference
`sent_to_contact`	Boolean	Whether sent to the contact
`fully_paid_on_date`	DateTime	Date fully paid
`has_attachments`	Boolean	Whether the credit note has attachments
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Currencies

Currencies set up in the organisation.Primary key: code
Sync: Full table

Field	Type	Description
`code`	String	Currency code
`description`	String	Currency description

Employees

Payroll employees (Xero Payroll Australia).Primary key: employee_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`employee_id`	String	Xero identifier of the employee.
`first_name`	String	First name of the employee.
`middle_names`	String	Middle name(s) of the employee.
`last_name`	String	Last name of the employee.
`title`	String	Title of the employee (Mr, Ms, …).
`email`	String	Email address of the employee.
`job_title`	String	Job title of the employee.
`classification`	String	Award classification of the employee.
`employee_group_name`	String	Employee group the employee currently belongs to (payroll tracking option for team/department).
`payroll_calendar_id`	String	Identifier of the payroll calendar (pay frequency) the employee is paid on.
`ordinary_earnings_rate_id`	String	Identifier of the earnings rate used for the employee’s ordinary hours.
`start_date`	DateTime	Employment start date.
`termination_date`	DateTime	Employment termination date, when terminated.
`termination_reason`	String	Reason code of the termination (e.g. V for voluntary cessation).
`status`	String	Employment status: ACTIVE or TERMINATED.
`income_type`	String	Income type of the employee for STP reporting.
`employment_type`	String	Employment type (employee or contractor).
`country_of_residence`	String	Country of residence of the employee.
`is_authorised_to_approve_leave`	Boolean	Whether the employee can approve other employees’ leave requests.
`is_authorised_to_approve_timesheets`	Boolean	Whether the employee can approve timesheets.
`is_stp2_qualified`	Boolean	Whether the employee record has been updated for STP Phase 2 compliance.
`updated_date_utc`	DateTime	Timestamp of the last modification of the employee (replication key).

Invoices

Sales invoices (ACCREC) and bills (ACCPAY).Primary key: invoice_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`invoice_id`	String	Unique identifier for the invoice
`invoice_number`	String	Invoice number
`type`	String	Invoice type (ACCREC or ACCPAY)
`status`	String	Invoice status
`contact`	JSON String	Associated contact
`date`	DateTime	Invoice date
`date_string`	String	Invoice date as string
`due_date`	DateTime	Due date
`due_date_string`	String	Due date as string
`line_amount_types`	String	Whether line amounts are tax inclusive, exclusive, or no tax
`line_items`	JSON String	Line items
`sub_total`	Number	Sub-total
`total_tax`	Number	Total tax
`total`	Number	Total amount
`total_discount`	Number	Total discount
`currency_code`	String	Currency code
`currency_rate`	Number	Currency exchange rate
`reference`	String	Reference
`branding_theme_id`	String	Branding theme ID
`url`	String	Source URL
`sent_to_contact`	Boolean	Whether sent to the contact
`expected_payment_date`	DateTime	Expected payment date
`expected_payment_date_string`	String	Expected payment date as string
`planned_payment_date`	DateTime	Planned payment date
`planned_payment_date_string`	String	Planned payment date as string
`has_attachments`	Boolean	Whether the invoice has attachments
`payments`	JSON String	Payments applied
`credit_notes`	JSON String	Credit notes applied
`prepayments`	JSON String	Prepayments applied
`overpayments`	JSON String	Overpayments applied
`amount_due`	Number	Amount due
`amount_paid`	Number	Amount paid
`amount_credited`	Number	Amount credited
`fully_paid_on_date`	DateTime	Date fully paid
`is_discounted`	Boolean	Whether the invoice is discounted
`has_errors`	Boolean	Whether the invoice has errors
`invoice_addresses`	JSON String	Invoice addresses
`invoice_payment_services`	JSON String	Payment services
`repeating_invoice_id`	String	Source repeating invoice ID
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Items

Inventory and non-inventory items.Primary key: item_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`item_id`	String	Unique identifier for the item
`code`	String	Item code
`name`	String	Item name
`description`	String	Sales description
`purchase_description`	String	Purchase description
`is_sold`	Boolean	Whether the item is sold
`is_purchased`	Boolean	Whether the item is purchased
`purchase_details`	JSON String	Purchase details
`sales_details`	JSON String	Sales details
`is_tracked_as_inventory`	Boolean	Whether tracked as inventory
`inventory_asset_account_code`	String	Inventory asset account code
`total_cost_pool`	Number	Total cost pool
`quantity_on_hand`	Number	Quantity on hand
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Journals

Posted journals representing the underlying double-entry transactions.Primary key: journal_id
Sync: Incremental on journal_number. This endpoint does not support the If-Modified-Since header — it is paginated by an offset equal to the highest journal number already seen.

The journals stream requires the Xero accounting.journals scope, which the granular-scoped Nekt app does not request. When this scope is absent, Xero returns a 401 and the connector skips the stream automatically with a warning instead of failing the run. If you need journals, contact our support team.

Field	Type	Description
`journal_id`	String	Unique identifier for the journal
`journal_number`	Integer	Sequential journal number (replication key)
`journal_date`	DateTime	Journal date
`created_date_utc`	DateTime	Creation timestamp
`reference`	String	Reference
`source_id`	String	Source document ID
`source_type`	String	Source document type
`journal_lines`	JSON String	Journal lines

Linked Transactions

Links between billable expenses and the invoices they are charged on (billable expenses / on-charging).Primary key: linked_transaction_id
Sync: Incremental on updated_date_utc. This endpoint does not support the If-Modified-Since header, so records are paged through in full and filtered client-side by updated_date_utc.

Field	Type	Description
`linked_transaction_id`	String	Unique identifier for the linked transaction
`status`	String	Linked transaction status
`type`	String	Linked transaction type
`source_transaction_id`	String	Source transaction ID
`source_line_item_id`	String	Source line item ID
`source_transaction_type_code`	String	Source transaction type code
`contact_id`	String	Associated contact ID
`target_transaction_id`	String	Target transaction ID
`target_line_item_id`	String	Target line item ID
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Manual Journals

Manual journal entries posted directly to the ledger.Primary key: manual_journal_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`manual_journal_id`	String	Unique identifier for the manual journal
`date`	DateTime	Journal date
`status`	String	Manual journal status
`narration`	String	Narration / description
`line_amount_types`	String	Whether line amounts are tax inclusive, exclusive, or no tax
`journal_lines`	JSON String	Journal lines
`url`	String	Source URL
`show_on_cash_basis_reports`	Boolean	Whether shown on cash basis reports
`has_attachments`	Boolean	Whether the manual journal has attachments
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Organisations

The Xero organisation(s) connected to the credentials, including settings and metadata.Primary key: organisation_id
Sync: Full table

Field	Type	Description
`organisation_id`	String	Unique identifier for the organisation
`api_key`	String	API key
`name`	String	Organisation name
`legal_name`	String	Legal name
`short_code`	String	Short code
`pays_tax`	Boolean	Whether the organisation pays tax
`version`	String	Xero version
`edition`	String	Xero edition
`class`	String	Organisation class
`organisation_type`	String	Organisation type
`organisation_entity_type`	String	Organisation entity type
`organisation_status`	String	Organisation status
`base_currency`	String	Base currency
`country_code`	String	Country code
`is_demo_company`	Boolean	Whether it is a demo company
`registration_number`	String	Registration number
`tax_number`	String	Tax number
`tax_number_name`	String	Tax number label
`financial_year_end_day`	Integer	Financial year end day
`financial_year_end_month`	Integer	Financial year end month
`sales_tax_basis`	String	Sales tax basis
`sales_tax_period`	String	Sales tax period
`default_sales_tax`	String	Default sales tax
`default_purchases_tax`	String	Default purchases tax
`period_lock_date`	DateTime	Period lock date
`end_of_year_lock_date`	DateTime	End of year lock date
`timezone`	String	Timezone
`line_of_business`	String	Line of business
`addresses`	JSON String	Organisation addresses
`phones`	JSON String	Organisation phone numbers
`external_links`	JSON String	External links
`payment_terms`	JSON String	Payment terms
`created_date_utc`	DateTime	Creation timestamp

Overpayments

Overpayments recorded against contacts.Primary key: overpayment_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`overpayment_id`	String	Unique identifier for the overpayment
`id`	String	Identifier alias
`type`	String	Overpayment type
`status`	String	Overpayment status
`contact`	JSON String	Associated contact
`date`	DateTime	Overpayment date
`date_string`	String	Overpayment date as string
`line_amount_types`	String	Whether line amounts are tax inclusive, exclusive, or no tax
`line_items`	JSON String	Line items
`applied_amount`	Number	Applied amount
`sub_total`	Number	Sub-total
`total_tax`	Number	Total tax
`total`	Number	Total amount
`currency_code`	String	Currency code
`currency_rate`	Number	Currency exchange rate
`remaining_credit`	Number	Remaining credit
`allocations`	JSON String	Allocations against invoices
`payments`	JSON String	Payments
`reference`	String	Reference
`has_attachments`	Boolean	Whether the overpayment has attachments
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Pay Run Payslips

Payslip summaries of each pay run (Xero Payroll Australia).Primary key: payslip_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`payslip_id`	String	Xero identifier of the payslip.
`pay_run_id`	String	Identifier of the pay run the payslip belongs to.
`employee_id`	String	Identifier of the employee the payslip was issued to.
`first_name`	String	First name of the employee.
`last_name`	String	Last name of the employee.
`employee_group`	String	Employee group of the employee at the time of the pay run.
`wages`	Number	Gross wages of the payslip.
`deductions`	Number	Total deductions of the payslip.
`tax`	Number	PAYG tax withheld on the payslip.
`super`	Number	Superannuation contributions of the payslip.
`reimbursements`	Number	Reimbursements paid on the payslip.
`net_pay`	Number	Net pay of the payslip.
`payroll_calendar_id`	String	Identifier of the payroll calendar (pay frequency) of the pay run.
`pay_run_period_start_date`	DateTime	First day of the pay period covered by the pay run.
`pay_run_period_end_date`	DateTime	Last day of the pay period covered by the pay run.
`payment_date`	DateTime	Date the employees are paid for the pay run.
`pay_run_status`	String	Status of the pay run: DRAFT or POSTED.
`pay_run_updated_date_utc`	DateTime	Timestamp of the last modification of the parent pay run.
`updated_date_utc`	DateTime	Timestamp of the last modification of the payslip (replication key). Falls back to the pay run’s timestamp when Xero omits it.

Pay Runs

Pay runs of the organisation (Xero Payroll Australia).Primary key: pay_run_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`pay_run_id`	String	Xero identifier of the pay run.
`payroll_calendar_id`	String	Identifier of the payroll calendar (pay frequency) the pay run belongs to.
`pay_run_period_start_date`	DateTime	First day of the pay period covered by the pay run.
`pay_run_period_end_date`	DateTime	Last day of the pay period covered by the pay run.
`payment_date`	DateTime	Date the employees are paid for this pay run.
`pay_run_status`	String	Status of the pay run: DRAFT (still editable) or POSTED (final, journals posted).
`payslip_message`	String	Message printed on every payslip of the pay run.
`updated_date_utc`	DateTime	Timestamp of the last modification of the pay run (replication key).

Payments

Payments applied to invoices, credit notes, prepayments, and overpayments.Primary key: payment_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`payment_id`	String	Unique identifier for the payment
`date`	DateTime	Payment date
`amount`	Number	Payment amount
`bank_amount`	Number	Bank amount
`currency_rate`	Number	Currency exchange rate
`reference`	String	Reference
`is_reconciled`	Boolean	Whether the payment is reconciled
`status`	String	Payment status
`payment_type`	String	Payment type
`account`	JSON String	Account paid from/to
`has_account`	Boolean	Whether an account is set
`invoice`	JSON String	Related invoice
`credit_note`	JSON String	Related credit note
`prepayments`	JSON String	Related prepayments
`overpayment`	JSON String	Related overpayment
`batch_payment_id`	String	Batch payment ID
`batch_payment`	JSON String	Batch payment details
`has_validation_errors`	Boolean	Whether the payment has validation errors
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Prepayments

Prepayments recorded against contacts.Primary key: prepayment_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`prepayment_id`	String	Unique identifier for the prepayment
`id`	String	Identifier alias
`type`	String	Prepayment type
`status`	String	Prepayment status
`contact`	JSON String	Associated contact
`date`	DateTime	Prepayment date
`date_string`	String	Prepayment date as string
`line_amount_types`	String	Whether line amounts are tax inclusive, exclusive, or no tax
`line_items`	JSON String	Line items
`sub_total`	Number	Sub-total
`total_tax`	Number	Total tax
`total`	Number	Total amount
`currency_code`	String	Currency code
`currency_rate`	Number	Currency exchange rate
`reference`	String	Reference
`remaining_credit`	Number	Remaining credit
`applied_amount`	Number	Applied amount
`allocations`	JSON String	Allocations against invoices
`payments`	JSON String	Payments
`has_attachments`	Boolean	Whether the prepayment has attachments
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Purchase Orders

Purchase orders raised against suppliers.Primary key: purchase_order_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`purchase_order_id`	String	Unique identifier for the purchase order
`purchase_order_number`	String	Purchase order number
`type`	String	Purchase order type
`status`	String	Purchase order status
`contact`	JSON String	Associated contact
`date`	DateTime	Order date
`date_string`	String	Order date as string
`delivery_date`	DateTime	Delivery date
`delivery_date_string`	String	Delivery date as string
`expected_arrival_date`	DateTime	Expected arrival date
`expected_arrival_date_string`	String	Expected arrival date as string
`line_amount_types`	String	Whether line amounts are tax inclusive, exclusive, or no tax
`line_items`	JSON String	Line items
`reference`	String	Reference
`branding_theme_id`	String	Branding theme ID
`currency_code`	String	Currency code
`currency_rate`	Number	Currency exchange rate
`sent_to_contact`	Boolean	Whether sent to the contact
`delivery_address`	String	Delivery address
`attention_to`	String	Attention to
`telephone`	String	Telephone
`delivery_instructions`	String	Delivery instructions
`sub_total`	Number	Sub-total
`total_tax`	Number	Total tax
`total`	Number	Total amount
`total_discount`	Number	Total discount
`is_discounted`	Boolean	Whether the order is discounted
`has_errors`	Boolean	Whether the order has errors
`has_attachments`	Boolean	Whether the order has attachments
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Quotes

Quotes issued to customers.Primary key: quote_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`quote_id`	String	Unique identifier for the quote
`quote_number`	String	Quote number
`status`	String	Quote status
`contact`	JSON String	Associated contact
`date`	DateTime	Quote date
`expiry_date`	DateTime	Expiry date
`line_amount_types`	String	Whether line amounts are tax inclusive, exclusive, or no tax
`line_items`	JSON String	Line items
`sub_total`	Number	Sub-total
`total_tax`	Number	Total tax
`total`	Number	Total amount
`total_discount`	Number	Total discount
`currency_code`	String	Currency code
`currency_rate`	Number	Currency exchange rate
`reference`	String	Reference
`branding_theme_id`	String	Branding theme ID
`title`	String	Quote title
`summary`	String	Quote summary
`terms`	String	Quote terms
`tracking_category`	JSON String	Tracking category
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Repeating Invoices

Templates for recurring invoices.Primary key: repeating_invoice_id
Sync: Full table

Field	Type	Description
`repeating_invoice_id`	String	Unique identifier for the repeating invoice
`id`	String	Identifier alias
`type`	String	Invoice type
`status`	String	Repeating invoice status
`contact`	JSON String	Associated contact
`schedule`	JSON String	Recurrence schedule
`line_items`	JSON String	Line items
`line_amount_types`	String	Whether line amounts are tax inclusive, exclusive, or no tax
`reference`	String	Reference
`branding_theme_id`	String	Branding theme ID
`currency_code`	String	Currency code
`sub_total`	Number	Sub-total
`total_tax`	Number	Total tax
`total`	Number	Total amount
`total_discount`	Number	Total discount
`has_attachments`	Boolean	Whether the repeating invoice has attachments

Tax Rates

Tax rates configured in the organisation.Primary key: tax_type
Sync: Full table

Field	Type	Description
`tax_type`	String	Tax type (primary key)
`name`	String	Tax rate name
`status`	String	Tax rate status
`report_tax_type`	String	Report tax type
`tax_components`	JSON String	Tax components
`display_tax_rate`	Number	Display tax rate
`effective_rate`	Number	Effective tax rate
`can_apply_to_assets`	Boolean	Whether it can apply to assets
`can_apply_to_equity`	Boolean	Whether it can apply to equity
`can_apply_to_expenses`	Boolean	Whether it can apply to expenses
`can_apply_to_liabilities`	Boolean	Whether it can apply to liabilities
`can_apply_to_revenue`	Boolean	Whether it can apply to revenue

Tracking Categories

Tracking categories and their options for reporting.Primary key: tracking_category_id
Sync: Full table

Field	Type	Description
`tracking_category_id`	String	Unique identifier for the tracking category
`name`	String	Tracking category name
`status`	String	Tracking category status
`tracking_category_name`	String	Tracking category name (alternate)
`option`	String	Tracking option
`options`	JSON String	Available options
`tracking_option_id`	String	Tracking option ID
`tracking_option_name`	String	Tracking option name

Users

Users with access to the organisation.Primary key: user_id
Sync: Incremental on updated_date_utc

Field	Type	Description
`user_id`	String	Unique identifier for the user
`email_address`	String	Email address
`first_name`	String	First name
`last_name`	String	Last name
`organisation_role`	String	Role within the organisation
`is_subscriber`	Boolean	Whether the user is a subscriber
`global_user_id`	String	Global user ID
`validation_errors`	JSON String	Validation errors
`updated_date_utc`	DateTime	Last modified timestamp (replication key)

Skills for agents

Download Xero skills file

Xero connector documentation as plain markdown, for use in AI agent contexts.

Documentation

Get started

Context

Activate

Workspace

Resources

Xero as a data source

Configuring Xero as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

API Behaviors and Limitations

Incremental extraction

Access limitations

Streams and Fields

Available streams

Fields by stream

Skills for agents

Download Xero skills file

​Configuring Xero as a Source

​1. Add account access

​2. Select streams

​3. Configure data streams

​4. Configure data source

​5. Check your new source

​API Behaviors and Limitations

​Incremental extraction

​Access limitations

​Streams and Fields

​Available streams

​Fields by stream

​Skills for agents

Download Xero skills file

Configuring Xero as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

API Behaviors and Limitations

Incremental extraction

Access limitations

Streams and Fields

Available streams

Fields by stream

Skills for agents