Skip to main content

Get started with Sync for Payables

View the core steps required to perform the initial setup for Sync for Payables

Journey overview

The diagram below represents the overall activity flow when using Sync for Payables. You can manage bills, suppliers, and payment methods in different ways and order.

We will take you through each of these elements so that you can build the flow that suits you and your customers best.

Accounts payable process flow including customer steps

Once you decide to build with Sync for Payables, you need to configure Codat accordingly. Let's go through these requirements in detail.

Enable Sync for Payables

  1. Open the Codat Portal and sign in.
  2. Click on Settings > Organizational settings > Products.
  3. In the list of products, find Sync for Payables and click Enable. Then, follow the on-screen prompt.

Configure Sync for Payables

Data types

In the Codat Portal, navigate to Settings > Integrations > Data types. Enable the data types required for Sync for Payables and set them to fetch on first link:

Data sourceAccounting
Data typesbankAccounts
bills
billCreditNotes
billPayments
chartOfAccounts
paymentMethods
suppliers
taxRates
trackingCategories

Configure the solution to refresh data when you need it by setting a synchronization frequency on the same screen. We recommend setting it to a daily or a monthly sync.

Manage data sources

In the Codat Portal, navigate to Settings > Integrations and click Manage integrations. Next, click Manage next to the specific integration you want to enable and set it up to serve as a data source for the product.

You can also view detailed configuration instructions by clicking on the relevant tile:

Authorization flow

As part of using Sync for Payables, you will need your customers to authorize your access to their data. To do so, use Link - our pre-built, embeddable, conversion-optimized, and white-labeled authorization flow.

The solution lets you tailor the authorization journey to your business needs. You can:

Webhooks

Codat supports a range of event types you can listen to that help you manage your data pipelines. In the Codat Portal, navigate to Settings > Webhooks > Configure consumer and click Add endpoint to add webhook consumer endpoints and get the most out of Sync for Payables:

  • NewCompanySynchronized

    Listen to this event to track the completion of all enabled data type syncs for a newly connected company. When you receive a message from this webhook, you can proceed to the next steps of the bill pay process.

  • DataSyncCompleted

    This event indicates that a data sync is successfully completed for a specific data type. You can use your webhook consumer to track retrieval of suppliers, bills or bank accounts as part of the accounts payable process.

  • DatasetDataChanged

    If you receive a message from this webhook, it means data has been updated for the specified data type. This can include new, updated or deleted data. You should then refresh the data in your platform.

  • PushOperationStatusChanged

    Listen to this event to track the completion of the operation to pay bills in the SMB's accounting platform. When you receive a message from this webhook, check the status value in the body. A Success status means the bill payment or the bill credit note has been successfully pushed to the accounting software.

Client libraries

Use our comprehensive Sync for Payables library to kick-start and simplify your build. Simply install the library in one of the supported languages and pass your base64-encoded API key to the constructor.

Install

NPM
npm add @codat/sync-for-payables
Yarn
yarn add @codat/sync-for-payables

Initialize

import { CodatSyncPayables } from "@codat/sync-for-payables";

const payablesClient = new CodatSyncPayables({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
Recap

You have enabled Sync for Payables, set up the relevant integrations, configured auth flow parameters, and noted the recommended webhook. This completes the initial setup of the product.

Next, you will create a company and its connection to build out the core infrastructure required to manage accounts payable with Codat.


Was this page useful?
❤️
👍
🤔
👎
😭