How to build an invoicing system with Unified.to
April 8, 2024
When building a SaaS app for invoicing, you'll need to exchange data within your customers' accounting app of choice. In this guide, we'll cover the basics of how to access the data you need for your invoicing app with the help of Unified.to's unified accounting API.
Prerequisites
Before starting, be sure to review our Getting Started with Unified article. It will walk you through registering for a free account and onboarding. Once you have completed the onboarding steps, go ahead and activate as many Accounting integrations as you like.
The next step is to deploy the Unified.to Embedded Authorization widget in your product's user interface (UI). Check out our embedded authorization video tutorial to learn more.
Overview
Here are the steps that you will need to support to build your invoicing app:
- create an invoice
- pay an invoice or cancel an invoice
Let's go into more detail for each.
Step 1: Create an invoice
To generate an invoice, gather specific details from your end user, including essential information like the amount, line items/products, due date, and customer details.
Unified.to can help with two of those values: customer and product.
Customers
To get a list of existing customers from your end user's accounting system, simply call the listCustomers API endpoint.
import { UnifiedTo } from '@unified-api/typescript-sdk';
const sdk = new UnifiedTo({
security: {
jwt: '<YOUR_API_KEY_HERE>',
},
});
export async function getCustomers(connectionId: string) {
return await sdk.accounting.listAccountingContacts({
connectionId,
});
}
The connection_id comes in from your end user's authorization of their accounting app and is stored on your end. You can watch our video tutorials to learn more.
If you need to create a new customer, use our createCustomer API endpoint.
A Customer will have specific fields such as name , emails, billing_address, and tax information that will be relevant to your software. See our API Documentation page for more information.
Products
Much like getting a list of existing customers, it is easy to get a list of existing products in your end user's accounting app using the listItems API endpoint. We call a product, an Item, and you can find the full data-model on our API Documentation page.
import { UnifiedTo } from '@unified-api/typescript-sdk';
const sdk = new UnifiedTo({
security: {
jwt: '<YOUR_API_KEY_HERE>',
},
});
export async function getItems(connectionId: string) {
return await sdk.commerce.listCommerceItems({
connectionId,
});
}
Chart of accounts & tax rates
Each line item in an invoice will be associated with a customer, item, account and tax rate in your end user's accounting application.
You can get a list of accounts by calling our listAccounts API endpoint which returns a list from their "Chart of Accounts".
You can also get a list of tax rates by calling our listTaxrates API endpoint.
Invoices
Once the end user has created an invoice, you will want to send that invoice into their accounting system as well.
This is easily accomplished by using the createInvoice API endpoint.
import { UnifiedTo } from '@unified-api/typescript-sdk';
import { AccountingInvoice } from '@unified-api/typescript-sdk/dist/sdk/models/shared';
const sdk = new UnifiedTo({
security: {
jwt: '<YOUR_API_KEY_HERE>',
},
});
export async function createInvoice(connectionId: string, invoice: AccountingInvoice) {
const result = await sdk.accounting.createAccountingInvoice({
accountingInvoice: invoice,
connectionId,
});
return result.accountingInvoice?.id;
}
Step 2: Paying invoices
Once that invoice is paid, you will need to communicate this to the accounting application. This is accomplished by using the createPayment API endpoint which associates a payment with an invoice.
At a minimum, a Payment will need an invoice_id , a customer_id and an amount. Some integrations may require additional values to be present, so check that integration's feature support page. For example, Quickbooks also requires a currency field.
Conclusion
It's easy to support multiple accounting applications in your invoicing app and allow your end user to seamlessly move data between the two. By using Unitied.to's Unified Accounting API you can add accounting integrations to your product and support your invoicing use case within days.