Abound Node.js Library

The Abound Node library provides convenient access to the Abound API from applications written in server-side JavaScript.

Documentation

The Abound Node SDK supports all Abound API endpoints. See the API Documentation and the API Reference for complete information about the APIs.

Requirements

You can start to integrate the Abound Node library into your solution as soon as you create an account with Abound and obtain your API keys.

Installation

Install the SDK with npm or yarn:

npm install @withabound/node-sdk --save

yarn add @withabound/node-sdk

Usage

The Abound client must be configured with your account's appId and appSecret, which are available on the Keys page of the Abound Dashboard.

Every method returns a promise which can either be chained or handled via async/await.

import Abound, { Environment } from "@withabound/node-sdk";

const abound = new Abound({
  appId: "appId_f2d...",
  appSecret: "appSecret_bf3...",
  environment: Environment.SANDBOX, // or Environment.PRODUCTION
  apiVersion: "v2",
});

(async () => {
  const user = await abound.users.create({
    email: "user1@example.com",
  });

  console.log(user.data.userId);
})();

// or

abound.users
  .create({
    email: "user1@example.com",
  })
  .then((user) => console.log(user.data.userId))
  .catch((error) => console.error(error));

Examples

Users

Create a User:

const response = await abound.users.create({
  email: "jane.doe@example.com",
  profile: {
    firstName: "Jane",
    lastName: "Doe",
    address: "123 Maple Street",
    address2: "Apt #123",
    city: "Anytown",
    state: "PA",
    zipcode: "17101",
    phoneNumber: "5555555555",
    dateOfBirth: "1989-05-01",
    socialSecurityNumber: "123456789",
  },
});

console.log(response.data.userId);

List Users:

const response = await abound.users.list();

console.log(response.data); // list of Users

Retrieve a User:

const userId = "userId_506...";

const response = await abound.users.retrieve(userId);

console.log(response.data.userId);

Update a User:

const userId = "userId_506...";
const userUpdates = {
  email: "janedoe123@example.com",
  profile: {
    phoneNumber: "4444444444",
  },
};

const response = await abound.users.update(userId, userUpdates);

console.log(response.data.email);

Expenses

Create Expenses:

import { ExpenseType } from "@withabound/node-sdk";

const userId = "userId_506...";
const expense = {
  amount: 139.99,
  description: "Tax Filing Fee",
  date: "2021-01-16",
  expenseType: ExpenseType.BUSINESS,
};

const response = await abound.expenses.create(userId, [
  expense,
  // ...additional expenses
]);

List Expenses for a User:

const userId = "userId_506...";

const response = await abound.expenses.list(userId);

// filter Expenses by year:

const response = await abound.expenses.list(userId, {
  year: "2020",
});

console.log(response.data); // list of Expenses

Retrieve an Expense:

const userId = "userId_506...";
const expenseId = "expenseId_65c...";

const response = await abound.expenses.retrieve(userId, expenseId);

console.log(response.data.deductionAmount);

Update an Expense:

const userId = "userId_506...";
const expenseId = "expenseId_65c...";
const expenseUpdates = {
  amount: 249.99,
  description: "Premium Tax Filing Service Fee",
};

const response = await abound.expenses.update(
  userId,
  expenseId,
  expenseUpdates
);

console.log(response.data.deductionAmount);

Delete an Expense:

const userId = "userId_506...";
const expenseId = "expenseId_65c...";

const response = await abound.expenses.delete(userId, expenseId);

console.log(response.data); // {}

Mailings

List Mailings:

const userId = "userId_506...";
const documentId = "documentId_efb...";

const response = await abound.mailings.list(userId, documentId);

console.log(response.data); // list of Mailings

Create a Mailing:

const userId = "userId_506...";
const documentId = "documentId_efb...";

const response = await abound.mailings.create(userId, documentId);

console.log(response.data);

Retrieve a Mailing:

const userId = "userId_506...";
const documentId = "documentId_efb...";
const mailingId = "mailingId_d01...";

const response = await abound.mailings.retrieve(userId, documentId, mailingId);

console.log(response.data);

Delete a Mailing:

const userId = "userId_506...";
const documentId = "documentId_efb...";
const mailingId = "mailingId_d01...";

const response = await abound.mailings.delete(userId, documentId, mailingId);

console.log(response.data); // {}

Mileage

List Mileages:

