Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Solutions #1379

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/auth-flow/customize/branding.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,6 @@ Icon requirements:

You can set your brand's primary color to define the color of buttons and other elements within the Link Flow. We recommend using a dark primary color, because light colors may cause accessibility issues.

:::tip Sync flow

This primary color setting also applies to the Sync flow, a journey specific to our [Sync for Commerce](/commerce/overview) product.

:::

<img
src="/img/old/1cef143-branding.PNG"
alt="Branding settings screen with company name, logo, icon, and color picker displayed"
Expand Down
2 changes: 1 addition & 1 deletion docs/auth-flow/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Enhance the auth flow functionality and give your customers the ability to manag

## Supported products

Link is compatible with our entire [product range](/using-the-api/overview#apis) except [Sync for Commerce](/commerce/overview). To set up your Sync for Commerce authorization flow, follow the instructions in our [dedicated documentation](/commerce/overview).
Link is compatible with our entire [product range](/using-the-api/overview#apis).

## Supported integrations

Expand Down
6 changes: 3 additions & 3 deletions docs/bank-feeds/create-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ When implementing your bank feed solution, you need to create your customer as a

You can see how these elements fit together and where they sit in the overall bank feeds process on the diagram below.

![A diagram demonstrating the relationship between various Codat concepts and subsequent steps of the Bank Feeds API process](/img/bank-feeds/bankfeeds-concept-flow.png)
![A diagram demonstrating the relationship between various Codat concepts and subsequent steps of the Bank Feeds process](/img/bank-feeds/bankfeeds-concept-flow.png)

:::tip Authorize your API calls
Remember to [authenticate](/using-the-api/authentication) when making calls to our API. Navigate to **Developers > API keys** in the Portal to pick up your authorization header.
:::

## Create a company

Within Bank Feeds API, a company represents your SMB customer that wishes to export their transactions from your application to their accounting software.
Within Bank Feeds, a company represents your SMB customer that wishes to export their transactions from your application to their accounting software.

Use the [Create company](/bank-feeds-api#/operations/create-company) endpoint to represent your customer in Codat.
Make sure to store the company ID as you will use it to establish a connection to an accounting software.
Expand Down Expand Up @@ -571,7 +571,7 @@ res, err := bankFeedsClient.SourceAccounts.Delete(ctx, operations.DeleteSourceAc

:::tip Recap

You have created the structure of key objects required by Codat's Bank Feeds API: a company, its connection to an accounting data source, and a source account.
You have created the structure of key objects required by Codat's Bank Feeds product: a company, its connection to an accounting data source, and a source account.

Next, provide your customer with a **mapping** process interface so they can associate the source account with a target account in their accounting software.
:::
Expand Down
6 changes: 3 additions & 3 deletions docs/bank-feeds/guides/bank-feeds-tutorial.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: "Bank transactions reconciliation with QBO Bank Feeds"
description: "Example-based tutorial on reconciling bank transactions with QuickBooks Online using Codat's Bank Feeds API"
description: "Example-based tutorial on reconciling bank transactions with QuickBooks Online using Codat's Bank Feeds"
displayed_sidebar: "bankfeeds"
image: "/img/banners/social/bankfeeds.png"
hide_title: true
hide_description: true
sidebar_label: "Build a bank feed to QBO"
banner_title: Bank Feeds API for bank transaction reconciliation in QBO
banner_title: Bank Feeds for bank transaction reconciliation in QBO
banner_image: "/img/banners/bank-feeds.png"
banner_text: "Example-based tutorial on reconciling bank transactions with QuickBooks Online using Codat's Bank Feeds API"
banner_text: "Example-based tutorial on reconciling bank transactions with QuickBooks Online using Codat's Bank Feeds product"
---

import Tabs from '@theme/Tabs';
Expand Down
30 changes: 15 additions & 15 deletions docs/bank-feeds/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: "Bank Feeds API"
title: "Bank Feeds"
description: "Easily deploy an automated bank statement feed into your application to write bank transaction data into your customers' accounting software"
sidebar_label: Bank Feeds API
sidebar_label: Bank Feeds
displayed_sidebar: bankfeeds
image: "/img/banners/social/bankfeeds.png"
hide_title: true
hide_description: true
hide_table_of_contents: true
banner_title: Bank Feeds API
banner_title: Bank Feeds
banner_class: bank-feeds
banner_icon: "/img/logos/products/logo_bankfeeds_clear.svg"
banner_image: "/img/banners/bank-feeds.png"
banner_text: "Easily deploy an automated bank statement feed into your application to write bank transaction data into your customers' accounting software"
video_url: "https://www.youtube.com/embed/QrPiwn3DRJs"
video_text: What is Bank Feeds API?
video_text: What is Bank Feeds?
---

import {IntegrationsList} from '@components/Integrations'
Expand All @@ -22,25 +22,25 @@ import ClientLibraries from '@components/ClientLibraries'
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem"

## What is Bank Feeds API?
## What is Bank Feeds?

**A [bank feed](../terms/bank-feed) is a digital connection between a financial institution and an accounting software that performs an automatic regular transfer of bank statements into the software.**

Leverage our **Bank Feeds API** to simplify the deployment of bank feeds in your application. It creates the associated infrastructure for you and automates the upload of bank statements into accounting software used by your small and medium-sized business (SMB) customers.
Leverage our **Bank Feeds** product to simplify the deployment of bank feeds in your application. It creates the associated infrastructure for you and automates the upload of bank statements into accounting software used by your small and medium-sized business (SMB) customers.

## Who is it for?

Our Bank Feeds API makes it easy for banks, neobanks, corporate card issuers, and payment providers to ensure customers can access their bank transaction data within their accounting software.
Our Bank Feeds product makes it easy for banks, neobanks, corporate card issuers, and payment providers to ensure customers can access their bank transaction data within their accounting software.

As a result, your customers enjoy a more complete and simplified accounting experience, save time closing their books, and further reduce manual error without requiring third-party middleware or manual file uploads.

## Why use it?

A recent survey revealed that [71% of Xero partners](https://www.xero.com/blog/2019/01/new-bank-feeds-process/) identify [bank feeds](../terms/bank-feed) and bank transaction reconciliation as their most valued features. With Bank Feeds API, you can easily meet this demand.
A recent survey revealed that [71% of Xero partners](https://www.xero.com/blog/2019/01/new-bank-feeds-process/) identify [bank feeds](../terms/bank-feed) and bank transaction reconciliation as their most valued features. With Bank Feeds, you can easily meet this demand.

Leverage our coverage of the most popular accounting software and remove barriers to product adoption, increasing customer retention and elevating their experience with your app as a result.

#### With Bank Feeds API, you can:
#### With Bank Feeds, you can:

<ul className="card-container col-3">
<li className="card">
Expand Down Expand Up @@ -83,9 +83,9 @@ Leverage our coverage of the most popular accounting software and remove barrier

## How does it work?

Bank Feeds API supports your build through all the key stages of establishing a bank feed and using it to automatically upload bank statements to your SMBs' accounting software.
Bank Feeds supports your build through all the key stages of establishing a bank feed and using it to automatically upload bank statements to your SMBs' accounting software.

![A diagram of the data flow in the Bank Feeds API product](/img/bank-feeds/bankfeeds-process-flow.png)
![A diagram of the data flow in the Bank Feeds product](/img/bank-feeds/bankfeeds-process-flow.png)

### [Configure customer](/bank-feeds/create-account)

Expand All @@ -95,19 +95,19 @@ At the same time, you will also create additional Codat infrastructure elements,

### [Establish bank feed](/bank-feeds/mapping/overview)

Next, you will enable your SMB customer to let you connect to their accounting software. They will authorize that connection via our [auth flow](/auth-flow/overview), which you will implement when building with Bank Feeds API.
Next, you will enable your SMB customer to let you connect to their accounting software. They will authorize that connection via our [auth flow](/auth-flow/overview), which you will implement when building with Bank Feeds.

Then, provide your user with a UI so they can select the target accounts in that platform. This will tell Codat where exactly to establish a bank feed. Depending on your customer's software, there are [three methods](/bank-feeds/mapping/overview) you can use for mapping: Codat's UI, your own UI, or the integration's UI.

:::note Platform requirements
The setup process and platform registration requirements vary for each Bank Feeds API integration. For detailed instructions, refer to the documentation we provide for each integration.
The setup process and platform registration requirements vary for each Bank Feeds integration. For detailed instructions, refer to the documentation we provide for each integration.
:::

### [Import transactions](/bank-feeds/pushing-transactions)

Once your SMB customer completes the authorization and account mapping process, you can begin the automatic upload of bank statements by writing transactions into the target bank account on the accounting software.

![A mock reconciliation view of an accounting software when Bank Feeds API is used](/img/bank-feeds/bankfeeds-reconciliation-view.png)
![A mock reconciliation view of an accounting software when Bank Feeds is used](/img/bank-feeds/bankfeeds-reconciliation-view.png)

## Supported integrations
<br/>
Expand All @@ -125,4 +125,4 @@ The SDKs come in multiple languages and provide sample requests and responses fo

## Read next

* [Start](/bank-feeds/setup) building with our Bank Feeds API
* [Start](/bank-feeds/setup) building with our Bank Feeds product
22 changes: 11 additions & 11 deletions docs/bank-feeds/setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get started with Bank Feeds API"
description: "Understand the basics of using Bank Feeds API and learn how to perform the initial setup for the product"
title: "Get started with Bank Feeds"
description: "Understand the basics of using the Bank Feeds product and learn how to perform the initial setup for the product"
sidebar_label: Get started
displayed_sidebar: bankfeeds
---
Expand All @@ -12,7 +12,7 @@ import {bankfeedsExternalMappingIntegrations, bankfeedsIntegrations} from '@comp

## Journey overview

The diagram below represents the overall activity flow when using Bank Feeds API, including your SMB customer and their accounting software. It assumes you are using Codat's mapping interface to let the user select the accounts used for writing bank statements.
The diagram below represents the overall activity flow when using Bank Feeds, including your SMB customer and their accounting software. It assumes you are using Codat's mapping interface to let the user select the accounts used for writing bank statements.

If you are using one of the [other mapping UI options](/bank-feeds/mapping/overview), you can visualize the flow by simply changing the actor of the mapping operation from `Codat` to `Your application` or `Accounting software`.

Expand Down Expand Up @@ -45,23 +45,23 @@ sequenceDiagram

```

Once you decide to build this flow with Bank Feeds API, you need to configure Codat accordingly. Let's go through these requirements in detail.
Once you decide to build this flow with Bank Feeds, you need to configure Codat accordingly. Let's go through these requirements in detail.

## Enable Bank Feeds API
## Enable Bank Feeds

Reach out to your Codat account manager to enable Bank Feeds API for your client.
Reach out to your Codat account manager to enable Bank Feeds for your client.

## Manage data sources

In the <a href="https://app.codat.io" target="_blank">Codat Portal</a>, 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.

<IntegrationsList integrations={bankfeedsIntegrations}/>

Some of these integrations require additional setup specific to bank feeds. We walk you through these in our integration-specific instructions in the _Manage integrations_ section of our Bank Feeds API documentation.
Some of these integrations require additional setup specific to bank feeds. We walk you through these in our integration-specific instructions in the _Manage integrations_ section of our Bank Feeds documentation.

## Authorization flow

As part of using Bank Feeds API, you will need your customers to authorize your access to their data. To do so, use [Link](/auth-flow/authorize-embedded-link) - our pre-built, embeddable, conversion-optimized, and white-labeled authorization flow.
As part of using Bank Feeds, you will need your customers to authorize your access to their data. To do so, use [Link](/auth-flow/authorize-embedded-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:

Expand All @@ -71,7 +71,7 @@ The solution lets you tailor the authorization journey to your business needs. Y

## Webhooks

Codat supports a range of [webhook events](/using-the-api/webhooks/event-types) to help you manage your data pipelines. In the <a href="https://app.codat.io" target="_blank">Codat Portal</a>, navigate to **Settings > Webhooks > Configure consumer** and click **Add endpoint** to set up an endpoint to listen to the following event type and get the most out of Bank Feeds API:
Codat supports a range of [webhook events](/using-the-api/webhooks/event-types) to help you manage your data pipelines. In the <a href="https://app.codat.io" target="_blank">Codat Portal</a>, navigate to **Settings > Webhooks > Configure consumer** and click **Add endpoint** to set up an endpoint to listen to the following event type and get the most out of Bank Feeds:

- [PushOperationStatusChanged](/using-the-api/webhooks/event-types)

Expand All @@ -80,7 +80,7 @@ Codat supports a range of [webhook events](/using-the-api/webhooks/event-types)

## Client libraries

Use our comprehensive [Bank Feeds API library](/get-started/libraries) to kick-start and simplify your build.
Use our comprehensive [Bank Feeds library](/get-started/libraries) 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.

<Tabs>
Expand Down Expand Up @@ -194,7 +194,7 @@ func main() {

:::tip Recap

You have enabled Bank Feeds API, set up the relevant integrations, configured auth flow parameters, and noted the recommended webhook. This completes the initial setup of the product.
You have enabled Bank Feeds, 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 Codat [company](../terms/company), its [connection](../terms/connection), and a source bank account to build out the core infrastructure required to establish a bank feed.

Expand Down
3 changes: 2 additions & 1 deletion docs/bank-feeds/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Troubleshooting and FAQ"
description: "Commonly asked questions and troubleshooting advice for Bank Feeds API"
sidebar_label: Resolve issues
description: "Commonly asked questions and troubleshooting advice for the Bank Feeds product"
displayed_sidebar: bankfeeds
image: "/img/banners/social/bankfeeds.png"
---
Expand Down
14 changes: 0 additions & 14 deletions docs/commerce/coming-soon.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/commerce/learn/monitoring-a-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,6 @@ You can also navigate to the **Config** tab to view and download the customer's
alt="Detailed view of a sync log entry with Summary, Config, and Push Items tabs"
/>

:::caution View and retry write items

At this time, it is possible to view and retry failed push items for **Sync for Expenses only**.

:::

## View push items

In the same detailed record view, select the **Push items** tab to access a list of **push items**. The list contains an item for each accounting data type that was produced in the selected sync (for example, an item for invoices, or credit notes).
Expand Down
2 changes: 1 addition & 1 deletion docs/core-concepts/data-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:

In Codat, each type of data you want to create, update, or retrieve for a given company from a data source is represented by a data type. It has a defined schema with known properties and validation rules.

The data types you use will depend on the Codat product you use. For reference, our [Lending API](/lending/data-types) offers the broadest range of data types.
The data types you use will depend on the Codat product you use. For reference, our [Lending](/lending/data-types) product offers the broadest range of data types.

## Data types based on source

Expand Down
8 changes: 4 additions & 4 deletions docs/expenses/config-and-categorize.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Map customer transactions"
description: Map accounts, suppliers, and customers to create transactions using the Sync for Expenses product
description: Map accounts, suppliers, and customers to create transactions using the Expenses product
sidebar_label: Map transactions
tags: [syncforexpense, mappingOptions, Config]
---
Expand Down Expand Up @@ -32,7 +32,7 @@ Your customers should be able set a bank account, customer, and supplier for eac
}
```

If your customer doesn't provide these values on the transaction itself, Sync for Expenses will use default values you configure for the company as a fallback.
If your customer doesn't provide these values on the transaction itself, Expenses will use default values you configure for the company as a fallback.

:::caution Default and mandatory values

Expand All @@ -59,7 +59,7 @@ POST https://api.codat.io/companies/{companyId}/sync/expenses/config
}
}
```
If a configuration is set for a company, but the customer sets a bank account, supplier, and customer value on the expense transaction level, Sync for Expenses will use the values from the trasaction when creating the expense in the accounting software.
If a configuration is set for a company, but the customer sets a bank account, supplier, and customer value on the expense transaction level, Expenses will use the values from the transaction when creating the expense in the accounting software.

:::caution Suppliers in Microsoft Dynamics

Expand Down Expand Up @@ -252,7 +252,7 @@ In some cases, your customers might not need to track tax on expenses. We recomm

### Refresh mapping options

The default [sync settings](/expenses/getting-started#data-types) set for Sync for Expenses' data types will refresh the mapping options on an daily basis, however, you can also refresh the options manually by making a request to the [Mapping options](/sync-for-expenses-api#/operations/get-mapping-options) endpoint.
The default [sync settings](/expenses/getting-started#data-types) set for the product's data types will refresh the mapping options on an daily basis, however, you can also refresh the options manually by making a request to the [Mapping options](/sync-for-expenses-api#/operations/get-mapping-options) endpoint.

``` http
POST https://api.codat.io/companies/{companyId}/data/all
Expand Down
Loading