Skip to content

EXP-2414: Remove client-facing Accounting API reference #1889

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.

Sign up for GitHub

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

Merged
pmckinney-codat merged 5 commits into from
Sep 17, 2026
Merged

EXP-2414: Remove client-facing Accounting API reference #1889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b97d51c
EXP-2414: remove client-facing Accounting API reference
pmckinney-codat Sep 16, 2026
78a2940
EXP-2414: kill /accounting-api outright and relink internal docs
pmckinney-codat Sep 16, 2026
2de8e8e
EXP-2414: leave legacy /updates announcements untouched
pmckinney-codat Sep 16, 2026
9998ad3
EXP-2414: apply Hawi's review feedback on relinked targets
pmckinney-codat Sep 16, 2026
cb72921
EXP-2414: delete the orphaned Sync for Commerce prerequisites page
pmckinney-codat Sep 16, 2026
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
2 changes: 1 addition & 1 deletion blog/230901-new-products.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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](https://docs.codat.io/accounting-api#/)
- [Banking API](/banking-api#/)
- [Commerce API](/commerce-api#/)
- [Assess API](/assess-api#/)
Expand Down
2 changes: 1 addition & 1 deletion docs/auth-flow/customize/set-up-redirects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <br/> **200** = Successful - user's request has been fulfilled. <br/> **201** = No content - successful, but no information about data connection will be available. <br/>_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. <br/> **403** = Not available. <br/>_Possible scenario_: A user chooses to quit the Link flow before the Linking process is completed. <br/> **501** = Platform not supported. <br/>_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. <br/> **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. <br/> **403** = "User cancelled." <br/> **500** = "Unknown error occurred." <br/> **501** = "Not supported." <br/> **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. <br/>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. <br/>This maps to the company name property in the [company info dataset](/lending-api#/schemas/AccountingCompanyInfo). |
Comment thread
pmckinney-codat marked this conversation as resolved.

:::note Availability of reserved query parameters
At present, the `data.company.companyName` is only supported for the following integrations:
Expand Down
2 changes: 1 addition & 1 deletion docs/auth-flow/optimize/funnel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

---

Expand Down
43 changes: 0 additions & 43 deletions docs/commerce/build/sync-for-commerce-prerequisites.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/core-concepts/data-type-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a className="external" href="https://app.codat.io/settings/data-types" target="_blank">Data type settings</a> 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.

Expand Down
2 changes: 1 addition & 1 deletion docs/expenses/config-and-categorize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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](/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.
Expand Down
2 changes: 1 addition & 1 deletion docs/expenses/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Expenses validates each expense transaction involving foreign currency. We ensur
answer={`
<p>If a transaction has multiple tax components, each component may be calculated based on the original amount separately, and then added together.</p>
<p>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.</p>
<p>The <code>totalTaxRate</code> is the total, not compounded, sum of the components of a tax rate. You can read more about this in our <a href="https://docs.codat.io/accounting-api#/schemas/TaxRate#tax-components">API documentation covering tax rates</a>.</p>
<p>The <code>totalTaxRate</code> is the total, not compounded, sum of the components of a tax rate. You can read more about this in our <a href="https://docs.codat.io/sync-for-payables-api#/schemas/TaxRate">API documentation covering tax rates</a>.</p>
`}
/>
<Question
Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/first-steps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,7 @@ You can review our detailed instructions for setting up integrations like [Xero]

Codat reads a variety of data types from the source platforms, making it easy to suit the needs of your use case.

With our [accounting integrations](/accounting-api#/), you can read financial statements, earning and spending detail, journal entries, tax details, and many more. Our [banking integrations](/banking-api#/) provide you with banking transactions, accounts, and account balances. Finally, our [commerce integrations](/commerce-api#/) can show you details of orders, customers, payments, products, and others.
With our [accounting integrations](/lending-api#/), you can read financial statements, earning and spending detail, journal entries, tax details, and many more. Our [banking integrations](/banking-api#/) provide you with banking transactions, accounts, and account balances. Finally, our [commerce integrations](/commerce-api#/) can show you details of orders, customers, payments, products, and others.

#### Keen to customize the look and feel of the auth flow?

Expand Down
4 changes: 2 additions & 2 deletions ...ynamics365businesscentral/accounting-dynamics-365-business-central-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Line items of invoices, bills, credit notes, and bill credit notes without linke

## Bill credit notes and currencies

When the currency of a [bill credit note](/accounting-api#/schemas/billcreditnotes) is not set by the supplier, Codat uses the local, or base currency of the company. In Business Central, this is the **LCY code** on the **General Ledger Setup** page.
When the currency of a [bill credit note](/lending-api#/schemas/AccountingBillCreditNotes) is not set by the supplier, Codat uses the local, or base currency of the company. In Business Central, this is the **LCY code** on the **General Ledger Setup** page.
Comment thread
pmckinney-codat marked this conversation as resolved.

## Direct incomes

Expand All @@ -44,7 +44,7 @@ If the description was edited in Business Central, a validation error is returne

## Tracking categories

When reading Tracking categories from Business Central, the `subCategories` field within the [tracking category tree model](/accounting-api#/schemas/TrackingCategoryTree) is not populated. This kind of relationship can't be modeled in Business Central.
When reading Tracking categories from Business Central, the `subCategories` field within the [tracking category tree model](/lending-api#/schemas/AccountingTrackingCategory) is not populated. This kind of relationship can't be modeled in Business Central.
Comment thread
pmckinney-codat marked this conversation as resolved.
Comment thread
pmckinney-codat marked this conversation as resolved.

Tracking categories are not updated on Bills when sending PUT or POST requests.

Expand Down
14 changes: 7 additions & 7 deletions docs/integrations/accounting/netsuite/oracle-netsuite-integration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ You can write Direct costs to NetSuite as either [Checks](https://www.netsuite.c

You can write direct incomes to NetSuite as either [Cash Sales](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2021_2/script/record/cashsale.html) or [Cash Refunds](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2021_2/script/record/cashrefund.html). Writing Customer Deposits is not supported.

When reading Direct incomes, the default `-Not Taxable-` tax group and tax code are ignored. You can access this information by reading the [Tax Rates](/accounting-api#/schemas/TaxRates) data type.
When reading Direct incomes, the default `-Not Taxable-` tax group and tax code are ignored. You can access this information by reading the [Tax Rates](/sync-for-payables-api#/schemas/TaxRates) data type.
Comment thread
pmckinney-codat marked this conversation as resolved.

## Invoices

Expand Down Expand Up @@ -225,9 +225,9 @@ The following tables highlight selected fields that are not available in data re

### Unavailable Codat fields

| Oracle NetSuite record and field | Codat data type | Status |
| ------------------------------------------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `VendorCredit.customForm`, `VendorCredit.postingPeriod` | [Bill credit notes](/accounting-api#/schemas/billcreditnotes) | Not represented in Codat's accounting data model. |
| `Invoice.customForm`, `Invoice.postingPeriod` | [Invoices](/accounting-api#/schemas/invoices) | Not represented in Codat's accounting data model. |
| `Vendor.subsidiary` | [Suppliers](/accounting-api#/schemas/Suppliers) | The Suppliers data type does not show whether or not a supplier company is a subsidiary. |
| `Vendor.workCalendar` | [Suppliers](/accounting-api#/schemas/Suppliers) | Not represented in Codat's accounting data model. |
| Oracle NetSuite record and field | Codat data type | Status |
| ------------------------------------------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `VendorCredit.customForm`, `VendorCredit.postingPeriod` | [Bill credit notes](/lending-api#/schemas/AccountingBillCreditNotes) | Not represented in Codat's accounting data model. |
| `Invoice.customForm`, `Invoice.postingPeriod` | [Invoices](/lending-api#/schemas/AccountingInvoices) | Not represented in Codat's accounting data model. |
| `Vendor.subsidiary` | [Suppliers](/lending-api#/schemas/AccountingSuppliers) | The Suppliers data type does not show whether or not a supplier company is a subsidiary. |
Comment thread
pmckinney-codat marked this conversation as resolved.
| `Vendor.workCalendar` | [Suppliers](/lending-api#/schemas/AccountingSuppliers) | Not represented in Codat's accounting data model. |
4 changes: 2 additions & 2 deletions docs/integrations/accounting/quickbooksonline/faq-quickbooks-online.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,15 +58,15 @@ Unfortunately, QuickBooks Self Employed uses a different API to QuickBooks Onlin

## How does Codat handle QuickBooks Online's "Expense" transactions

QuickBooks Online uses _expenses_ to record purchases that are paid immediately. Where these are recorded against a [supplier](/accounting-api#/schemas/Suppliers), they are made available in Codat's [Bills](/accounting-api#/schemas/bills) and [Bill payments](/accounting-api#/schemas/billpayments) datasets.
QuickBooks Online uses _expenses_ to record purchases that are paid immediately. Where these are recorded against a [supplier](/lending-api#/schemas/AccountingSuppliers), they are made available in Codat's [Bills](/lending-api#/schemas/AccountingBills) and [Bill payments](/lending-api#/schemas/AccountingBillPayments) datasets.
Comment thread
pmckinney-codat marked this conversation as resolved.
Comment thread
pmckinney-codat marked this conversation as resolved.
Comment thread
pmckinney-codat marked this conversation as resolved.
Comment thread
pmckinney-codat marked this conversation as resolved.

## Why can't I sync purchase orders from a QuickBooks Online Demo account?

Intuit only make Purchase Orders available on paid QuickBooks Online subscriptions, so are not available on any free demo or trial accounts.

## Tracking categories

In Codat, QBO's "classes" and "locations" are mapped to [tracking categories](/accounting-api#/schemas/trackingcategories).
In Codat, QBO's "classes" and "locations" are mapped to [tracking categories](/lending-api#/schemas/AccountingTrackingCategory).
Comment thread
pmckinney-codat marked this conversation as resolved.

## Are QuickBooks tags supported?

Expand Down
6 changes: 3 additions & 3 deletions docs/integrations/accounting/sage-intacct/sage-intacct-integration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,6 @@ The following table highlights selected fields that are not available in data re

### Unavailable Codat fields

| Sage Intacct record and field | Codat data type | Status |
| --------------------------------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `otherreceipt.paymentmethod` (Required) | [Direct Incomes](/accounting-api#/directincomes) | [Payment methods](/accounting-api#/paymentmethods) is not supported for the direct incomes data type. When writing direct incomes to Sage Intacct, the `paymentmethod` is always set to `Cash`. |
| Sage Intacct record and field | Codat data type | Status |
| --------------------------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `otherreceipt.paymentmethod` (Required) | [Direct Incomes](/lending-api#/schemas/AccountingDirectIncomes) | [Payment methods](/lending-api#/schemas/AccountingPaymentMethod) is not supported for the direct incomes data type. When writing direct incomes to Sage Intacct, the `paymentmethod` is always set to `Cash`. |
Comment thread
pmckinney-codat marked this conversation as resolved.
Comment thread
pmckinney-codat marked this conversation as resolved.
Loading
Loading