---
blog/230428-April-Features.md | 8 +++----
blog/230901-new-products.md | 2 +-
docs/auth-flow/customize/set-up-redirects.md | 2 +-
docs/auth-flow/optimize/funnel.md | 2 +-
.../build/sync-for-commerce-prerequisites.md | 10 ++++----
docs/core-concepts/data-type-settings.md | 2 +-
docs/expenses/config-and-categorize.md | 2 +-
docs/expenses/faq.md | 2 +-
docs/get-started/first-steps.md | 2 +-
...dynamics-365-business-central-reference.md | 4 ++--
.../oracle-netsuite-integration-reference.md | 14 +++++------
.../quickbooksonline/faq-quickbooks-online.md | 4 ++--
.../sage-intacct-integration-reference.md | 6 ++---
.../checkpoints-AP-Payments.md | 2 +-
.../checkpoints-app-store.md | 2 +-
docs/integrations/accounting/xero/xero-faq.md | 4 ++--
.../qbo-bank-feeds-push-bank-transactions.md | 8 +++----
.../qbo-bank-feeds/qbo-bank-feeds-setup.md | 2 +-
.../qbo-bank-feeds/qbo-bank-feeds.md | 2 +-
.../sage-bank-feeds/sage-bank-feeds-use.md | 4 ++--
.../example-proxy-requests.md | 2 +-
.../data-integrity/api-data-integrity.md | 24 +++++++++----------
docs/usecases/bill-pay/bills.md | 20 ++++++++--------
docs/usecases/bill-pay/mapping.md | 4 ++--
docs/usecases/bill-pay/overview.md | 2 +-
docs/usecases/bill-pay/payments.md | 8 +++----
.../implementing-a-mapping-page.md | 2 +-
docs/using-the-api/get-data.md | 2 +-
docs/using-the-api/optimizing-api-calls.md | 4 ++--
docs/using-the-api/ordering-results.md | 6 ++---
docs/using-the-api/overview.md | 3 +--
redirects.config.js | 6 -----
32 files changed, 80 insertions(+), 87 deletions(-)
diff --git a/blog/230428-April-Features.md b/blog/230428-April-Features.md
index f1b956a4f7..64b0d76453 100644
--- a/blog/230428-April-Features.md
+++ b/blog/230428-April-Features.md
@@ -31,7 +31,7 @@ This update enables you to view and assign Locations, Customers, and Classes on
By using these fields on Codat's Direct cost model, you can provide companies with valuable insights into their spending patterns across multiple locations and departments, and even individual customer profitability.
-Review the documentation for [creating a direct cost](https://docs.codat.io/accounting-api#/operations/create-direct-cost) and [retrieving a direct cost](https://docs.codat.io/accounting-api#/operations/list-direct-costs)
+Review the documentation for [creating a direct cost](https://docs.codat.io/lending-api#/operations/create-direct-cost) and [retrieving a direct cost](https://docs.codat.io/lending-api#/operations/list-accounting-direct-costs)
## Create journals in Microsoft Dynamics 365 Business Central
@@ -41,7 +41,7 @@ Codat now supports the creation of journal entries in Microsoft Dynamics 365 Bus
This enhancement empowers you to provide this integration to your customers, streamlining use cases such as payroll reconciliation, purchase amortization, loan repayment reconciliation, and more.
-See the [API Reference](https://docs.codat.io/accounting-api#/operations/create-journal-entry) for more information on how to use the POST journal entry endpoint.
+See the [API Reference](https://docs.codat.io/sync-for-payables-api#/operations/create-journal-entry) for more information on how to use the POST journal entry endpoint.
## Increased Coverage of QuickBooks Online Deletion Support
@@ -51,7 +51,7 @@ Codat has added support for the deletion of journal entries, bills, and invoices
This improvement enables you to offer this integration to your customers, simplifying use cases such as reversing erroneous transactions and maintaining accurate financial records.
-See [Delete data from QuickBooks Online](https://docs.codat.io/accounting-api#/operations/delete-journal-entry) for more information on how to use this feature.
+See Delete data from QuickBooks Online for more information on how to use this feature.
## Addition of the QuickBooks Desktop Tracking Object
@@ -69,7 +69,7 @@ We've extended our support for creating refunds for expenses in QuickBooks Onlin
This enhancement lets you facilitate use cases such as refunding an erroneous transaction or representing a returned order, and managing accidental duplicate payments.
-See [Direct cost](https://docs.codat.io/accounting-api#/operations/create-direct-cost) for more information on how to use this feature.
+See [Direct cost](https://docs.codat.io/lending-api#/operations/create-direct-cost) for more information on how to use this feature.
## Integration coverage improvements
diff --git a/blog/230901-new-products.md b/blog/230901-new-products.md
index b0eeb456ba..47d17ef555 100644
--- a/blog/230901-new-products.md
+++ b/blog/230901-new-products.md
@@ -47,7 +47,7 @@ Our products can help you make the most of your customers' consented business da
The API documentation for the products you may be using is available below. These products are not available to new customers from September 4, 2023.
-- [Accounting API](/accounting-api#/)
+- Accounting API
- [Banking API](/banking-api#/)
- [Commerce API](/commerce-api#/)
- [Assess API](/assess-api#/)
diff --git a/docs/auth-flow/customize/set-up-redirects.md b/docs/auth-flow/customize/set-up-redirects.md
index b3fc751a51..e0b98e75a1 100644
--- a/docs/auth-flow/customize/set-up-redirects.md
+++ b/docs/auth-flow/customize/set-up-redirects.md
@@ -65,7 +65,7 @@ https://redirect.site/accounting/?flow=Codat&statuscode=403&errormessage=User%20
| `statusCode` | `200`, `201`, `403`, `500`, `501` | Codat standardizes the status codes returned by the integrations:
**200** = Successful - user's request has been fulfilled.
**201** = No content - successful, but no information about data connection will be available.
_Possible scenario_: A user visits Link with a connection to their accounting source already established, so they do not take any action before exiting the flow.
**403** = Not available.
_Possible scenario_: A user chooses to quit the Link flow before the Linking process is completed.
**501** = Platform not supported.
_Possible scenario_: A user chooses an integration that is not supported by the client. At this point, the client offers them an alternative option outside of the Codat flows.
**500** = Internal Server Error. Codat standardizes any errors which do not fit into one of the above categories to a 500 code - Internal Server Error. |
| `errorMessage` | | Codat standardizes error messages for the status codes. Error messages returned in the redirect will always be mapped with the status codes listed above.
**403** = "User cancelled."
**500** = "Unknown error occurred."
**501** = "Not supported."
**Note**: If you want to use the original error message from the integration, use `statusText`. |
| `statusText` | _String_ | String as it's passed back from the integration. |
-| `data.company.companyName` | _String_ | The name of the connected party within the underlying platform.
This maps to the company name property in the [company info dataset](/accounting-api#/schemas/CompanyDataset). |
+| `data.company.companyName` | _String_ | The name of the connected party within the underlying platform.
This maps to the company name property in the [company info dataset](/lending-api#/schemas/AccountingCompanyInfo). |
:::note Availability of reserved query parameters
At present, the `data.company.companyName` is only supported for the following integrations:
diff --git a/docs/auth-flow/optimize/funnel.md b/docs/auth-flow/optimize/funnel.md
index c1cb7f36d8..3bcffe35a6 100644
--- a/docs/auth-flow/optimize/funnel.md
+++ b/docs/auth-flow/optimize/funnel.md
@@ -40,7 +40,7 @@ Consider showing a positive review from a trusted person, for example, a promine
## ⭐ Automate the population of setup pages with connected company data
-The higher in the funnel a customer connects their data, the more you can automate their onboarding flow by prepopulating [useful company information](/accounting-api#/schemas/CompanyDataset) such as company registration, tax number, addresses, and key contact info or [company annual revenue](/accounting-api#/schemas/balancesheet).
+The higher in the funnel a customer connects their data, the more you can automate their onboarding flow by prepopulating [useful company information](/lending-api#/schemas/AccountingCompanyInfo) such as company registration, tax number, addresses, and key contact info or [company annual revenue](/lending-api#/schemas/AccountingBalanceSheet).
---
diff --git a/docs/commerce/build/sync-for-commerce-prerequisites.md b/docs/commerce/build/sync-for-commerce-prerequisites.md
index 7536a84d3c..97994058ba 100644
--- a/docs/commerce/build/sync-for-commerce-prerequisites.md
+++ b/docs/commerce/build/sync-for-commerce-prerequisites.md
@@ -30,11 +30,11 @@ The following data types are required (and are enabled by default):
#### Accounting
-- [Company info](/accounting-api#/schemas/CompanyDataset)
-- [Accounts](/accounting-api#/schemas/Account)
-- [Tax rates](/accounting-api#/schemas/TaxRates)
-- [Customers](/accounting-api#/schemas/Customers)
-- [Suppliers](/accounting-api#/schemas/Suppliers)
+- [Company info](/lending-api#/schemas/AccountingCompanyInfo)
+- [Accounts](/lending-api#/schemas/AccountingAccount)
+- [Tax rates](/sync-for-payables-api#/schemas/TaxRates)
+- [Customers](/lending-api#/schemas/AccountingCustomers)
+- [Suppliers](/lending-api#/schemas/AccountingSuppliers)
#### Commerce
diff --git a/docs/core-concepts/data-type-settings.md b/docs/core-concepts/data-type-settings.md
index 2e8b8a1c41..2d8158696c 100644
--- a/docs/core-concepts/data-type-settings.md
+++ b/docs/core-concepts/data-type-settings.md
@@ -6,7 +6,7 @@ tags:
- Core concept
---
-A 'data type' is a specific type of data, like an [invoice](/accounting-api#/schemas/Invoice).
+A 'data type' is a specific type of data, like an [invoice](/lending-api#/schemas/AccountingInvoice).
On the Data type settings page in the Codat Portal, you can view current settings for each data type split by integration type, override the default sync settings, and specify the fetch frequency for refreshing datasets. You can also view `dataType` keys for each data type.
diff --git a/docs/expenses/config-and-categorize.md b/docs/expenses/config-and-categorize.md
index 29d4ff475e..dc9c2b8fac 100644
--- a/docs/expenses/config-and-categorize.md
+++ b/docs/expenses/config-and-categorize.md
@@ -73,7 +73,7 @@ A bank account (`bankAccount.id`) is required to show where purchases have been
- To create a new bank account, use the [Create bank account](/sync-for-expenses-api#/operations/create-account) endpoint. You should trigger a data refresh if a new bank account has been created prior to syncing transactions.
-- Use the [List accounts](/accounting-api#/operations/get-account) endpoint to fetch a list of your customer's existing accounts from their accounting software and display these to them.
+- Use the [List accounts](/lending-api#/operations/list-accounting-accounts) endpoint to fetch a list of your customer's existing accounts from their accounting software and display these to them.
You can also use [query parameters](/using-the-api/querying) to narrow down the list of results, for example:
- `query=metadata.isDeleted=false&&isBankAccount=true` returns existing bank accounts.
- `query=metadata.isDeleted=false&&isBankAccount=true&&type=liability` returns existing liability bank accounts, which are used for credit cards.
diff --git a/docs/expenses/faq.md b/docs/expenses/faq.md
index 9d033dfc6d..bfbba6bd4f 100644
--- a/docs/expenses/faq.md
+++ b/docs/expenses/faq.md
@@ -155,7 +155,7 @@ Expenses validates each expense transaction involving foreign currency. We ensur
answer={`
If a transaction has multiple tax components, each component may be calculated based on the original amount separately, and then added together.
Alternatively, primary tax can be calculated on the item cost, and another tax component is added on top of that amount.This is known as compounding. In this case, the effective tax rate is the rate that results in the total amount of tax with compounding when applied to the original amount.
-The totalTaxRate is the total, not compounded, sum of the components of a tax rate. You can read more about this in our API documentation covering tax rates.
+The totalTaxRate is the total, not compounded, sum of the components of a tax rate. You can read more about this in our API documentation covering tax rates.
`}
/>
this feature request on Xero's UserVoice.
+All Items from Xero will have their `itemStatus` mapped as `Unknown` in Codat because an item status is not exposed via Xero's API. If this is a feature you'd like to see made available, please consider voting for this feature request on Xero's UserVoice.
### Can I write discounts to Xero at the invoice level?
@@ -152,7 +152,7 @@ You are unable to write tracking categories that, when they were read, have the
### Can I write batch payments to Xero?
-Yes. To write a batch payment to Xero, you write a [Bill payment](/accounting-api#/operations/post-bill-payment) with multiple line items. Writing a batch payment to Xero will create the following business objects:
+Yes. To write a batch payment to Xero, you write a [Bill payment](/sync-for-payables-api#/operations/create-bill-payment) with multiple line items. Writing a batch payment to Xero will create the following business objects:
- A separate bill payment for each line.
- An account transaction that links the bill payments together.
diff --git a/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-push-bank-transactions.md b/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-push-bank-transactions.md
index 2f202de9cc..0195111e17 100644
--- a/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-push-bank-transactions.md
+++ b/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-push-bank-transactions.md
@@ -10,13 +10,13 @@ Note the following requirements before writing bank transactions to QBO.
## Ordered by cleared on date
-To be written successfully, bank transactions must be cleared (not pending) and have a `clearedOnDate` of the current or prior day. In the [Create bank transactions](/accounting-api#/operations/create-bank-transactions) endpoint, the `clearedOnDate` is set in the `date` field.
+To be written successfully, bank transactions must be cleared (not pending) and have a `clearedOnDate` of the current or prior day. In the [Create bank transactions](/bank-feeds-api#/operations/create-bank-transactions) endpoint, the `clearedOnDate` is set in the `date` field.
Bank transactions must be ordered chronologically (from earliest to latest) by the `clearedOnDate`.
:::caution Cleared on date field names
-The `clearedOnDate` is returned by the [List bank transactions for a bank account](/accounting-api#/operations/list-bank-account-transactions) endpoint. However, when writing transactions with [Create bank transactions](/accounting-api#/operations/create-bank-transactions), you must supply the value of the `clearedOnDate` in the `date` field.
+The `clearedOnDate` is returned by the [List bank transactions for a bank account](/lending-api#/operations/list-accounting-bank-account-transactions) endpoint. However, when writing transactions with [Create bank transactions](/bank-feeds-api#/operations/create-bank-transactions), you must supply the value of the `clearedOnDate` in the `date` field.
:::
@@ -49,7 +49,7 @@ QBO requires that bank transactions are sent from Codat in chronological order.
Make the following requests to the Codat API. All write requests are asynchronous.
-1. Write bank transactions from an SMB user's connected source bank account using the [Create bank transactions](/accounting-api#/operations/create-bank-transactions) endpoint.
+1. Write bank transactions from an SMB user's connected source bank account using the [Create bank transactions](/bank-feeds-api#/operations/create-bank-transactions) endpoint.
```http
POST https://api.codat.io/companies/COMPANY_ID/connections/CONNECTION_ID/push/bankAccounts/ACCOUNT_ID/bankTransactions
@@ -85,7 +85,7 @@ Make the following requests to the Codat API. All write requests are asynchronou
## Transactions reference
-The following table details how each property in the `transactions` array is handled when writing bank transactions to QBO. For more details, see the [Bank account transactions](/accounting-api#/schemas/BankTransactions) data type.
+The following table details how each property in the `transactions` array is handled when writing bank transactions to QBO. For more details, see the [Bank account transactions](/bank-feeds-api#/schemas/BankTransactions) data type.
| **Property in the `transactions` array** | **Status** |
| ---------------------------------------- | ------------------------------------------------ |
diff --git a/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-setup.md b/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-setup.md
index 16dddd8066..1828e10834 100644
--- a/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-setup.md
+++ b/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-setup.md
@@ -12,7 +12,7 @@ Before setting up the integration, make sure that:
- Your Solutions Engineer has provided you with access to the QuickBooks Online Bank Feeds integration.
- SMB users who will connect to QBO Bank Feeds are located in the US and Canada only.
-- In the Codat Portal, you've enabled [Bank accounts](/accounting-api#/schemas/BankAccount) and [Bank transactions](/accounting-api#/schemas/BankTransactions) in your [Data type settings](/core-concepts/data-type-settings).
+- In the Codat Portal, you've enabled [Bank accounts](/lending-api#/schemas/AccountingBankAccount) and [Bank transactions](/bank-feeds-api#/schemas/BankTransactions) in your [Data type settings](/core-concepts/data-type-settings).
- You've customized the QBO Bank Feeds Link UI for your institution.
## Enable the QBO Bank Feeds integration
diff --git a/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds.md b/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds.md
index c411862a12..0590094a87 100644
--- a/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds.md
+++ b/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds.md
@@ -14,7 +14,7 @@ Connecting to QuickBooks Online bank feeds through the integration is only suppo
## Overview
-With our integration, your SMB customers can connect source bank accounts in your application to target accounts QuickBooks Online (QBO) using one-time credentials. You can then write [Bank transactions](/accounting-api#/schemas/BankTransactions) from source accounts to target accounts via Codat.
+With our integration, your SMB customers can connect source bank accounts in your application to target accounts QuickBooks Online (QBO) using one-time credentials. You can then write [Bank transactions](/bank-feeds-api#/schemas/BankTransactions) from source accounts to target accounts via Codat.
SMB users connect their bank accounts using the QBO Bank Feeds Link UI, which is built and hosted by Codat. Then they can view transactions from source accounts as bank feeds in QBO, allowing them to easily reconcile transactions against accounting entries.
diff --git a/docs/integrations/bank-feeds/sage-bank-feeds/sage-bank-feeds-use.md b/docs/integrations/bank-feeds/sage-bank-feeds/sage-bank-feeds-use.md
index 3000c88f61..0ce31484f9 100644
--- a/docs/integrations/bank-feeds/sage-bank-feeds/sage-bank-feeds-use.md
+++ b/docs/integrations/bank-feeds/sage-bank-feeds/sage-bank-feeds-use.md
@@ -48,7 +48,7 @@ The response contains a list of bank accounts with a status of either `pending`
## Write bank transactions from a source bank account
-You can write [Bank transactions](/accounting-api#/schemas/BankTransactions) from `connected` source bank accounts to target accounts in supported Sage products. The integration routes these transactions through the Sage Banking Service Provider API.
+You can write [Bank transactions](/bank-feeds-api#/schemas/BankTransactions) from `connected` source bank accounts to target accounts in supported Sage products. The integration routes these transactions through the Sage Banking Service Provider API.
In the user's Sage package, new bank transactions for the target account will appear on the **Incoming Bank Transactions** UI.
@@ -59,7 +59,7 @@ Transactions are not automatically downloaded to Sage when the user successfully
Make the following requests to the Codat API. All write requests are asynchronous.
-1. Write bank transactions to a target bank account using the Create bank transactions endpoint. Note that:
+1. Write bank transactions to a target bank account using the Create bank transactions endpoint. Note that:
- You can only write bank transactions to one target account at a time.
- Bank transactions must be written in chronological order.
- Bank transactions can't be older than the most recent transaction available on the destination bank account.
diff --git a/docs/integrations/banking/proxy-access-banking-data/example-proxy-requests.md b/docs/integrations/banking/proxy-access-banking-data/example-proxy-requests.md
index 5342cee66e..1d92bc7204 100644
--- a/docs/integrations/banking/proxy-access-banking-data/example-proxy-requests.md
+++ b/docs/integrations/banking/proxy-access-banking-data/example-proxy-requests.md
@@ -25,7 +25,7 @@ If successful, a list of [Plaid items](https://plaid.com/docs/quickstart/glossar
This example shows a proxy request to the `/direct-debits` endpoint in the TrueLayer Data API.
-1. Get an account ID from the [Bank accounts](/accounting-api#/operations/list-bank-accounts) endpoint in the Codat API:
+1. Get an account ID from the [Bank accounts](/lending-api#/operations/list-accounting-bank-accounts) endpoint in the Codat API:
```
GET /companies/{companyId}/connections/{connectionId}/data/bankAccounts
diff --git a/docs/lending/data-integrity/api-data-integrity.md b/docs/lending/data-integrity/api-data-integrity.md
index 07f025cd53..93361c65e3 100644
--- a/docs/lending/data-integrity/api-data-integrity.md
+++ b/docs/lending/data-integrity/api-data-integrity.md
@@ -55,10 +55,10 @@ The endpoint is available in our Submit as route parameter. |
-| **dataType** | _string_ | The data type you want match results for.
**Accounting source:**
**[bankAccounts](/accounting-api#/schemas/BankAccount),
[accountTransactions](/accounting-api#/schemas/AccountTransaction)**.
**Banking source:**
**[banking-accounts](/banking-api#/schemas/Account),
[banking-transactions](/banking-api#/schemas/Transaction)**.
Submit as route parameter. |
-| **Query** | _string_ | Can query any property in response. This follows the standard [Codat query language](/using-the-api/querying). |
-| **page** | _number_ | Submit as query parameter. Defaults to 1. |
-| **pageSize** | _number_ | Submit as query parameter. Defaults to 100. |
-| **orderBy** | _string_ | State the property name by which you would like to order the response by.
Submit as query parameter. |
+| **Parameter** | Type | Description |
+| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **companyId** | _string_ | The ID of the company you want match results for.
Submit as route parameter. |
+| **dataType** | _string_ | The data type you want match results for.
**Accounting source:**
**[bankAccounts](/lending-api#/schemas/AccountingBankAccount),
[accountTransactions](/lending-api#/schemas/AccountingAccountTransaction)**.
**Banking source:**
**[banking-accounts](/banking-api#/schemas/Account),
[banking-transactions](/banking-api#/schemas/Transaction)**.
Submit as route parameter. |
+| **Query** | _string_ | Can query any property in response. This follows the standard [Codat query language](/using-the-api/querying). |
+| **page** | _number_ | Submit as query parameter. Defaults to 1. |
+| **pageSize** | _number_ | Submit as query parameter. Defaults to 100. |
+| **orderBy** | _string_ | State the property name by which you would like to order the response by.
Submit as query parameter. |
### Data model
diff --git a/docs/usecases/bill-pay/bills.md b/docs/usecases/bill-pay/bills.md
index 7d25a2cf77..fb0e6a8505 100644
--- a/docs/usecases/bill-pay/bills.md
+++ b/docs/usecases/bill-pay/bills.md
@@ -5,17 +5,17 @@ description: "Retrieve and create bills using the Accounting API"
### Accounts payable
-In Codat's API a [Bill](/accounting-api#/schemas/Bill) represents an invoice from a [supplier](/accounting-api#/schemas/Supplier), for this use case bills can be [retrieved](/accounting-api#/operations/list-bills) from the Accounting API, or you can create bills within your platform and [post](https://docs.codat.io/accounting-api#/operations/create-bill) them to your customers accounting software.
+In Codat's API a [Bill](/sync-for-payables-api#/schemas/Bill) represents an invoice from a [supplier](/sync-for-payables-api#/schemas/Supplier), for this use case bills can be [retrieved](/sync-for-payables-api#/operations/list-bills) from the Accounting API, or you can create bills within your platform and [post](https://docs.codat.io/sync-for-payables-api#/operations/create-bill) them to your customers accounting software.
### Managing suppliers
-In the accounting API a [supplier](/accounting-api#/schemas/Supplier) represents a business or sole trader that provides goods or services to a company.
+In the accounting API a [supplier](/sync-for-payables-api#/schemas/Supplier) represents a business or sole trader that provides goods or services to a company.
Suppliers are relevant for the bill pay use case as each bill is associated to a supplier - suppliers also have important information such as addresses and contact details which could be used to notify a supplier once a payment is made.
#### Retrieve a list of suppliers
-You can get a [list of suppliers](/accounting-api#/operations/list-suppliers) using the Accounting API
+You can get a [list of suppliers](/sync-for-payables-api#/operations/list-suppliers) using the Accounting API
```http request
GET https://api.codat.io/companies/{companyId}/data/suppliers?page=1&pageSize=100
@@ -31,12 +31,12 @@ Query parameters can also be used to narrow the list of suppliers e.g.
Currently the accounting API does not expose supplier balances on the supplier endpoint, however you can access these by
- Aggregating bills by supplier
-- Using the [Aged debtors](/accounting-api#/operations/get-aged-debtors-report) report
+- Using the [Aged debtors](/lending-api#/operations/get-accounting-aged-debtors-report) report
:::
#### Creating a new supplier
-In some cases, a company may do business with a new supplier for the first time, when this happens you should [create the supplier](/accounting-api#/operations/create-supplier) first before creating a bill against the supplier.
+In some cases, a company may do business with a new supplier for the first time, when this happens you should [create the supplier](/sync-for-payables-api#/operations/create-supplier) first before creating a bill against the supplier.
```http request
POST https://api.codat.io/companies/{companyId}/connections/{connectionId}/push/suppliers
@@ -44,7 +44,7 @@ POST https://api.codat.io/companies/{companyId}/connections/{connectionId}/push/
#### Updating a supplier
-If a supplier changes address or business name, you may want to reflect this change in the companies accounting software by [updating the supplier](/accounting-api#/operations/put-supplier).
+If a supplier changes address or business name, you may want to reflect this change in the companies accounting software by [updating the supplier](/sync-for-payables-api#/operations/update-supplier).
```http request
PUT https://api.codat.io/companies/{companyId}/connections/{connectionId}/push/suppliers/{supplierId}
@@ -56,7 +56,7 @@ Bills can either be created in the companies accounting software and then querie
#### Get a list of bills
-You can [get a list of bills](/accounting-api#/operations/list-bills) for a company from the Accounting API
+You can [get a list of bills](/sync-for-payables-api#/operations/list-bills) for a company from the Accounting API
```http request
GET https://api.codat.io/companies/{companyId}/data/bills?page=1&pageSize=100
@@ -68,11 +68,11 @@ Query parameters can be used to filter and narrow the returned results e.g.
- `dueDate>2023-06-01&&dueDate<2023-06-30` returns only bills due for payment between June 1st and June 30th
- `amountDue>0` returns only outstanding bills with due amounts
-You can also retrieve any associated [attachments](/accounting-api#/operations/download-bill-attachment) for a given bill such as a pdf copy of the invoice issued by the supplier.
+You can also retrieve any associated [attachments](/sync-for-payables-api#/operations/download-bill-attachment) for a given bill such as a pdf copy of the invoice issued by the supplier.
#### Create a bill
-You can also [create a new bill](/accounting-api#/operations/create-bill) in your companies accounting software to represent goods or services purchased from a supplier.
+You can also [create a new bill](/sync-for-payables-api#/operations/create-bill) in your companies accounting software to represent goods or services purchased from a supplier.
```http request
POST https://api.codat.io/companies/{companyId}/connections/{connectionId}/push/bills
@@ -80,7 +80,7 @@ POST https://api.codat.io/companies/{companyId}/connections/{connectionId}/push/
#### Upload a copy of the invoice
-In some cases where a bill is being created in your application, the company may also want to save a copy of the pdf invoice against the bill in their accounting software. This can be supported via the [bill attachments API](/accounting-api#/operations/upload-bill-attachments)
+In some cases where a bill is being created in your application, the company may also want to save a copy of the pdf invoice against the bill in their accounting software. This can be supported via the [bill attachments API](/sync-for-payables-api#/operations/upload-bill-attachment)
```http request
POST https://api.codat.io/companies/{companyId}/connections/{connectionId}/push/bills/{billId}/attachments
diff --git a/docs/usecases/bill-pay/mapping.md b/docs/usecases/bill-pay/mapping.md
index ad26102c2f..f79b29e52b 100644
--- a/docs/usecases/bill-pay/mapping.md
+++ b/docs/usecases/bill-pay/mapping.md
@@ -15,7 +15,7 @@ You should store the mapping of the relevant `accountId` as this will be needed
If you are facilitating payments in a foreign currency, then the payment should either be converted to the currency of the account, or you can create a new account with the import currency.
-The [create account model](/accounting-api#/operations/get-create-chartOfAccounts-model) provides a list of the companies enabled currencies, this will return:
+The [create account model](/sync-for-payables-api#/operations/get-create-account-model) provides a list of the companies enabled currencies, this will return:
- _A single value_: base currency, where only the base currency is supported (e.g. USD for a company based in the United States)
- _Multiple values_: reflecting values selected/enabled by a user within the package
@@ -36,7 +36,7 @@ Typically if the payment method is one of the following:
- Electronic bank transfer
- BACS (Bankers' Automated Clearing System)
-Then you should [create a bank account](/accounting-api#/operations/create-bank-account) with an `accountType` of `Debit` to represent the account the payments are being made from:
+Then you should [create a bank account](/sync-for-payables-api#/operations/create-bank-account) with an `accountType` of `Debit` to represent the account the payments are being made from:
diff --git a/docs/usecases/bill-pay/overview.md b/docs/usecases/bill-pay/overview.md
index 71f78052f5..6964804b8b 100644
--- a/docs/usecases/bill-pay/overview.md
+++ b/docs/usecases/bill-pay/overview.md
@@ -61,7 +61,7 @@ Codat handles authorization and linking to your SMB's accounting software and ta
### [Retrieve accounts payable invoices](bills)
-A list of unpaid [bills](/accounting-api#/schemas/Bill) (accounts payable invoices) can be retrieved from the accounting software, in the Accounting API a bill is an itemised record of goods purchased from or services provided by a supplier.
+A list of unpaid [bills](/sync-for-payables-api#/schemas/Bill) (accounts payable invoices) can be retrieved from the accounting software, in the Accounting API a bill is an itemised record of goods purchased from or services provided by a supplier.
Alternatively, Bills can also be created within your application and then synchronized to the accounting software.
### [Payment account mapping](mapping)
diff --git a/docs/usecases/bill-pay/payments.md b/docs/usecases/bill-pay/payments.md
index f940fe3d6c..c7e159f79c 100644
--- a/docs/usecases/bill-pay/payments.md
+++ b/docs/usecases/bill-pay/payments.md
@@ -291,7 +291,7 @@ To do this with Codat, you should leave the `supplierRef` parameter blank when c
:::note
-Note that if locations is set to mandatory in the companies NetSuite Account, the `reference` is required and should be an `id` from the [trackingCategories](/accounting-api#/operations/list-tracking-categories) prefixed with location.
+Note that if locations is set to mandatory in the companies NetSuite Account, the `reference` is required and should be an `id` from the [trackingCategories](/sync-for-payables-api#/operations/list-tracking-categories) prefixed with location.
:::
@@ -337,7 +337,7 @@ Note that if locations is set to mandatory in the companies NetSuite Account, th
:::note
-Sage Intacct uses a `paymentMethodRef`, the payment method's for a company can be retrieved from the [options API](/accounting-api#/operations/get-create-update-bills-model)
+Sage Intacct uses a `paymentMethodRef`, the payment method's for a company can be retrieved from the [options API](/sync-for-payables-api#/operations/get-create-update-bill-model)
:::
@@ -440,7 +440,7 @@ If a company receives a credit note from their supplier, the company could use t
With the billPayment API, you can partially or fully offset the balance of an invoice by adding the credit note in the `lines` array.
-1. The first step is to create a [`billCreditNote`](/accounting-api#/operations/create-bill-credit-note)
+1. The first step is to create a [`billCreditNote`](/sync-for-payables-api#/operations/create-bill-credit-note)
2. Once this is successfully created you can create a `billPayment` and include the `billCreditNote` and the `bill` to credit in the links array
### Creating a Credit Note
@@ -860,7 +860,7 @@ The example below shows a partial billPayment and billCredit note to pay the ful
:::note
-Sage Intacct uses a `paymentMethodRef`, the payment method's for a company can be retrieved from the [options API](/accounting-api#/operations/get-create-update-bills-model)
+Sage Intacct uses a `paymentMethodRef`, the payment method's for a company can be retrieved from the [options API](/sync-for-payables-api#/operations/get-create-update-bill-model)
:::
diff --git a/docs/using-the-api/best-practices/implementing-a-mapping-page.md b/docs/using-the-api/best-practices/implementing-a-mapping-page.md
index 4f6a3c8355..5397eb1624 100644
--- a/docs/using-the-api/best-practices/implementing-a-mapping-page.md
+++ b/docs/using-the-api/best-practices/implementing-a-mapping-page.md
@@ -32,7 +32,7 @@ Build your account mapping process to use the Codat API as follows:
2. [Configure a webhook consumer](/using-the-api/webhooks/create-consumer) to listen for the [DatasetDataChanged](/using-the-api/webhooks/event-types) event that indicates changes in the underlying data for the `chartOfAccounts` data type. You will receive a notification when the data sync completes successfully.
-3. Once notified by the webhook, call our [List accounts](/accounting-api#/operations/list-accounts) endpoint and use the response to display `account.name` and `account.id` in a dropdown box for your customer to choose the correct mapping. You can also query the response to simplify the mapping experience for your customer:
+3. Once notified by the webhook, call our [List accounts](/lending-api#/operations/list-accounting-accounts) endpoint and use the response to display `account.name` and `account.id` in a dropdown box for your customer to choose the correct mapping. You can also query the response to simplify the mapping experience for your customer:
- Display only active accounts of relevant account type needed for your mapping page, such as `type=income` and `status=active`.
```
diff --git a/docs/using-the-api/get-data.md b/docs/using-the-api/get-data.md
index 35ac28eb90..d68cb97107 100644
--- a/docs/using-the-api/get-data.md
+++ b/docs/using-the-api/get-data.md
@@ -25,7 +25,7 @@ You can configure a sync schedule in the Codat portal to keep each data type at
Codat exposes endpoints that enable you to easily query each of the supported data types.
-For example, when querying invoices, you can use the [`GET /companies/{companyId}/data/invoices`](/accounting-api#/operations/list-invoices) endpoint, with query string parameters as below:
+For example, when querying invoices, you can use the [`GET /companies/{companyId}/data/invoices`](/lending-api#/operations/list-accounting-invoices) endpoint, with query string parameters as below:
- `pageSize` – the size of page you wish to retrieve
- `page` – which page number you wish to retrieve
diff --git a/docs/using-the-api/optimizing-api-calls.md b/docs/using-the-api/optimizing-api-calls.md
index 60b88ee920..74337f26fe 100644
--- a/docs/using-the-api/optimizing-api-calls.md
+++ b/docs/using-the-api/optimizing-api-calls.md
@@ -35,7 +35,7 @@ We also recommend using a page size of 100 to return the results faster. This is
:::tip Querying by the record date: example
-You can query our [List accounts](/accounting-api#/operations/list-accounts) endpoint with `modifiedDate` as follows:
+You can query our [List accounts](/lending-api#/operations/list-accounting-accounts) endpoint with `modifiedDate` as follows:
```http
https://api.codat.io/companies/{companyId}/data/accounts?page=1&pageSize=100&query=modifiedDate>2022-08-23&orderby=-modifiedDate
@@ -53,7 +53,7 @@ These approaches allow you to minimise the number of API calls and the volume of
:::tip Querying for a use case: example
-You can query our [Invoices](/accounting-api#/operations/list-invoices) endpoint for an invoice use case as follows:
+You can query our [Invoices](/lending-api#/operations/list-accounting-invoices) endpoint for an invoice use case as follows:
```http
https://api.codat.io/companies/{companyId}/data/invoices?page=1&pageSize=100&query=customerRef.companyName=NewCo
diff --git a/docs/using-the-api/ordering-results.md b/docs/using-the-api/ordering-results.md
index 7a65568af8..b61b4f6723 100644
--- a/docs/using-the-api/ordering-results.md
+++ b/docs/using-the-api/ordering-results.md
@@ -9,7 +9,7 @@ The API can return results in ascending order or descending order. You can also
## Sorting in ascending order
-By default, results are sorted in ascending order. For example, if you want to return a [list of invoices](/accounting-api#/operations/list-invoices) in ascending order, oldest first, use the following syntax: `{parameter}={value}`. In this case, `orderBy=issueDate`.
+By default, results are sorted in ascending order. For example, if you want to return a [list of invoices](/lending-api#/operations/list-accounting-invoices) in ascending order, oldest first, use the following syntax: `{parameter}={value}`. In this case, `orderBy=issueDate`.
```http
GET /companies/{companyId}/data/invoices?page=1&orderBy=issueDate
@@ -17,7 +17,7 @@ GET /companies/{companyId}/data/invoices?page=1&orderBy=issueDate
## Sorting in descending order
-To return results sorted in descending order you simply prepend a `-` to the parameter value. For example, to return the same [list of invoices](/accounting-api#/operations/list-invoices), this time with the newest invoice first, use the following syntax: `orderBy=-issueDate`.
+To return results sorted in descending order you simply prepend a `-` to the parameter value. For example, to return the same [list of invoices](/lending-api#/operations/list-accounting-invoices), this time with the newest invoice first, use the following syntax: `orderBy=-issueDate`.
```http
GET /companies/{companyId}/data/invoices?page=1&orderBy=-issueDate
@@ -25,7 +25,7 @@ GET /companies/{companyId}/data/invoices?page=1&orderBy=-issueDate
## Ordering results from a custom query
-You can also order the results returned by any custom queries that you've written. For example, you might regularly run a query that returns all [outstanding bills](/accounting-api#/operations/list-bills):
+You can also order the results returned by any custom queries that you've written. For example, you might regularly run a query that returns all [outstanding bills](/lending-api#/operations/list-accounting-bills):
```http
GET /companies/{companyId}/data/bills?query=amountDue%3E0
diff --git a/docs/using-the-api/overview.md b/docs/using-the-api/overview.md
index c22a4bcd49..e93bdf7ac7 100644
--- a/docs/using-the-api/overview.md
+++ b/docs/using-the-api/overview.md
@@ -27,8 +27,7 @@ Explore the underlying [OpenAPI Spec](https://github.com/codatio/oas).
diff --git a/redirects.config.js b/redirects.config.js
index a0868c996a..99f5a79b51 100644
--- a/redirects.config.js
+++ b/redirects.config.js
@@ -490,12 +490,6 @@ var comm = [
];
module.exports = {
redirects: [
- // Accounting API reference retired (EXP-2414); Lending API reference
- // documents the same properties. Internal copy: accounting-api-ref.codat.ai
- {
- from: "/accounting-api",
- to: "/lending-api",
- },
// Deprecations - remove after July
{
from: "/updates/240314-removing-transfer-transaction-type-SFE",
From 2de8e8ea74bbe6edd4a0071eaaccd333a41884b6 Mon Sep 17 00:00:00 2001
From: pmckinney-codat
Date: Wed, 16 Sep 2026 12:12:34 +0100
Subject: [PATCH 3/5] EXP-2414: leave legacy /updates announcements untouched
The two blog posts are historical announcements and should read as
published. Restore their original wording and link targets; the only
edit kept is making the one relative /accounting-api link absolute
(same destination), because the CI link checker skips absolute
docs.codat.io URLs but would fail every future PR on a relative link
to the now-removed page.
Co-Authored-By: Claude Fable 5
---
blog/230428-April-Features.md | 8 ++++----
blog/230901-new-products.md | 2 +-
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/blog/230428-April-Features.md b/blog/230428-April-Features.md
index 64b0d76453..f1b956a4f7 100644
--- a/blog/230428-April-Features.md
+++ b/blog/230428-April-Features.md
@@ -31,7 +31,7 @@ This update enables you to view and assign Locations, Customers, and Classes on
By using these fields on Codat's Direct cost model, you can provide companies with valuable insights into their spending patterns across multiple locations and departments, and even individual customer profitability.
-Review the documentation for [creating a direct cost](https://docs.codat.io/lending-api#/operations/create-direct-cost) and [retrieving a direct cost](https://docs.codat.io/lending-api#/operations/list-accounting-direct-costs)
+Review the documentation for [creating a direct cost](https://docs.codat.io/accounting-api#/operations/create-direct-cost) and [retrieving a direct cost](https://docs.codat.io/accounting-api#/operations/list-direct-costs)
## Create journals in Microsoft Dynamics 365 Business Central
@@ -41,7 +41,7 @@ Codat now supports the creation of journal entries in Microsoft Dynamics 365 Bus
This enhancement empowers you to provide this integration to your customers, streamlining use cases such as payroll reconciliation, purchase amortization, loan repayment reconciliation, and more.
-See the [API Reference](https://docs.codat.io/sync-for-payables-api#/operations/create-journal-entry) for more information on how to use the POST journal entry endpoint.
+See the [API Reference](https://docs.codat.io/accounting-api#/operations/create-journal-entry) for more information on how to use the POST journal entry endpoint.
## Increased Coverage of QuickBooks Online Deletion Support
@@ -51,7 +51,7 @@ Codat has added support for the deletion of journal entries, bills, and invoices
This improvement enables you to offer this integration to your customers, simplifying use cases such as reversing erroneous transactions and maintaining accurate financial records.
-See Delete data from QuickBooks Online for more information on how to use this feature.
+See [Delete data from QuickBooks Online](https://docs.codat.io/accounting-api#/operations/delete-journal-entry) for more information on how to use this feature.
## Addition of the QuickBooks Desktop Tracking Object
@@ -69,7 +69,7 @@ We've extended our support for creating refunds for expenses in QuickBooks Onlin
This enhancement lets you facilitate use cases such as refunding an erroneous transaction or representing a returned order, and managing accidental duplicate payments.
-See [Direct cost](https://docs.codat.io/lending-api#/operations/create-direct-cost) for more information on how to use this feature.
+See [Direct cost](https://docs.codat.io/accounting-api#/operations/create-direct-cost) for more information on how to use this feature.
## Integration coverage improvements
diff --git a/blog/230901-new-products.md b/blog/230901-new-products.md
index 47d17ef555..9b113591fe 100644
--- a/blog/230901-new-products.md
+++ b/blog/230901-new-products.md
@@ -47,7 +47,7 @@ Our products can help you make the most of your customers' consented business da
The API documentation for the products you may be using is available below. These products are not available to new customers from September 4, 2023.
-- Accounting API
+- [Accounting API](https://docs.codat.io/accounting-api#/)
- [Banking API](/banking-api#/)
- [Commerce API](/commerce-api#/)
- [Assess API](/assess-api#/)
From 9998ad3a0bc6d22a77228fb649593dc1fa2e13ea Mon Sep 17 00:00:00 2001
From: pmckinney-codat
Date: Wed, 16 Sep 2026 16:34:56 +0100
Subject: [PATCH 4/5] EXP-2414: apply Hawi's review feedback on relinked
targets
From the product review of the new link destinations:
- expenses/config-and-categorize: point the account-mapping step at the
Sync for Expenses options endpoint (get-create-chartOfAccounts-model)
instead of the Lending list-accounts read
- qbo-bank-feeds docs and the banking proxy example: drop the three
links into the Lending reference entirely (bank feeds/banking readers
will not have Lending); text kept
Commerce prerequisites page feedback is pending a scope decision.
Co-Authored-By: Claude Fable 5
---
docs/expenses/config-and-categorize.md | 2 +-
.../qbo-bank-feeds/qbo-bank-feeds-push-bank-transactions.md | 2 +-
.../bank-feeds/qbo-bank-feeds/qbo-bank-feeds-setup.md | 2 +-
.../banking/proxy-access-banking-data/example-proxy-requests.md | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/expenses/config-and-categorize.md b/docs/expenses/config-and-categorize.md
index dc9c2b8fac..275853e240 100644
--- a/docs/expenses/config-and-categorize.md
+++ b/docs/expenses/config-and-categorize.md
@@ -73,7 +73,7 @@ A bank account (`bankAccount.id`) is required to show where purchases have been
- To create a new bank account, use the [Create bank account](/sync-for-expenses-api#/operations/create-account) endpoint. You should trigger a data refresh if a new bank account has been created prior to syncing transactions.
-- Use the [List accounts](/lending-api#/operations/list-accounting-accounts) endpoint to fetch a list of your customer's existing accounts from their accounting software and display these to them.
+- Use the [List accounts](/sync-for-expenses-api#/operations/get-create-chartOfAccounts-model) endpoint to fetch a list of your customer's existing accounts from their accounting software and display these to them.
You can also use [query parameters](/using-the-api/querying) to narrow down the list of results, for example:
- `query=metadata.isDeleted=false&&isBankAccount=true` returns existing bank accounts.
- `query=metadata.isDeleted=false&&isBankAccount=true&&type=liability` returns existing liability bank accounts, which are used for credit cards.
diff --git a/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-push-bank-transactions.md b/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-push-bank-transactions.md
index 0195111e17..ba4edc6b03 100644
--- a/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-push-bank-transactions.md
+++ b/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-push-bank-transactions.md
@@ -16,7 +16,7 @@ Bank transactions must be ordered chronologically (from earliest to latest) by t
:::caution Cleared on date field names
-The `clearedOnDate` is returned by the [List bank transactions for a bank account](/lending-api#/operations/list-accounting-bank-account-transactions) endpoint. However, when writing transactions with [Create bank transactions](/bank-feeds-api#/operations/create-bank-transactions), you must supply the value of the `clearedOnDate` in the `date` field.
+The `clearedOnDate` is returned by the List bank transactions for a bank account endpoint. However, when writing transactions with [Create bank transactions](/bank-feeds-api#/operations/create-bank-transactions), you must supply the value of the `clearedOnDate` in the `date` field.
:::
diff --git a/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-setup.md b/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-setup.md
index 1828e10834..40fb1aad17 100644
--- a/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-setup.md
+++ b/docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-setup.md
@@ -12,7 +12,7 @@ Before setting up the integration, make sure that:
- Your Solutions Engineer has provided you with access to the QuickBooks Online Bank Feeds integration.
- SMB users who will connect to QBO Bank Feeds are located in the US and Canada only.
-- In the Codat Portal, you've enabled [Bank accounts](/lending-api#/schemas/AccountingBankAccount) and [Bank transactions](/bank-feeds-api#/schemas/BankTransactions) in your [Data type settings](/core-concepts/data-type-settings).
+- In the Codat Portal, you've enabled Bank accounts and [Bank transactions](/bank-feeds-api#/schemas/BankTransactions) in your [Data type settings](/core-concepts/data-type-settings).
- You've customized the QBO Bank Feeds Link UI for your institution.
## Enable the QBO Bank Feeds integration
diff --git a/docs/integrations/banking/proxy-access-banking-data/example-proxy-requests.md b/docs/integrations/banking/proxy-access-banking-data/example-proxy-requests.md
index 1d92bc7204..6569f37f71 100644
--- a/docs/integrations/banking/proxy-access-banking-data/example-proxy-requests.md
+++ b/docs/integrations/banking/proxy-access-banking-data/example-proxy-requests.md
@@ -25,7 +25,7 @@ If successful, a list of [Plaid items](https://plaid.com/docs/quickstart/glossar
This example shows a proxy request to the `/direct-debits` endpoint in the TrueLayer Data API.
-1. Get an account ID from the [Bank accounts](/lending-api#/operations/list-accounting-bank-accounts) endpoint in the Codat API:
+1. Get an account ID from the Bank accounts endpoint in the Codat API:
```
GET /companies/{companyId}/connections/{connectionId}/data/bankAccounts
From cb7292119363589d5bd8a1f326e7f2e866dfa413 Mon Sep 17 00:00:00 2001
From: pmckinney-codat
Date: Wed, 16 Sep 2026 16:38:04 +0100
Subject: [PATCH 5/5] EXP-2414: delete the orphaned Sync for Commerce
prerequisites page
Product review feedback (Hawi): the page was already dropped from the
sync-for-commerce sidebar and its parent build guide is gone, so it
should have been removed then. It was only reachable by URL, nothing
links to it, and no redirect targets it, so it can go outright -- which
also removes four of the relinked accounting data-type links.
Co-Authored-By: Claude Fable 5
---
.../build/sync-for-commerce-prerequisites.md | 43 -------------------
sidebars/sync-for-commerce.js | 1 -
2 files changed, 44 deletions(-)
delete mode 100644 docs/commerce/build/sync-for-commerce-prerequisites.md
diff --git a/docs/commerce/build/sync-for-commerce-prerequisites.md b/docs/commerce/build/sync-for-commerce-prerequisites.md
deleted file mode 100644
index 97994058ba..0000000000
--- a/docs/commerce/build/sync-for-commerce-prerequisites.md
+++ /dev/null
@@ -1,43 +0,0 @@
----
-title: "Prerequisites"
-description: "Prerequisites to get started with Sync for Commerce."
-createdAt: "2022-08-03T12:22:19.576Z"
-updatedAt: "2022-11-28T11:26:51.853Z"
----
-
-:::caution Beta testing
-
-Sync for Commerce is in beta. If you are interested in building with Sync for Commerce, please [get in touch](mailto:sync-for-commerce@codat.io).
-:::
-
-Sync for Commerce must be enabled for your account. You can enable products in the Portal via [**Settings > Products**](https://app.codat.io/settings/products) as an Admin or Developer user.
-
-### Authentication
-
-[Authenticate](/using-the-api/authentication) with the Codat API using your API key.
-
-### Enable a supported platform
-
-You need to set up one or more of the supported accounting software:
-
-- [Xero](/integrations/accounting/xero/accounting-xero)
-- [QuickBooks Online](/integrations/accounting/quickbooksonline/accounting-quickbooksonline)
-- [FreeAgent](/integrations/accounting/freeagent/accounting-freeagent)
-
-### Required data types
-
-The following data types are required (and are enabled by default):
-
-#### Accounting
-
-- [Company info](/lending-api#/schemas/AccountingCompanyInfo)
-- [Accounts](/lending-api#/schemas/AccountingAccount)
-- [Tax rates](/sync-for-payables-api#/schemas/TaxRates)
-- [Customers](/lending-api#/schemas/AccountingCustomers)
-- [Suppliers](/lending-api#/schemas/AccountingSuppliers)
-
-#### Commerce
-
-- [Orders](/commerce-api#/schemas/orders)
-- [Transactions](/commerce-api#/schemas/transactions)
-- [Payments](/commerce-api#/schemas/payments)
diff --git a/sidebars/sync-for-commerce.js b/sidebars/sync-for-commerce.js
index b575b05c18..8a42340c7a 100644
--- a/sidebars/sync-for-commerce.js
+++ b/sidebars/sync-for-commerce.js
@@ -49,7 +49,6 @@ module.exports = [
// label: "Build guide",
// collapsed: true,
// items: [
- // "commerce/build/sync-for-commerce-prerequisites",
// "commerce/build/sync-platform-selection",
// "commerce/build/implementing-codats-no-code-merchant-configuration",
// "commerce/build/customizing-the-sync-configuration-flow",