const userId = "userId_506...";

const response = await abound.mileages.list(userId);

console.log(response.data); // list of Mileages

Create Mileages:

const userId = "userId_506...";
const mileage = {
  distance: 21.1,
  date: "2021-03-14",
  description: "Client visit",
};

const response = await abound.mileages.create(userId, [
  mileage,
  // ...additional mileages
]);

console.log(response.data); // list of Mileages

Retrieve a Mileage:

const userId = "userId_506...";
const mileageId = "mileageId_4af...";

const response = await abound.mileages.retrieve(userId, mileageId);

console.log(response.data.distance);

Update a Mileage:

const userId = "userId_506...";
const mileageId = "mileageId_4af...";

const mileageUpdates = {
  distance: 23.3,
  date: "2021-12-18",
};

const response = await abound.mileages.update(
  userId,
  mileageId,
  mileageUpdates
);

console.log(response.data.distance); // 23.3

Delete a Mileage:

const userId = "userId_506...";
const mileageId = "mileageId_4af...";

const response = await abound.mileages.delete(userId, mileageId);

console.log(response.data); // {}

Payment Methods

Create a PaymentMethod:

import { AccountClass, AccountType } from "@withabound/node-sdk";

const userId = "userId_506...";

const response = await abound.paymentMethods.create(userId, {
  accountNumber: "123456789",
  routingNumber: "44449944",
  accountType: AccountType.BUSINESS,
  accountClass: AccountClass.CHECKING,
});

console.log(response.data.paymentMethodId);

List PaymentMethods for a User:

const userId = "userId_506...";

const response = await abound.paymentMethods.list(userId);

console.log(response.data); // list of PaymentMethods

Retrieve a PaymentMethod:

const userId = "userId_506...";
const paymentMethodId = "paymentMethodId_329...";

const response = await abound.paymentMethods.retrieve(userId, paymentMethodId);

console.log(response.data.displayName);

Tax Payments

Create a TaxPayment:

import { TaxPeriod } from "@withabound/node-sdk";

const userId = "userId_506...";
const paymentMethodId = "paymentMethodId_329...";

const response = await abound.taxPayments.create(userId, {
  paymentMethodId: paymentMethodId,
  year: "2021",
  period: TaxPeriod.Q1,
  amount: 560.87,
});

console.log(response.data.taxPaymentId);

List TaxPayments for a User:

const userId = "userId_506...";

const response = await abound.taxPayments.list(userId);

console.log(response.data); // list of TaxPayments

Retrieve a TaxPayment:

const userId = "userId_506...";
const taxPaymentId = "taxPaymentId_614...";

const response = await abound.taxPayments.retrieve(userId, taxPaymentId);

console.log(response.data.status);

Incomes

Create Incomes:

import { IncomeDocumentType, IncomeType } from "@withabound/node-sdk";

const userId = "userId_506...";

const response = await abound.incomes.create(userId, [
  {
    incomeType: IncomeType.W2,
    amount: 55000,
    date: "2020-12-30",
  },
  {
    incomeType: IncomeType.TEN99,
    amount: 10.85,
    date: "2020-12-15",
    description: "Savings Account interest accrued",
    documentType: IncomeDocumentType.TEN99INT,
  },
]);

console.log(response.data); // list of created Incomes

List Incomes for a User:

import { IncomeType } from "@withabound/node-sdk";

const userId = "userId_506...";

const response = await abound.incomes.list(userId);
// or, filter by incomeType
const response = await abound.incomes.list(userId, {
  incomeType: IncomeType.TEN99,
});

console.log(response.data); // list of Incomes

Retrieve an Income:

const userId = "userId_506...";
const incomeId = "incomeId_8cb...";

const response = await abound.incomes.retrieve(userId, incomeId);

console.log(response.data.amount);

Update an Income:

const userId = "userId_506...";
const incomeId = "incomeId_8cb...";
const incomeUpdates = {
  amount: 57500,
};

const response = await abound.incomes.update(userId, incomeId, incomeUpdates);

console.log(response.data.amount);

Delete an Income:

const userId = "userId_506...";
const incomeId = "incomeId_8cb...";

const response = await abound.incomes.delete(userId, incomeId);

console.log(response.data); // {}

Taxes

List Taxes for a User:

const userId = "userId_506...";

const response = await abound.taxes.list(userId);

