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.
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. 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>"
Install Nangoβs backend SDK with npm i @nangohq/node. Then run:import { Nango } from '@nangohq/node';
const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });
const res = await nango.get({
endpoint: '/api.xro/2.0/Contacts',
providerConfigKey: '<INTEGRATION-ID>',
connectionId: '<CONNECTION-ID>'
});
console.log(res.data);
Or fetch credentials with the Node SDK or API.β
Youβre connected! Check the Logs tab in Nango to inspect requests. 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 name | Description | Type | Source code |
|---|
create-account | Create an account in the Xero chart of accounts. | Action | π Github |
get-account | Retrieve an account by AccountID. | Action | π Github |
list-accounts | List accounts in the Xero chart of accounts. | Action | π Github |
update-account | Update an existing account. | Action | π Github |
Bank Transactions
| Function name | Description | Type | Source code |
|---|
create-bank-transaction | Create a spend or receive money bank transaction | Action | π Github |
get-bank-transaction | Retrieve a bank transaction by BankTransactionID. | Action | π Github |
list-bank-transactions | List bank transactions with filters and pagination. | Action | π Github |
update-bank-transaction | Update an existing bank transaction. | Action | π Github |
| Function name | Description | Type | Source code |
|---|
create-contact | Create a contact in Xero. | Action | π Github |
get-contact | Retrieve a contact by ContactID | Action | π Github |
list-contacts | List contacts with filters and pagination. | Action | π Github |
update-contact | Update an existing contact. | Action | π Github |
Credit Notes
| Function name | Description | Type | Source code |
|---|
create-credit-note | Create a credit note for a contact | Action | π Github |
get-credit-note | Retrieve a credit note by CreditNoteID. | Action | π Github |
list-credit-notes | List credit notes with filters and pagination. | Action | π Github |
update-credit-note | Update an existing credit note. | Action | π Github |
General Ledger
| Function name | Description | Type | Source code |
|---|
general-ledger | Sync Xero general ledger journals, each containing journal lines with account and tax details. | Sync | π Github |
Invoices
| Function name | Description | Type | Source code |
|---|
create-invoice | Create a sales or purchase invoice. | Action | π Github |
get-invoice | Retrieve an invoice by InvoiceID. | Action | π Github |
update-invoice | Update an existing invoice. | Action | π Github |
| Function name | Description | Type | Source code |
|---|
create-item | Create an inventory or catalog item. | Action | π Github |
get-item | Retrieve an item by ItemID. | Action | π Github |
list-items | List items with optional filtering. | Action | π Github |
update-item | Update an existing item. | Action | π Github |
Payments
| Function name | Description | Type | Source code |
|---|
create-payment | Create a payment against an invoice or credit note. | Action | π Github |
get-payment | Retrieve a payment by PaymentID. | Action | π Github |
Purchase Orders
| Function name | Description | Type | Source code |
|---|
create-purchase-order | Create a purchase order for a contact. | Action | π Github |
get-purchase-order | Retrieve a purchase order by PurchaseOrderID. | Action | π Github |
list-purchase-orders | List purchase orders with filters and pagination | Action | π Github |
update-purchase-order | Update an existing purchase order. | Action | π Github |
Tenants
| Function name | Description | Type | Source code |
|---|
get-tenants | Fetches all the tenants the connection has access to. This can be used to set the metadata to the selected tenant. | Action | π Github |
list-tenants | List Xero tenants connected to the current OAuth token. | Action | π Github |
| Function name | Description | Type | Source code |
|---|
list-invoices | List invoices with filters and pagination. | Action | π Github |
list-payments | List payments with filters and pagination | Action | π Github |
accounts | Sync accounts from the Xero chart of accounts. | Sync | π Github |
bank-transactions | Sync bank transactions from Xero. | Sync | π Github |
contacts | Sync contacts from Xero. | Sync | π Github |
credit-notes | Sync credit notes from Xero. | Sync | π Github |
invoices | Sync invoices from Xero. | Sync | π Github |
items | Sync inventory and catalog items from Xero. | Sync | π Github |
organisations | Sync Xero organisation records for connected tenants. | Sync | π Github |
payments | Sync payments from Xero. | Sync | π Github |
purchase-orders | Sync purchase orders from Xero. | Sync | π Github |