EXP-2414: Remove client-facing Accounting API reference by pmckinney-codat · Pull Request #1889 · codatio/codat-docs

pmckinney-codat · 2026-09-16T10:31:29Z

What

Removes the client-facing Accounting API reference from docs.codat.io — /accounting-api becomes a hard 404, no redirect:

Deletes the /accounting-api reference page (src/pages/accounting-api/index.tsx)
Deletes the publicly downloadable OAS spec (static/oas/Codat-Accounting.json)
Removes the dead sidebars/accounting-api.js config (its require in sidebars.js was already commented out and the doc pages it references were removed long ago)
Rewrites the 72 internal doc links that pointed into /accounting-api#/… to the product references that still document the same endpoints and models:
- Reads (schemas, list/get endpoints) → Lending API reference, which documents the same accounting data
- Bank transaction writes in bank-feeds docs → Bank Feeds API
- Bill Pay use case guides and other writes → Sync for Payables API
- Tax rate schemas → Sync for Payables (Lending has no TaxRate schema)
- De-links the two with no surviving equivalent (Items schema in the Xero FAQ, and the Accounting API entry in the using-the-api overview nav list)

Every new link target was verified against the specs in static/oas. The pre-existing redirects for the long-removed doc pages (/accounting-api/overview → /using-the-api/overview etc.) are untouched — they point at unrelated live pages.

Notes on /updates

The two legacy announcements under /updates (Apr and Sep 2023) that reference the old page are left as published — we don't edit historical announcements. The only touch is making the one relative link in the Sep 2023 post absolute (same destination): the CI link checker skips absolute docs.codat.io URLs but would fail every future PR on a relative link to the removed page.

Why

The reference was unlisted but still publicly served, and a client found it via the URL. Tom confirmed the Lending API reference documents the same properties, so anyone who needs it (Lloyds, Amex) can be pointed there. An auth-walled internal copy lives at accounting-api-ref.codat.ai for emergencies.

Ticket: EXP-2414
Slack thread: #docs discussion
Companion PR (stops the OAS pipeline re-adding the spec): codat-internal/oas#90 — merged
Product review sheet for the new link targets: shared internally via Claude artifact (ask Phil)

Verification

npm run build passes locally: no page or redirect stub is emitted at /accounting-api, Codat-Accounting.json is absent from the build output, and no built page links to /accounting-api. Prettier and cspell pass on all touched files. The CI link check on this PR reported zero broken links.

🤖 Generated with Claude Code

The Accounting API reference at /accounting-api was unlisted but still publicly served, and a client found it via the URL. An auth-walled internal copy now lives at accounting-api-ref.codat.ai, so the client-facing page and its OAS spec can go. - Delete the /accounting-api reference page and Codat-Accounting.json - Remove the accounting-api sidebar config (unused since its doc pages were removed; the require was already commented out) - Redirect /accounting-api to /lending-api, which documents the same properties, so existing deep links don't 404 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

github-actions · 2026-09-16T10:36:03Z

PR Preview Action v1.8.1
🚀 View preview at https://codatio.github.io/codat-docs/pr-preview/pr-1889/
Built to branch `gh-pages` at 2026-09-16 15:44 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Drop the /accounting-api -> /lending-api redirect: the URL should be completely dead, not forward anywhere. That means the ~60 internal doc links into the old reference would 404, so rewrite them to the product references that still document the same endpoints and models: - Reads (schemas, list/get endpoints) -> Lending API reference, which documents the same accounting data (per the Slack thread) - Bank transaction writes in bank-feeds docs -> Bank Feeds API - Bill Pay use case guides and other writes -> Sync for Payables API - Tax rate schemas -> Sync for Payables (Lending has no TaxRate schema) - De-link the few with no surviving equivalent (Items schema, delete-journal-entry, the Accounting API entries in historical blog posts and the using-the-api overview nav list) Every new target was verified against the specs in static/oas. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

📝 [vale] <Google.Passive> _{reported by reviewdog 🐶}
In general, use active voice instead of passive voice ('be supported').