console.log(response.data); // list of tax calculations for all years

Retrieve Taxes for a User for a specific year:

const userId = "userId_506...";
const year = "2020";

const response = await abound.taxes.retrieve(userId, year);

console.log(response.data.totalTax);

Calculate Taxes based on the specified adjustments:

const userId = "userId_506...";
const year = "2020";

const taxUpdates = {
  w2Income: 75000,
  mileage: 16500,
};

const response = await abound.taxes.calculate(userId, year, taxUpdates);

console.log(response.data.effectiveTaxRate);

Payers

Create a Payer:

const newPayer = {
  name: "Hooli",
  address: "1401 N Shoreline Blvd",
  address2: "Suite 1",
  city: "Mountain View",
  country: "US",
  phoneNumber: "6501014096",
  state: "CA",
  zipcode: "94043",
};

const response = await abound.payers.create([newPayer]);

console.log(response.data); // list of created Payers

List Payers:

const response = await abound.payers.list();

console.log(response.data); // list of Payers

Retrieve a Payer:

const payerId = "payerId_362...";

const response = await abound.payers.retrieve(payerId);

console.log(response.data.name);

Update a Payer:

const payerId = "payerId_362...";

const payerUpdates = {
  name: "Pied Piper",
  address: "5230 Newell Road",
  city: "Palo Alto",
};

const response = await abound.payers.update(payerId, payerUpdates);

console.log(response.data.name);

Delete a Payer:

const payerId = "payerId_362...";

const response = await abound.payers.delete(payerId);

console.log(response.data); // {}

Documents

Create Documents for a User:

import { DocumentType } from "@withabound/node-sdk";

const userId = "userId_506...";

const accountStatementDocument = {
  type: DocumentType.ACCOUNT_STATEMENT,
  year: 2020,
  beginDate: "2020-01-01",
  endDate: "2020-05-31",
  accountNumber: "123456789",
  summary: {
    beginningBalance: 1234.89,
    endingBalance: 4321.89,
    interestPercentage: 1.23,
    interestAmount: 6.78,
    totalFees: 5.25,
  },
  bank: {
    name: "Bank of America",
    logo: "https://url-to-bank-logo.png",
    address: "1801 16th St Mall",
    city: "Denver",
    state: "CO",
    zipcode: "80202",
    customerService: {
      phoneNumber: "555-555-5555",
      email: "bofa-support@example.com",
      website: "https://www.bankofamerica.com/",
    },
  },
};

const response = await abound.documents.create(userId, [
  accountStatementDocument,
  // additional documents to create
]);

console.log(response.data[0].documentURL);

List all Documents for a User:

const userId = "userId_506...";

const response = await abound.documents.list(userId);
// or, filter by year
const response = await abound.documents.list(userId, { year: "2020" });

console.log(response.data); // list of Documents

Retrieve a Document:

const userId = "userId_506...";
const documentId = "documentId_efb...";

const response = await abound.documents.retrieve(userId, documentId);

console.log(response.data.documentURL);

Tax Categories

Retrieve TaxCategories by tax year:

const year = "2021";

const response = await abound.taxCategories.retrieve(year);

console.log(response.data); // ["Advertising and Marketing", "Car and Truck", etc.]

Development

Run all tests:

npx jest

Run xo:

npx xo

or, run with autofix:

npx xo --fix

Compile:

npm run compile

Install husky:

npx husky install

Publish artifacts locally:

Install yalc with npm or yarn:

npm i yalc -g

yarn global add yalc

Build the SDK:

npm run build

Publish artifacts to local yalc registry:

yalc push

Install the local artifacts:

~/my-project $ yalc add @withabound/node-sdk

npm

@withabound/node-sdk

Abound Node.js Library

Documentation

Requirements

Installation

Usage

Examples

Users

Expenses

Mailings

Mileage

Payment Methods

Tax Payments

Incomes

Taxes

Payers

Documents

Tax Categories

Development

Keywords

Install

Repository

Homepage

Weekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators

@withabound/node-sdk

Abound Node.js Library

Documentation

Requirements

Installation

Usage

Examples

Users

Expenses

Mailings

Mileage

Payment Methods

Tax Payments

Incomes

Taxes

Payers

Documents

Tax Categories

Development

Keywords

Install

Repository

Homepage

DownloadsWeekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators

Weekly Downloads