Skip to main content

Documentation Index

Fetch the complete documentation index at: https://nango.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

πŸš€ Quickstart

Connect to Xero with Nango and see data flow in 2 minutes.
1

Create the integration

In Nango (free signup), go to Integrations -> Configure New Integration -> Xero.
2

Authorize Xero

Go to Connections -> Add Test Connection -> Authorize, then log in to Xero. Later, you’ll let your users do the same directly from your app.
3

Call the Xero API

Let’s make your first request to the Xero API. Replace the placeholders below with your secret key, integration ID, and connection ID:
curl "https://api.nango.dev/proxy/api.xro/2.0/Contacts" \
  -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
  -H "Provider-Config-Key: <INTEGRATION-ID>" \
  -H "Connection-Id: <CONNECTION-ID>"
Or fetch credentials with the Node SDK or API.βœ… You’re connected! Check the Logs tab in Nango to inspect requests.
4

Implement Nango in your app

Follow our Auth implementation guide to integrate Nango in your app.To obtain your own production credentials, follow the setup guide linked below.

πŸ“š Xero Integration Guides

Nango maintained guides for common use cases. Official docs: Xero API documentation

🧩 Pre-built syncs & actions for Xero

Enable them in your dashboard. Extend and customize to fit your needs.

Accounts

Function nameDescriptionTypeSource code
create-accountCreate an account in the Xero chart of accounts.ActionπŸ”— Github
get-accountRetrieve an account by AccountID.ActionπŸ”— Github
list-accountsList accounts in the Xero chart of accounts.ActionπŸ”— Github
update-accountUpdate an existing account.ActionπŸ”— Github

Bank Transactions

Function nameDescriptionTypeSource code
create-bank-transactionCreate a spend or receive money bank transactionActionπŸ”— Github
get-bank-transactionRetrieve a bank transaction by BankTransactionID.ActionπŸ”— Github
list-bank-transactionsList bank transactions with filters and pagination.ActionπŸ”— Github
update-bank-transactionUpdate an existing bank transaction.ActionπŸ”— Github

Contacts

Function nameDescriptionTypeSource code
create-contactCreate a contact in Xero.ActionπŸ”— Github
get-contactRetrieve a contact by ContactIDActionπŸ”— Github
list-contactsList contacts with filters and pagination.ActionπŸ”— Github
update-contactUpdate an existing contact.ActionπŸ”— Github

Credit Notes

Function nameDescriptionTypeSource code
create-credit-noteCreate a credit note for a contactActionπŸ”— Github
get-credit-noteRetrieve a credit note by CreditNoteID.ActionπŸ”— Github
list-credit-notesList credit notes with filters and pagination.ActionπŸ”— Github
update-credit-noteUpdate an existing credit note.ActionπŸ”— Github

General Ledger

Function nameDescriptionTypeSource code
general-ledgerSync Xero general ledger journals, each containing journal lines with account and tax details.SyncπŸ”— Github

Invoices

Function nameDescriptionTypeSource code
create-invoiceCreate a sales or purchase invoice.ActionπŸ”— Github
get-invoiceRetrieve an invoice by InvoiceID.ActionπŸ”— Github
update-invoiceUpdate an existing invoice.ActionπŸ”— Github

Items

Function nameDescriptionTypeSource code
create-itemCreate an inventory or catalog item.ActionπŸ”— Github
get-itemRetrieve an item by ItemID.ActionπŸ”— Github
list-itemsList items with optional filtering.ActionπŸ”— Github
update-itemUpdate an existing item.ActionπŸ”— Github

Payments

Function nameDescriptionTypeSource code
create-paymentCreate a payment against an invoice or credit note.ActionπŸ”— Github
get-paymentRetrieve a payment by PaymentID.ActionπŸ”— Github

Purchase Orders

Function nameDescriptionTypeSource code
create-purchase-orderCreate a purchase order for a contact.ActionπŸ”— Github
get-purchase-orderRetrieve a purchase order by PurchaseOrderID.ActionπŸ”— Github
list-purchase-ordersList purchase orders with filters and paginationActionπŸ”— Github
update-purchase-orderUpdate an existing purchase order.ActionπŸ”— Github

Tenants

Function nameDescriptionTypeSource code
get-tenantsFetches all the tenants the connection has access to. This can be used to set the metadata to the selected tenant.ActionπŸ”— Github
list-tenantsList Xero tenants connected to the current OAuth token.ActionπŸ”— Github

Others

Function nameDescriptionTypeSource code
list-invoicesList invoices with filters and pagination.ActionπŸ”— Github
list-paymentsList payments with filters and paginationActionπŸ”— Github
accountsSync accounts from the Xero chart of accounts.SyncπŸ”— Github
bank-transactionsSync bank transactions from Xero.SyncπŸ”— Github
contactsSync contacts from Xero.SyncπŸ”— Github
credit-notesSync credit notes from Xero.SyncπŸ”— Github
invoicesSync invoices from Xero.SyncπŸ”— Github
itemsSync inventory and catalog items from Xero.SyncπŸ”— Github
organisationsSync Xero organisation records for connected tenants.SyncπŸ”— Github
paymentsSync payments from Xero.SyncπŸ”— Github
purchase-ordersSync purchase orders from Xero.SyncπŸ”— Github