codat-docs/docs/usecases/bill-pay/bills.md

Line 83 in 78a2940

    
           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)

📝 [vale] <Google.Will> _{reported by reviewdog 🐶}
Avoid using 'will'.

codat-docs/docs/usecases/bill-pay/mapping.md

Line 18 in 78a2940

    
           The [create account model](/sync-for-payables-api#/operations/get-create-account-model) provides a list of the companies enabled currencies, this will return:

📝 [vale] <Google.Passive> _{reported by reviewdog 🐶}
In general, use active voice instead of passive voice ('being made').

codat-docs/docs/usecases/bill-pay/mapping.md

Line 39 in 78a2940

    
           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:

📝 [vale] <Google.Parens> _{reported by reviewdog 🐶}
Use parentheses judiciously.

codat-docs/docs/usecases/bill-pay/overview.md

Line 64 in 78a2940

    
           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.

📝 [vale] <Google.Passive> _{reported by reviewdog 🐶}
In general, use active voice instead of passive voice ('be retrieved').

codat-docs/docs/usecases/bill-pay/overview.md

Line 64 in 78a2940

    
           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.

📝 [vale] <Google.Passive> _{reported by reviewdog 🐶}
In general, use active voice instead of passive voice ('is set').

codat-docs/docs/usecases/bill-pay/payments.md

Line 294 in 78a2940

    
           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.

📝 [vale] <Google.Passive> _{reported by reviewdog 🐶}
In general, use active voice instead of passive voice ('is required').

codat-docs/docs/usecases/bill-pay/payments.md

Line 294 in 78a2940

    
           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.

📝 [vale] <Google.Passive> _{reported by reviewdog 🐶}
In general, use active voice instead of passive voice ('be retrieved').

codat-docs/docs/usecases/bill-pay/payments.md

Line 340 in 78a2940

    
           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)

📝 [vale] <Google.Passive> _{reported by reviewdog 🐶}
In general, use active voice instead of passive voice ('be retrieved').

codat-docs/docs/usecases/bill-pay/payments.md

Line 863 in 78a2940

    
           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)

📝 [vale] <Google.Passive> _{reported by reviewdog 🐶}
In general, use active voice instead of passive voice ('are sorted').

codat-docs/docs/using-the-api/ordering-results.md

Line 12 in 78a2940

    
           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`.

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 <noreply@anthropic.com>

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 <noreply@anthropic.com>

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 <noreply@anthropic.com>

github-actions · 2026-09-16T15:42:00Z

Link check results:

[]

rodages · 2026-09-16T16:35:59Z

 | `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).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |


is this correct?

Hawi confirmed this was correct (or as correct as it can be)

github-actions Bot reviewed Sep 16, 2026

View reviewed changes

pmckinney-codat mentioned this pull request Sep 16, 2026

Remove the Vale prose-linting check #1890

Merged

github-actions Bot reviewed Sep 16, 2026

View reviewed changes

Comment thread docs/integrations/bank-feeds/qbo-bank-feeds/qbo-bank-feeds-push-bank-transactions.md

pmckinney-codat marked this pull request as ready for review September 16, 2026 15:42

pmckinney-codat enabled auto-merge September 16, 2026 15:52

rodages reviewed Sep 16, 2026

View reviewed changes

Uh oh!

Conversation

pmckinney-codat commented Sep 16, 2026 • edited by atlassian Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Notes on /updates

Why

Verification

Uh oh!

github-actions Bot commented Sep 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Built to branch gh-pages at 2026-09-16 15:44 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Sep 16, 2026

Uh oh!

rodages Sep 16, 2026

Choose a reason for hiding this comment

Uh oh!

pmckinney-codat Sep 16, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

pmckinney-codat commented Sep 16, 2026 •

edited by atlassian Bot

Loading

github-actions Bot commented Sep 16, 2026 •

edited

Loading

Built to branch `gh-pages` at 2026-09-16 15:44 UTC.
Preview will be ready when the GitHub Pages deployment is complete.