Overview - Corsair

Use Xero through Corsair: one client, typed API calls, local DB sync. What you get:

39 typed API operations
9 synced entities (accounts, bankTransactions, contacts, creditNotes, invoices, items, and 3 more) for fast .search() / .list()

Setup

Install

npm install corsair @corsair-dev/xero

yarn add corsair @corsair-dev/xero

pnpm install corsair @corsair-dev/xero

bun add corsair @corsair-dev/xero

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { xero } from '@corsair-dev/xero';

export const corsair = createCorsair({
	plugins: [
		xero(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

OAuth 2.0 (Recommended)
API Key

Open hub.corsair.dev, navigate to your project, and enter the client ID and client secret from your Xero OAuth app.

xero()

More: OAuth 2.0

No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.

xero({
	authType: 'api_key',
})

More: API Key

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'xero',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

List contacts

const tenant = corsair.withTenant('acme');
await tenant.xero.api.contacts.list({});

Create a contact

const tenant = corsair.withTenant('acme');
await tenant.xero.api.contacts.create({ Name: 'Acme Ltd', EmailAddress: 'billing@example.com' });

See the full list on the API page.

Query synced data

Search synced contacts without hitting Xero.

const tenant = corsair.withTenant('acme');
const rows = await tenant.xero.db.contacts.search({
	data: {},
	limit: 50,
});

Synced entities: accounts, bankTransactions, contacts, creditNotes, invoices, items, payments, purchaseOrders, quotes. See Database for filters and operators.

What’s next

API reference

Every xero.api.* operation with input and output types.

Database

Synced entities, search filters, and operators.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

​Setup

​Example API calls

​Query synced data

​What’s next