xero-node
Advanced tools
Readme
Version 4.x of Xero NodeJS SDK supports OAuth2 authentication and the following API sets.
Follow these steps to create your Xero app
This SDK's functionality is majority generated from our OpenAPISpec.
The exception is the src/xeroClient.ts which contains the typescript that is unique to this repository. Contributions are welcome but please keep in mind that majority of SDK is auto-generated from the OpenAPISpec. We try to get changes in that projects to be released on a reasonable cadence.
Read more about our process in maintaining our suite of SDK's
We are working to build out a more robust test suite, and currently just have tests setup for our xeroClient.ts - PR's will now run against a CI build - and as we add more tests to this project community collaboration will be easier to incorporate.
npm test
We use OAuth2.0 to generate access tokens that authenticate requests against our API. Each API call will need to have a valid token populated on the API client to succeed. In a tokenSet will be an access_token which lasts for 30 minutes, and a refresh_token which lasts for 60 days. If you don't want to require your users to re-authenticate each time you want to call the API on their behalf, you will need a datastore for these tokens and will be required to refresh the tokens at least once per 60 days to avoid expiration. The offline_access scope is required for refresh tokens to work.
In Xero a user can belong to multiple organisations. Tokens are ultimately associated with a Xero user, who can belong to multiple tenants/organisations. If your user 'Allows Access' to multiple organisations, be hyper aware of which tenantId you are passing to each function.
Step 1: Initialize the XeroClient, and redirect user to xero auth flow
Step 2: Call apiCallback to get your tokenSet
Step 3: Call updateTenants to populate additional tenant data
You will need to have the accounting.settings scope in order to use this helper
NOTE: If you have already authorized the user and have stored a valid tokenSet, you can create a new XeroClient() and refresh your token without triggering the openid-client dependency:
const tokenSet = getTokenSetFromUserId(user.id) // example function
const newXeroClient = new XeroClient()
const newTokenSet = await newXeroClient.refreshWithRefreshToken(xero_client_id, xero_client_secret, tokenSet.refresh_token)
// refreshWithRefreshToken calls setAccessToken() so the refreshed token will be stored on newXeroClient
await newXeroClient.accountingApi.getInvoices('my-tenant-uuid')
initialize() the client to set up the 'openid-client'consentUrlconst port = process.env.PORT || 3000
const xero = new XeroClient({
clientId: 'YOUR_CLIENT_ID',
clientSecret: 'YOUR_CLIENT_SECRET',
redirectUris: [`http://localhost:${port}/callback`],
scopes: 'openid profile email accounting.transactions offline_access'.split(" "),
state: 'returnPage=my-sweet-dashboard', // custom params (optional)
httpTimeout: 3000 // ms (optional)
});
// `buildConsentUrl()` will also call `await xero.initialize()`
let consentUrl = await xero.buildConsentUrl();
res.redirect(consentUrl);
Call apiCallback function with the response url which returns a tokenSet you can save in your datastore for future calls.
The tokenSet can also be accessed from the client as xero.readTokenSet().
http://localhost:${port}/callback
console.log(xero.config.state)
=> 'returnPage=my-sweet-dashboard'
const tokenSet = await xero.apiCallback(req.url);
The tokenSet is what you should store in your database. That object is what you will need to pass to the client. It contains your access_token and refresh_token as well as other information regarding your connection.
{
id_token: 'eyJhxxxx.yyy',
access_token: 'eyJxxx.yyy.zzz',
expires_at: 1231231234,
token_type: 'Bearer',
refresh_token: 'xxxyyyyzzz',
scope: 'openid profile email accounting.settings accounting.reports.read accounting.journals.read accounting.contacts accounting.attachments accounting.transactions offline_access',
session_state: 'xxx.yyy'
}
Populate the XeroClient's active tenant data.
For most integrations you will want to display the org name and use additional metadata about the connected org. The /connections endpoint does not currently serialize all org metadata so requires developers to make an additional call for each org your user connects to get information like default currency.
Calling await xero.updateTenants() will query the /connections endpoint and store the resulting information on the client. It has an optional parameter named fullOrgDetails that defaults to true. If you do not pass false to this function you will need to have the accounting.settings scope on your token as the /organisation endpoint that is called, requires it.
If you don't need additional org data (like currency, shortCode, etc) calling the helper with false param await xero.updateTenants(false) will not kick off additional org meta data calls.
// updateTenants fullOrgDetails param will default to true
const tenants = await xero.updateTenants()
console.log(xero.tenants)
[
{
id: 'xxx-yyy-zzz-xxx-yyy',
tenantId: 'xxx-yyy-zzz-xxx-yyy',
tenantType: 'ORGANISATION',
createdDateUtc: 'UTC-DateString',
updatedDateUtc: 'UTC-DateString',
tenantName: 'Demo Company (US)',
orgData: {
organisationID: 'xxx-yyy-zzz-xxx-yyy',
name: 'My first org',
version: 'US',
shortCode: '!2h37s',
...
}
}
]
// if you pass false, the client will not fetch additional metadata about each org connection
const tenants = await xero.updateTenants(false)
console.log(xero.tenants)
[
{
id: 'xxx-yyy-zzz-xxx-yyy',
tenantId: 'xxx-yyy-zzz-xxx-yyy',
tenantType: 'ORGANISATION',
createdDateUtc: 'UTC-DateString',
updatedDateUtc: 'UTC-DateString',
tenantName: 'Demo Company (US)'
}
]
// You can also remove a connection by passing `disconnect()` the `.id` which is that tenant's connection id.
await xero.disconnect(xero.tenants[0].id)
Once you have a valid token/tokenSet saved you can set the tokenSet on the client without going through the callback by calling setTokenSet.
For example - once a user authenticates you can refresh the token (which will also set the new token on the client) to make authorized api calls.
There are two ways to refresh a token.
// refreshToken()
const validTokenSet = await xero.refreshToken()
If you already generated a valid access token, you can initialize an empty client and refresh any saved access_tokens by passing the client, secret, and refresh_token to refreshWithRefreshToken()
const newXeroClient = new XeroClient()
const refreshedTokenSet = await newXeroClient.refreshWithRefreshToken(client_id, client_secret, tokenSet.refresh_token)
Making Authorized API calls:
const tokenSet = getTokenSetFromDatabase(userId) // example function name
await xero.setTokenSet(tokenSet)
// you can call this to fetch/set your connected tenant data on your client, or you could also store this information in a database so you don't need to updateTenants every time you connect to API
await xero.updateTenants()
await xero.accountingApi.getInvoices(xero.tenants[0].tenantId)
// example flow of initializing and using the client after someone has already authenticated and you have saved their tokenSet
const xero = new XeroClient({
clientId: 'YOUR_CLIENT_ID',
clientSecret: 'YOUR_CLIENT_SECRET',
redirectUris: [`http://localhost:${port}/callback`],
scopes: 'openid profile email accounting.transactions offline_access'.split(" ")
});
await xero.initialize();
const tokenSet = getYourTokenSetFromSavedLocation(currentUser)
await xero.setTokenSet(tokenSet)
...
const activeTenantId = xero.tenants[0].tenantId
const getOrgs = await xero.accountingApi.getOrganisations(activeTenantId)
const orgCountry= getOrgs.body.organisations[0].countryCode
const contactsResponse = await xero.accountingApi.getContacts(activeTenantId)
const contactId = getContactsResponse.body.contacts[0].contactID
---
import { XeroClient, Invoice } from "xero-node";
const invoices = {
invoices: [
{
type: Invoice.TypeEnum.ACCREC,
contact: {
contactID: contactId
},
lineItems: [
{
description: "Acme Tires",
quantity: 2.0,
unitAmount: 20.0,
accountCode: "500",
taxType: "NONE",
lineAmount: 40.0
}
],
date: "2019-03-11",
dueDate: "2018-12-10",
reference: "Website Design",
status: Invoice.StatusEnum.AUTHORISED
}
]
};
const createdInvoice = await xero.accountingApi.createInvoices(activeTenantId, invoices)
---
// getting files as PDF
const getAsPdf = await xero.accountingApi.getPurchaseOrderAsPdf(
req.session.activeTenant.tenantId,
getPurchaseOrdersResponse.body.purchaseOrders[0].purchaseOrderID,
{ headers: { accept: 'application/pdf' } }
)
// CREATE ATTACHMENT
const filename = "xero-dev.png";
const pathToUpload = path.resolve(__dirname, "../public/images/xero-dev.png");
const readStream = fs.createReadStream(pathToUpload);
const contentType = mime.lookup(filename);
const accountAttachmentsResponse: any = await xero.accountingApi.createAccountAttachmentByFileName(req.session.activeTenant.tenantId, accountId, filename, readStream, {
headers: {
'Content-Type': contentType
}
});
// UPLOAD A FILE
import * as fs from "fs";
const mime = require("mime-types");
const path = require("path");
const tenantId = 'valid-xero-tenant-id-uuid'
const folderId = 'valid-folder-uuid-goes-here'
const filename = "xero-dev.png";
const pathToUpload = path.resolve(__dirname, "../public/images/xero-dev.png");
const readStream = fs.createReadStream(pathToUpload);
const contentType = mime.lookup(filename);
const uploadFile = await xero.filesApi.uploadFile(tenantId, folderId, readStream, filename, contentType);
const xeroTenantId = 'YOUR_XERO_TENANT_ID';
const ifModifiedSince: Date = new Date("2020-02-06T12:17:43.202-08:00");
const where = 'Status=="AUTHORISED" AND Type=="SPEND"';
const order = 'Reference ASC';
const page = 1;
const unitdp = 4;
const response = await xero.accountingApi.getBankTransactions(xeroTenantId, ifModifiedSince, where, order, page, unitdp);
// Configure the XeroClient including a state param.
const xero = new XeroClient({
clientId: client_id,
clientSecret: client_secret,
redirectUris: [redirectUrl],
scopes: scopes.split(" "),
state: "imaParam=look-at-me-go",
httpTimeout: 2000
});
// When xero.buildConsentUrl is called, xero-node calls openid-client authorizationUrl method, passing redirect_uri, scope, and state (if present) as arguments and returns a formatted url string made from the params. The user can be directed to the consentUrl to begin the auth process with Xero. When the auth process is complete Xero redirects the user to the specified callback route and passes along params including state if it was initially provided.
public async buildConsentUrl(): Promise<string> {
await this.initialize();
let url;
if (this.config) {
url = this.openIdClient.authorizationUrl({
redirect_uri: this.config.redirectUris[0],
scope: this.config.scopes.join(' ') || 'openid email profile',
state: this.config.state
});
}
return url;
}
// When xero.apiCallback is called with the callback url, it passes in the url string that Xero redirected to as an argument to openid-client callbackParams method, which parses the url into a params object. IMPORTANT NOTE: see how at this step a check object is created with a state property equal to the XeroClient config state. At this point openid-client takes over verifying params.state and check.state match if provided.
public async apiCallback(callbackUrl: string): Promise<TokenSet> {
const params = this.openIdClient.callbackParams(callbackUrl);
const check = { state: this.config.state };
console.log('params ', params);
console.log('check ', check)
if (this.config.scopes.includes('openid')) {
this._tokenSet = await this.openIdClient.callback(this.config.redirectUris[0], params, check);
} else {
this._tokenSet = await this.openIdClient.oauthCallback(this.config.redirectUris[0], params, check);
}
this.setAccessToken();
return this._tokenSet;
}
// params {
// code: 'c371cae7d94ca3cde3bcee64a2efb0897e6b76eacd687e86d63da93f6a17ef2a',
// state: 'imaParam=look-at-me-go',
// session_state: '1Vi40jJJ5ThQyjvN6LaZZs33woGsKBYuEMvMDRDxamc.854c0568ee3b2f7e2866558069609814'
// }
// check { state: 'imaParam=look-at-me-go' }
// If the callback url state param is different from the XeroClient config state or missing, like so:
public async apiCallback(callbackUrl: string): Promise<TokenSet> {
const params = this.openIdClient.callbackParams(callbackUrl);
params.state = 'imaParam=not-my-state';
const check = { state: this.config.state };
console.log('params ', params);
console.log('check ', check)
if (this.config.scopes.includes('openid')) {
this._tokenSet = await this.openIdClient.callback(this.config.redirectUris[0], params, check);
} else {
this._tokenSet = await this.openIdClient.oauthCallback(this.config.redirectUris[0], params, check);
}
this.setAccessToken();
return this._tokenSet;
}
// params {
// code: 'bb9f5ccf3491a12d747dd2a61b5ef53e453b5c1589b93a8ab4718f55a77ac144',
// state: 'imaParam=not-my-state',
// session_state: 'IPqi3XUI1OOT-rigZBtJSUTYDkcSx9wlepEIHDjcgyU.d6889179353c1738558aa83646afec91'
// }
// check { state: 'imaParam=look-at-me-go' }
// the openid-client library throws an error:
// RPError: state mismatch, expected imaParam=look-at-me-go, got: imaParam=not-my-state
For a deeper dive into openid-client functionality, check out the repo https://github.com/panva/node-openid-client.
// JWT verification is baked into the openid-client library
// When xero.apiCallback is called, either openid-client callback or oauthCallback method is called to retrieve a TokenSet
public async apiCallback(callbackUrl: string): Promise<TokenSet> {
const params = this.openIdClient.callbackParams(callbackUrl);
const check = { state: this.config.state };
if (this.config.scopes.includes('openid')) {
this._tokenSet = await this.openIdClient.callback(this.config.redirectUris[0], params, check);
} else {
this._tokenSet = await this.openIdClient.oauthCallback(this.config.redirectUris[0], params, check);
}
this.setAccessToken();
return this._tokenSet;
}
// Both the callback and oauthCallback methods call openid-client validateJARM, which calls validateJWT
async validateJARM(response) {
const expectedAlg = this.authorization_signed_response_alg;
const { payload } = await this.validateJWT(response, expectedAlg, ['iss', 'exp', 'aud']);
return pickCb(payload);
}
// the TLDR of this code block is that if openid-client fails to validate the JWT signature it will throw and error
async validateJWT(jwt, expectedAlg, required = ['iss', 'sub', 'aud', 'exp', 'iat']) {
const isSelfIssued = this.issuer.issuer === 'https://self-issued.me';
const timestamp = now();
let header;
let payload;
try {
({ header, payload } = jose.JWT.decode(jwt, { complete: true }));
} catch (err) {
throw new RPError({
printf: ['failed to decode JWT (%s: %s)', err.name, err.message],
jwt,
});
}
if (header.alg !== expectedAlg) {
throw new RPError({
printf: ['unexpected JWT alg received, expected %s, got: %s', expectedAlg, header.alg],
jwt,
});
}
if (isSelfIssued) {
required = [...required, 'sub_jwk']; // eslint-disable-line no-param-reassign
}
required.forEach(verifyPresence.bind(undefined, payload, jwt));
if (payload.iss !== undefined) {
let expectedIss = this.issuer.issuer;
if (aadIssValidation) {
expectedIss = this.issuer.issuer.replace('{tenantid}', payload.tid);
}
if (payload.iss !== expectedIss) {
throw new RPError({
printf: ['unexpected iss value, expected %s, got: %s', expectedIss, payload.iss],
jwt,
});
}
}
if (payload.iat !== undefined) {
if (!Number.isInteger(payload.iat)) {
throw new RPError({
message: 'JWT iat claim must be a JSON number integer',
jwt,
});
}
}
if (payload.nbf !== undefined) {
if (!Number.isInteger(payload.nbf)) {
throw new RPError({
message: 'JWT nbf claim must be a JSON number integer',
jwt,
});
}
if (payload.nbf > timestamp + this[CLOCK_TOLERANCE]) {
throw new RPError({
printf: ['JWT not active yet, now %i, nbf %i', timestamp + this[CLOCK_TOLERANCE], payload.nbf],
jwt,
});
}
}
if (payload.exp !== undefined) {
if (!Number.isInteger(payload.exp)) {
throw new RPError({
message: 'JWT exp claim must be a JSON number integer',
jwt,
});
}
if (timestamp - this[CLOCK_TOLERANCE] >= payload.exp) {
throw new RPError({
printf: ['JWT expired, now %i, exp %i', timestamp - this[CLOCK_TOLERANCE], payload.exp],
jwt,
});
}
}
if (payload.aud !== undefined) {
if (Array.isArray(payload.aud)) {
if (payload.aud.length > 1 && !payload.azp) {
throw new RPError({
message: 'missing required JWT property azp',
jwt,
});
}
if (!payload.aud.includes(this.client_id)) {
throw new RPError({
printf: ['aud is missing the client_id, expected %s to be included in %j', this.client_id, payload.aud],
jwt,
});
}
} else if (payload.aud !== this.client_id) {
throw new RPError({
printf: ['aud mismatch, expected %s, got: %s', this.client_id, payload.aud],
jwt,
});
}
}
if (payload.azp !== undefined && payload.azp !== this.client_id) {
throw new RPError({
printf: ['azp must be the client_id, expected %s, got: %s', this.client_id, payload.azp],
jwt,
});
}
let key;
if (isSelfIssued) {
try {
assert(isPlainObject(payload.sub_jwk));
key = jose.JWK.asKey(payload.sub_jwk);
assert.equal(key.type, 'public');
} catch (err) {
throw new RPError({
message: 'failed to use sub_jwk claim as an asymmetric JSON Web Key',
jwt,
});
}
if (key.thumbprint !== payload.sub) {
throw new RPError({
message: 'failed to match the subject with sub_jwk',
jwt,
});
}
} else if (header.alg.startsWith('HS')) {
key = await this.joseSecret();
} else if (header.alg !== 'none') {
key = await this.issuer.queryKeyStore(header);
}
if (!key && header.alg === 'none') {
return { protected: header, payload };
}
try {
return jose.JWS.verify(jwt, key, { complete: true });
} catch (err) {
throw new RPError({
message: 'failed to validate JWT signature',
jwt,
});
}
}
For a deeper dive into openid-client functionality, check out the repo https://github.com/panva/node-openid-client.
For more robust examples in how to utilize our accounting api we have (roughly) every single endpoint mapped out with an example in our sample app - complete with showing the Xero data dependencies required for interaction with many objects ( ie. types, assoc. accounts, tax types, date formats).
Just visit the repo https://github.com/XeroAPI/xero-node-oauth2-app configure your credentials & get started.
xero.tenants
// This needs to be called to setup relevant openid-client on the XeroClient
await xero.initialize()
// buildConsentUrl calls `await xero.initialize()` so if you wont't need to call initialize() if your using the client to send user through the auth flow.
await xero.buildConsentUrl()
// tokenSet and its expiration
const tokenSet = await xero.readTokenSet();
tokenSet.expired() // returns boolean true/false
tokenSet.expires_in // returns seconds
tokenSet.expires_at // returns milliseconds
new Date(tokenSet.expires_at * 1000).toLocaleString()) // readable expiration
if (tokenSet.expired()) {
const validTokenSet = await xero.refreshToken()
// or you can refresh the token without needing to initialize the openid-client
// helpful for background processes where you want to limit any dependencies
await xero.refreshWithRefreshToken(client_id, client_secret, tokenSet.refresh_token)
}
// some endpoints date fields require
// the MS date format for POST'ing data
const dateString = "1990-02-05"
const birthday = await xero.formatMsDate(dateString)
await xero.disconnect(xero.tenants[0].id)
await xero.readIdTokenClaims()
await xero.readTokenSet()
const tokenSet = await xero.readTokenSet()
await xero.setTokenSet(tokenSet)
// You can revoke a user's refresh token and remove all their connections to your app by making a request to the revocation endpoint.
await xero.revokeToken()
FAQs
Xero NodeJS OAuth 2.0 client for xero-node
The npm package xero-node receives a total of 55,081 weekly downloads. As such, xero-node popularity was classified as popular.
We found that xero-node demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.