From 7dcbea8fbfc00a30e9b9c0cb53b010b84f54aca0 Mon Sep 17 00:00:00 2001 From: pmckinney-codat Date: Wed, 4 Feb 2026 20:25:32 +0000 Subject: [PATCH 1/5] update spellings to pass checks --- blog/230203-weekly-update.md | 2 +- blog/230404-product-update-4.md | 2 +- blog/230710-deprecation-v2-categories.md | 2 +- blog/240925-ui-improvements-update.md | 2 +- blog/241004-deprecation-rules-service.md | 2 +- blog/250110-secure-linking.md | 2 +- blog/250401-bank-feeds-connections.md | 2 +- ...close-friction-overlay-in-embedded-link.md | 2 +- blog/260116-xero-pricing.md | 4 +- cspell.json | 148 +++++++++++++++++- docs/commerce/error-documentation.md | 2 +- .../learn/sfc-journal-entry-mapping.md | 2 +- .../learn/sfc-sales-product-categories.md | 4 +- docs/commerce/merchant-configuration.md | 2 +- docs/commerce/setup.md | 2 +- .../products-and-services-descriptions.md | 10 +- .../tech-implementation/consent-journey.md | 8 +- .../tech-overview/architecture/overview.md | 2 +- .../shared-responsibility-model.md | 2 +- docs/get-started/developer-resources.md | 2 +- ...unting-dynamics365businesscentral-setup.md | 2 +- .../freeagent-integration-reference.md | 2 +- docs/integrations/accounting/overview.md | 4 +- .../quickbooks-desktop-troubleshooting.md | 2 +- .../accounting/zoho-books/zoho-book-limits.md | 2 +- .../shopify/commerce-shopify-public-apps.md | 2 +- .../shopify/shopify-app-approval-checklist.md | 2 +- .../guides/loan-qualification/uw-decision.md | 2 +- .../deprecation-account-categories-api.md | 2 +- .../deprecation-account-categories-portal.md | 4 +- .../premium-products/credit-model-overview.md | 4 +- docs/payroll/overview.mdx | 2 +- docs/payroll/sync-payroll.mdx | 2 +- docs/spend-insights/guides/analyze-spend.md | 4 +- .../using-the-api/webhooks/troubleshooting.md | 2 +- 35 files changed, 193 insertions(+), 49 deletions(-) diff --git a/blog/230203-weekly-update.md b/blog/230203-weekly-update.md index e9e964b79..ebac96e48 100644 --- a/blog/230203-weekly-update.md +++ b/blog/230203-weekly-update.md @@ -5,7 +5,7 @@ tags: ["Product", "Update"] authors: mcclowes --- -A new product for easy syncing with bookkeeping software and ERPs, and other qualithy of life improvements. +A new product for easy syncing with bookkeeping software and ERPs, and other quality of life improvements. diff --git a/blog/230404-product-update-4.md b/blog/230404-product-update-4.md index 8933e5900..0d784deda 100644 --- a/blog/230404-product-update-4.md +++ b/blog/230404-product-update-4.md @@ -32,7 +32,7 @@ We've improved our data type coverage for a number of integrations. ## Deprecations -Don't forget about these immenent deprecations: +Don't forget about these imminent deprecations: - [https://docs.codat.io/updates/230411-api-keys](https://docs.codat.io/updates/230411-api-keys) - [https://docs.codat.io/updates/230411-deletion-of-data](https://docs.codat.io/updates/230411-deletion-of-data) diff --git a/blog/230710-deprecation-v2-categories.md b/blog/230710-deprecation-v2-categories.md index 5c8d15315..ef217a016 100644 --- a/blog/230710-deprecation-v2-categories.md +++ b/blog/230710-deprecation-v2-categories.md @@ -49,7 +49,7 @@ After the **24th July 2023**, the deprecated endpoints will no longer work, the :::caution Update: July 24, 2023 -**Deprecation compelted** +**Deprecation completed** ::: :::caution Update: July 13, 2023 diff --git a/blog/240925-ui-improvements-update.md b/blog/240925-ui-improvements-update.md index eccdea218..6de849491 100644 --- a/blog/240925-ui-improvements-update.md +++ b/blog/240925-ui-improvements-update.md @@ -15,7 +15,7 @@ We have revised and improved the connection flows a small business customer goes - A **clean and consistent layout and design** to provide recognizable experiences across all our linking journeys. - **Improved and simplified copy** that provides enhanced guidance to the user going through the flow. -- **Autogenerated username and password values** the user can copy and paste to remove ambuguity. +- **Autogenerated username and password values** the user can copy and paste to remove ambiguity. - **Deep links** in the linking journey take users directly to the pages they need to execute the steps of the flow. - Links to **end user documentation** that supports your customer in their journey and allows them to troubleshoot as they go. diff --git a/blog/241004-deprecation-rules-service.md b/blog/241004-deprecation-rules-service.md index 6b6fb10ae..477095f21 100644 --- a/blog/241004-deprecation-rules-service.md +++ b/blog/241004-deprecation-rules-service.md @@ -33,7 +33,7 @@ If you are currently using company-specific rules with our legacy service, use c #### Company information using tags -For example, if you previously passed company information via the webhook consumer's path (such as `POST /region/{regionId}/accounts/{accountId}`), you can use `tags` when creating or udating a company as follows: +For example, if you previously passed company information via the webhook consumer's path (such as `POST /region/{regionId}/accounts/{accountId}`), you can use `tags` when creating or updating a company as follows: ```json { diff --git a/blog/250110-secure-linking.md b/blog/250110-secure-linking.md index 1f5eccdb4..08f281440 100644 --- a/blog/250110-secure-linking.md +++ b/blog/250110-secure-linking.md @@ -42,4 +42,4 @@ If you are currently adding query parameters to Link URLs (for example, by appen #### If using Link SDK -To enforce the imited validity of Link URLs using the Link SDK, you need to retrieve an access token for your customer using the [Get company access token](/platform-api#/operations/get-company-access-token) endpoint and pass it when initializing the SDK. This serves as an equivalent to a one-time password appended to a Link URL. +To enforce the limited validity of Link URLs using the Link SDK, you need to retrieve an access token for your customer using the [Get company access token](/platform-api#/operations/get-company-access-token) endpoint and pass it when initializing the SDK. This serves as an equivalent to a one-time password appended to a Link URL. diff --git a/blog/250401-bank-feeds-connections.md b/blog/250401-bank-feeds-connections.md index 38faec508..5df90759a 100644 --- a/blog/250401-bank-feeds-connections.md +++ b/blog/250401-bank-feeds-connections.md @@ -25,4 +25,4 @@ This update is relevant for our Bank Feeds clients who use our account mapping U ## How to get started? -No action is required on your side. If you are currently using our account mapping UI in your application, the component is already avalaible to your customers. +No action is required on your side. If you are currently using our account mapping UI in your application, the component is already available to your customers. diff --git a/blog/260102-close-friction-overlay-in-embedded-link.md b/blog/260102-close-friction-overlay-in-embedded-link.md index ff95ba824..7b4561724 100644 --- a/blog/260102-close-friction-overlay-in-embedded-link.md +++ b/blog/260102-close-friction-overlay-in-embedded-link.md @@ -5,7 +5,7 @@ tags: ["Product", "Update", "Link", "UX"] authors: pmckinney --- -We've added a new exit confirmation overlay to Embedded Link. It appears when users attempt to close an in-progess connection flow, helping prevent accidental drop-offs. +We've added a new exit confirmation overlay to Embedded Link. It appears when users attempt to close an in-progress connection flow, helping prevent accidental drop-offs. diff --git a/blog/260116-xero-pricing.md b/blog/260116-xero-pricing.md index 63caa6ff1..78098cc00 100644 --- a/blog/260116-xero-pricing.md +++ b/blog/260116-xero-pricing.md @@ -23,7 +23,7 @@ The tiers each have different connection limits, included API egress usage, and Depending on your current connection volumes and API usage, you may need to: - Select a tier. - Add a payment method in [Xero’s developer portal](http://developer.xero.com/app/manage/) (required once moving beyond Starter). -- Monitor and optimise API usage to manage costs. +- Monitor and optimize API usage to manage costs. ## What you should do now To avoid disruption and ensure you’re ready ahead of March, we recommend you: @@ -31,4 +31,4 @@ To avoid disruption and ensure you’re ready ahead of March, we recommend you: - Review [Xero’s pricing and tier model](https://developer.xero.com/pricing#tier-fees-connection-limits-and-api-volume-usage). - Login to your [Xero developer app](http://developer.xero.com/app/manage/) and check your API usage. - Plan for tier selection/billing readiness ahead of March 2026. -- Please review your datasets' [sync frequency](https://docs.codat.io/using-the-api/queueing-data-syncs#sync-frequency) in the Codat portal. It is always reccomended that you only sync data as often as is essential for your use-case. +- Please review your datasets' [sync frequency](https://docs.codat.io/using-the-api/queueing-data-syncs#sync-frequency) in the Codat portal. It is always recommended that you only sync data as often as is essential for your use-case. diff --git a/cspell.json b/cspell.json index 6e32b8a19..46e7ba381 100644 --- a/cspell.json +++ b/cspell.json @@ -34,87 +34,231 @@ } ], "words": [ + "Abila", + "AEST", + "aiwb", + "AISP", "akxx", + "apologise", "API", "APIs", + "appsettings", "authentication", + "Authorise", + "authorisation", "authorization", + "autoplay", + "Authorised", + "Autres", "BACS", + "bankfeeds", + "bankstatement", + "Basiq", + "bento", "BigCommerce", + "billpayasync", + "billpaysync", + "Brex", + "brex", "Capchase", + "categorisation", "Chargebee", + "chargeback", + "chargebacks", + "Chargebacks", + "Chargify", + "chargify", + "Clearbooks", "Codat's", "Codat", + "Codats", + "Coltman", + "companyid", + "costcenters", + "createendpoint", + "Dashboarding", + "datamodel", "datasource", "datasources", "datatype", "datatypes", + "DDEP", "deauthorization", "Deauthorized", + "deauthorize", "decisioning", + "demodata", + "downloadendpoint", "drawdowns", + "drillable", + "dropoff", "dvcm", + "EBITDA", "eCommerce", "endpoint", + "endpointlink", "endpoints", + "exez", + "exgd", + "Fahey", + "familiarise", "fbrh", + "fintech", "Financials", + "fqly", "FreshBooks", + "fztf", + "GAAP", + "gamify", + "Gamify", "gbol", + "generalledgers", + "Hairosmith", "hbql", "hcws", + "HMAC", + "hostnames", + "HSTS", "iban", + "IDAS", "Intacct's", "Intacct", "Intuit's", "Intuit", + "itemised", + "Jaro", "jcrp", + "Kash", + "Kashflow", + "keyss", + "Kleppman", + "knfz", + "Knowledgebase", + "ldgh", "Lightspeed", + "listendpoint", + "lqai", + "lrhd", + "ltes", + "ltpp", + "maximise", + "maximises", + "Maximising", + "maximising", "Maxio", "metadata", + "miscategorized", + "MNDA", + "Mobbin", + "monetise", + "Monzo", + "mqjo", + "multicurrency", + "Multitenant", + "mybank", "MYOB", + "myshopify", "ndsk", "neobanks", "NetSuite", + "OBWAC", "olpr", + "optimise", + "Organisation", + "Organisations", + "organised", + "otherreceipt", "Pandle", "payables", + "paymentmethod", + "payrun", + "payruns", "pbbf", + "pbtz", "pdvj", + "permissioned", "Phorest", + "PISP", "pqsw", "Presta", "PrestaShop", + "prioritise", "qhyg", + "qkdj", "Qualys", "qudb", + "QWAC", "QuickBooks", + "quickbooksdesktop", "recategorization", "recategorize", "Recategorize", "recategorizing", "Recategorizing", "Recurly", + "Rightworks", + "Rockstar", + "RPMT", + "rqwd", "rvam", + "rwuv", + "SCHG", + "SCPN", + "SDLC", "SDK", "SDKs", + "shipto", + "signum", + "skillset", + "Standardised", + "subjournals", + "sumup", + "suuo", "Svix", + "synchronisation", + "Synchronisation", + "synchronisations", + "synchronise", + "synchronising", + "textkey", + "textkeys", "tgff", + "THHMMSS", "trji", "TrueLayer's", "TrueLayer", + "ugxp", + "upvr", "usecase", "usecases", + "utilising", + "Venmo", + "Vipps", + "vipps", + "VNDDEFAULT", + "vqzp", "vxvy", "Wayflyer", + "Webroot", + "Webservice", + "Webservices", + "webhookratelimits", "webhook", "webhooks", + "Winkler", + "workstream", + "workstreams", "worksream", "writeback", "Writeback", + "xcwv", + "XLSB", "Xero's", "Xero", + "YNAB", + "yzth", "Zettle", - "zpqy" + "zpqy", + "zsth" ] -} \ No newline at end of file +} diff --git a/docs/commerce/error-documentation.md b/docs/commerce/error-documentation.md index 88e858bf7..20e05ab71 100644 --- a/docs/commerce/error-documentation.md +++ b/docs/commerce/error-documentation.md @@ -43,7 +43,7 @@ This section describes the errors that are related to Sync for Commerce configur | Payments config invalid. `{prepaid account}` should not match `{prepaid payment account}`.
Accounts config invalid. Prepaid account in Sales should not match `{CommerceAccountType. PrepaidPayment}` in Payments." | The prepaid account and the payment account should not be the same.
Reconfigure the selected accounts for prepaid and prepaid payments. | | Payments config invalid. `{Card Acount}` should not match `{Payout Account}`. | This error surfaces if the account selected for Payments matches the payout account.
Reconfigure the selected accounts for payments and payouts. | | No sales customer has been configured. | This error surfaces if the sales customer is missing from the configuration.
Configure the sales customer from the available options on the config options. | -| Selected customer not present in customer options. | This error surfaces if the configured sales customer does not match a valid `customerId` present in the `customerOptions`.
**Note**: The `customerOptions` are customer records fetched from the merchant's accounting software.
During the onfiguration, select from the available options under the `customerOptions` on the Codat configuration API. `selectedCustomerId` must always match with a record surfaced in the `customerOptions` objects. | +| Selected customer not present in customer options. | This error surfaces if the configured sales customer does not match a valid `customerId` present in the `customerOptions`.
**Note**: The `customerOptions` are customer records fetched from the merchant's accounting software.
During the configuration, select from the available options under the `customerOptions` on the Codat configuration API. `selectedCustomerId` must always match with a record surfaced in the `customerOptions` objects. | | Selected Account is not a valid option. | The `selectedAccountId` value for the nominal account for `paymentFees` configuration is not from the list of nominal accounts surfaced under `accountOptions` or is an invalid value.
During the configuration, only select from the available options under `accountOptions` on the Codat configuration API. `selectedAccountId` must always match a valid record surfaced in the `accountOptions` objects. | | No grouping period selected.
Grouping period selected not from options. | Merchants should be able to configure grouping for their invoices. In Sync for Commerce, grouping is done by time (daily) and by country/location of orders.
**Note**: At the time of writing, the only time-based grouping option available is **daily**. This means all orders of a day would be grouped into a daily invoice.
During the configuration, the grouping object in the config API has `groupingPeriod.selectedGroupingPeriod `must have a value available from the `groupingPeriodOptions`.
If in the grouping object in the config API the `groupingPeriod.selectedGroupingPeriod` is set to null, an error surfaces stating there's no grouping period selected.
If the grouping object is set to any value that is not from the `groupingPeriodOptions`, then an error is thrown stating that the value was not selected from the available options.
Update the configuration on the Codat configuration API with a valid grouping period option. | | Invalid invoice level grouping selected. | Merchants should be able to configure grouping for their invoices. In Sync for Commerce, grouping is done by time (daily) and by country/location of orders.
This error surfaces for the locations-based grouping where `selectedGroupByOptions` value is not from `groupByOptions`.
During the configuration, the grouping object in the config API has `groupingLevels.invoiceLevels. selectedGroupByOptions` must have a value available from the `groupByOptions`.
Update the configuration on the Codat configuration API with a valid invoice-level grouping option. | diff --git a/docs/commerce/learn/sfc-journal-entry-mapping.md b/docs/commerce/learn/sfc-journal-entry-mapping.md index 6b54c4119..d1e5d7c17 100644 --- a/docs/commerce/learn/sfc-journal-entry-mapping.md +++ b/docs/commerce/learn/sfc-journal-entry-mapping.md @@ -78,7 +78,7 @@ The example journal entry covers a refund issued as a credit note. This includes ### Daily aggregated sales journal entry -The example journal entry covers payment processing fees and payment fees refunds, including orders total of £1000, tax total of £200, gratuities/tips of £50, payment processing fee of £60, and payment processsing refund of £30. +The example journal entry covers payment processing fees and payment fees refunds, including orders total of £1000, tax total of £200, gratuities/tips of £50, payment processing fee of £60, and payment processing refund of £30. | Account | Account type | Debits | Credits | | :------------------- | :------------------ | :----- | :------ | diff --git a/docs/commerce/learn/sfc-sales-product-categories.md b/docs/commerce/learn/sfc-sales-product-categories.md index 97e130c4e..45b13bf0a 100644 --- a/docs/commerce/learn/sfc-sales-product-categories.md +++ b/docs/commerce/learn/sfc-sales-product-categories.md @@ -22,7 +22,7 @@ Before the feature switch is toggled on, the Sync Flow UI displays a Sales categ alt="Sync Flow with standard sales categories" /> -Once you enable the feature, an additional category mapping page is added to the Sync Flow. It replaces the Sales category with a breakdown of mapping options for each [product category you created](/commerce/learn/sfc-sales-product-categories#congifure-sales-categories). We also provide a catch-all “Other sales” category that does not need to be created separately. +Once you enable the feature, an additional category mapping page is added to the Sync Flow. It replaces the Sales category with a breakdown of mapping options for each [product category you created](/commerce/learn/sfc-sales-product-categories#configure-sales-categories). We also provide a catch-all “Other sales” category that does not need to be created separately. In this example, we break down sales into courses, products, and services. @@ -38,7 +38,7 @@ The account mapping page for standard categories is available on the next page o alt="Standard categories with sales categorization enabled" /> -## Congifure sales categories +## Configure sales categories Ensure the categorization mapping feature has been enabled for your client. diff --git a/docs/commerce/merchant-configuration.md b/docs/commerce/merchant-configuration.md index 5301c1742..116bdd320 100644 --- a/docs/commerce/merchant-configuration.md +++ b/docs/commerce/merchant-configuration.md @@ -42,7 +42,7 @@ You can implement your own UI to capture a merchant's desired sync configuration Customization options available for the configuration UI include: -- Branding, including your company name, logo, icon and brand colours +- Branding, including your company name, logo, icon and brand colors - Text content of the Sync configuration UI :::tip Further UI customization diff --git a/docs/commerce/setup.md b/docs/commerce/setup.md index 9ad532cfa..c6b6be37f 100644 --- a/docs/commerce/setup.md +++ b/docs/commerce/setup.md @@ -163,7 +163,7 @@ You will need to populate parameter values as follows: - `commerceKey`: the `platformKey` of the commerce software selected by the user in your UI - `accountingKey`: refers to the Codat connector. Your Solutions Engineer will provide this to you -- `yourMerchantIdenfifier`: your unique identifier for your customer +- `yourMerchantIdentifier`: your unique identifier for your customer diff --git a/docs/configure/plans/products-and-services-descriptions.md b/docs/configure/plans/products-and-services-descriptions.md index 5753e0165..48d8cc521 100644 --- a/docs/configure/plans/products-and-services-descriptions.md +++ b/docs/configure/plans/products-and-services-descriptions.md @@ -41,7 +41,7 @@ Implementation period, covering Implementation Specialists and associated resour #### Supported integrations -[See supported intergrations in our documentation](https://docs.codat.io/commerce/setup#available-integrations). +[See supported integrations in our documentation](https://docs.codat.io/commerce/setup#available-integrations). **Note:** A separate Add on is required to access ERP integrations and Desktop platforms. @@ -78,7 +78,7 @@ This product will appear as **Sync for Commerce (v2)** on your order form. #### Supported integrations -[See supported intergrations in our documentation](https://docs.codat.io/expenses/overview#supported-integrations). +[See supported integrations in our documentation](https://docs.codat.io/expenses/overview#supported-integrations). **Note:** A separate Add on is required to access ERP integrations and Desktop platforms. @@ -109,7 +109,7 @@ This product will appear as **Sync for Expenses (v2)** on your order form. #### Supported integrations -[See supported intergrations in our documentation](https://docs.codat.io/payroll/overview#compatible-integrations). +[See supported integrations in our documentation](https://docs.codat.io/payroll/overview#compatible-integrations). **Note:** A separate Add on is required to access ERP integrations and Desktop platforms. @@ -144,7 +144,7 @@ This product will appear as **Sync for Payroll** on your order form. #### Supported integrations -[See supported intergrations in our documentation](https://docs.codat.io/payables/overview#compatible-integrations). +[See supported integrations in our documentation](https://docs.codat.io/payables/overview#compatible-integrations). **Note:** A separate Add on is required to access ERP integrations and Desktop platforms. @@ -184,7 +184,7 @@ This product will appear as **Sync for Payables** on your order form. #### Supported integrations -[See supported intergrations in our documentation](https://docs.codat.io/bank-feeds/overview#supported-integrations). +[See supported integrations in our documentation](https://docs.codat.io/bank-feeds/overview#supported-integrations). **Note:** A separate Add on is required to access ERP integrations and Desktop platforms. diff --git a/docs/enterprise/tech-implementation/consent-journey.md b/docs/enterprise/tech-implementation/consent-journey.md index 3018478cf..e1e3e0953 100644 --- a/docs/enterprise/tech-implementation/consent-journey.md +++ b/docs/enterprise/tech-implementation/consent-journey.md @@ -20,7 +20,7 @@ To address this, Codat provides you with Link, our consent and authorization jou We prepared a consent journey prototype using an example business insights dashboard use case. -[View the protype in full screen →](https://www.figma.com/proto/YWkKvsYgeHJskPsfuIpy7w/Codat---Generic-bank---Consent-Journey?page-id=601%3A4488&type=design&node-id=641-11421&viewport=1275%2C-2886%2C0.1&t=rrDznIIhmQ8EayyY-1&scaling=contain&starting-point-node-id=641%3A11421&mode=design) +[View the prototype in full screen →](https://www.figma.com/proto/YWkKvsYgeHJskPsfuIpy7w/Codat---Generic-bank---Consent-Journey?page-id=601%3A4488&type=design&node-id=641-11421&viewport=1275%2C-2886%2C0.1&t=rrDznIIhmQ8EayyY-1&scaling=contain&starting-point-node-id=641%3A11421&mode=design) ::: @@ -58,8 +58,8 @@ Review the key steps and endpoints involved in a build-your-own consent journey. | 6 | Customer authorizes access | Application directs user to the ‘linkURL’ where customer authenticates and authorizes access to data | | 7 | Customer is redirected to application | Customer's consent journey finishes on a confirmation screen of the application | | **Ongoing management:** | -| 8 | Customer wants to connect an additional package at a later date | Customer clicks on button within appication to connect an additional package. Application places a call to Link's `POST Create connection` with a `companyId` to create connection and provide `linkURL` | -| 9 | Customer wants to disconnect an existing package | Customer clicks on a “Disconnect” button within appication. Application places a call to Link's `DELETE Delete connection` | +| 8 | Customer wants to connect an additional package at a later date | Customer clicks on button within application to connect an additional package. Application places a call to Link's `POST Create connection` with a `companyId` to create connection and provide `linkURL` | +| 9 | Customer wants to disconnect an existing package | Customer clicks on a “Disconnect” button within application. Application places a call to Link's `DELETE Delete connection` | @@ -135,7 +135,7 @@ Link, Codat’s authentication solution, is used at multiple stages of the custo - **How does Codat secure the connection with the underlying packages?** - Codat uses OAuth 2.0 to facilitate the consent and authentication process between Codat and each software integratoion. Our documentation contains details of our approach to [Data security](/enterprise/tech-overview/security/data-security), and our [Help Hub](https://help.codat.io/resources/about#how-we-access-your-data) contains customer-centric responses to security concerns. + Codat uses OAuth 2.0 to facilitate the consent and authentication process between Codat and each software integration. Our documentation contains details of our approach to [Data security](/enterprise/tech-overview/security/data-security), and our [Help Hub](https://help.codat.io/resources/about#how-we-access-your-data) contains customer-centric responses to security concerns. - **How does the user log in?** diff --git a/docs/enterprise/tech-overview/architecture/overview.md b/docs/enterprise/tech-overview/architecture/overview.md index e0627f7e4..909728ed1 100644 --- a/docs/enterprise/tech-overview/architecture/overview.md +++ b/docs/enterprise/tech-overview/architecture/overview.md @@ -23,7 +23,7 @@ You can see the overview of Codat's networking flow topology on the image below. Codat uses the [Microsoft Azure](https://azure.microsoft.com/en-us/) platform for all hosting and data storage, located in the UK only. Microsoft Azure is a growing collection of integrated cloud services that developers and IT professionals use to build, deploy, and manage applications through a global network of data centres. -In particular, Codat uses Azure’s [Platform as a service (PaaS)](https://azure.microsoft.com/en-gb/overview/what-is-paas/) offering. It includes hosting, networking, and storage infrastracture as well as middleware, development tools, and other resources required to support a complete web application lifecycle. +In particular, Codat uses Azure’s [Platform as a service (PaaS)](https://azure.microsoft.com/en-gb/overview/what-is-paas/) offering. It includes hosting, networking, and storage infrastructure as well as middleware, development tools, and other resources required to support a complete web application lifecycle. This allows Codat to focus on the services we create while Microsoft manages the underlying application infrastructure and automatically patches the operating system, maintaining them to the highest standard. diff --git a/docs/enterprise/tech-overview/architecture/shared-responsibility-model.md b/docs/enterprise/tech-overview/architecture/shared-responsibility-model.md index 79c2c4da8..654218c52 100644 --- a/docs/enterprise/tech-overview/architecture/shared-responsibility-model.md +++ b/docs/enterprise/tech-overview/architecture/shared-responsibility-model.md @@ -7,7 +7,7 @@ hide_table_of_contents: false Operations at Codat are performed entirely on cloud hosted platforms. As such, responsibilities vary across layers of the stack. You can see Microsoft's approach to dividing responsibility in the cloud below. ![Microsoft's division of responsibility in the cloud](ms-shared-responsibility.svg) -## Resposibilities by party +## Responsibilities by party The following tables articulate the responsible parties at each layer of our [platform as a service](/enterprise/tech-overview/architecture/platform-as-a-service) offering and the details of their implementation. diff --git a/docs/get-started/developer-resources.md b/docs/get-started/developer-resources.md index b3112ed16..ddb2e680b 100644 --- a/docs/get-started/developer-resources.md +++ b/docs/get-started/developer-resources.md @@ -9,7 +9,7 @@ updatedAt: "2022-10-19T21:11:21.969Z" - **[Invoice finance](/lending/guides/invoice-finance/introduction)** - Go through the invoice financing process flow, from establishing a connection with a borrower's accounting software to issuing a decision on selected invoices. - **[Bill pay](/payables/guides/bill-pay/introduction)** - Streamline and automate the Accounts Payable (AP) process for your SMB customers. -- **[Bank transactions reconcilliation](/bank-feeds/guides/bank-feeds-tutorial)** - Reconciling bank transactions with QuickBooks Online using Codat's Bank Feeds solution. +- **[Bank transactions reconciliation](/bank-feeds/guides/bank-feeds-tutorial)** - Reconciling bank transactions with QuickBooks Online using Codat's Bank Feeds solution. - **[Loan writeback](/lending/guides/loan-writeback/introduction)** - Simplify your implementation with our loan writeback best practices guide and correctly account for a loan programmatically. - **[Loan qualification](/lending/guides/loan-qualification/introduction)** - See how Codat helps check a loan applicant’s finances and automate decision-making. - **[Prototype dashboard with Retool](/guides/retool-dashboard)** - Ingest and visualize Codat data in a custom Retool dashboard in 10 minutes. diff --git a/docs/integrations/accounting/dynamics365businesscentral/accounting-dynamics365businesscentral-setup.md b/docs/integrations/accounting/dynamics365businesscentral/accounting-dynamics365businesscentral-setup.md index 5005850f9..1c15b82dc 100644 --- a/docs/integrations/accounting/dynamics365businesscentral/accounting-dynamics365businesscentral-setup.md +++ b/docs/integrations/accounting/dynamics365businesscentral/accounting-dynamics365businesscentral-setup.md @@ -26,7 +26,7 @@ For more information, see [Extension installation process](/integrations/account ## Prerequisites -A Dynamics 365 Business Central license is required to use our integration. At a minimum, you'll need a Dynamics 365 Business Central Essentials license.

For more information, see the Business Central pricing page for your region.

+A Dynamics 365 Business Central license is required to use our integration. At a minimum, you'll need a Dynamics 365 Business Central Essentials license.

For more information, see the Business Central pricing page for your region.

We also assume that your organization already has its Microsoft account configured, and the domain name in your account email has been [DNS-verified](https://learn.microsoft.com/en-us/azure/active-directory/enterprise-users/domains-admin-takeover#internal-admin-takeover). If you are creating an account for the very first time, you may need to [create a tenant for your organization](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/create-new-tenant#create-a-new-tenant-for-your-organization) and [verify the domain](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/add-custom-domain). diff --git a/docs/integrations/accounting/freeagent/freeagent-integration-reference.md b/docs/integrations/accounting/freeagent/freeagent-integration-reference.md index 0924fb5d3..a2a42597d 100644 --- a/docs/integrations/accounting/freeagent/freeagent-integration-reference.md +++ b/docs/integrations/accounting/freeagent/freeagent-integration-reference.md @@ -18,7 +18,7 @@ When writing Direct costs, the currency of the created object will be the same a You should be aware of the following behavior when writing Direct costs with tax: -- If `lineItems.taxAmount` is specified, and the account is taxable, the default tax rate for the account is ignored and overidden by this amount. +- If `lineItems.taxAmount` is specified, and the account is taxable, the default tax rate for the account is ignored and overridden by this amount. - If `lineItems.taxAmount` is not specified, the default tax rate for the account in FreeAgent is applied (this is set on account creation) - To write a zero tax amount, set `lineItems.taxAmount` to `0`. diff --git a/docs/integrations/accounting/overview.md b/docs/integrations/accounting/overview.md index 65f3c6094..db9200d38 100644 --- a/docs/integrations/accounting/overview.md +++ b/docs/integrations/accounting/overview.md @@ -43,12 +43,12 @@ Some integrations have more complex requirements in terms of registration and pa | [Sage 200 Cloud](https://www.sage.com/en-gb/products/sage-200/) | Hard | ❌ | ❌ | New partners are approved manually within several days after registration. Contact your solutions engineer in case of complications. | | [Wave](https://www.waveapps.com/) | Easy | ❌ | ❌ | Registrations completed before July 2022 need to request partner status via wave@codat.io to access profit & loss and balance sheet report. The reports are enabled by default for registrations completed after July 2022. | | [Workday](https://www.workday.com/) | Registration not required | ✅ | None known | This integration is only supported by our [Spend Insights](/spend-insights/overview) solution. | -| [Xero](https://www.xero.com/) | Easy | ✅ | ✅ | You must certify your integration and partner with Xero to connect more than 25 companies. This involves extra technical requirements and, in some cases, additional charges. Use cases such as financial brokering, insurance, FX hending, and lending (in some regions) are not permitted. | +| [Xero](https://www.xero.com/) | Easy | ✅ | ✅ | You must certify your integration and partner with Xero to connect more than 25 companies. This involves extra technical requirements and, in some cases, additional charges. Use cases such as financial brokering, insurance, FX hedging, and lending (in some regions) are not permitted. | | [Zoho Books](https://www.zoho.com/uk/books/) | Easy | ✅ | ❌ | | ## Accounting software per region -Most popular accounting software per reigion are as follows: +Most popular accounting software per region are as follows: - **US:** QuickBooks Online, QuickBooks Desktop, Sage Intacct, NetSuite, FreshBooks, Xero - **UK:** Xero, QuickBooks Online, Sage 50, Sage Accounting, FreeAgent, NetSuite diff --git a/docs/integrations/accounting/quickbooksdesktop/quickbooks-desktop-troubleshooting.md b/docs/integrations/accounting/quickbooksdesktop/quickbooks-desktop-troubleshooting.md index 88d254609..1d1422cb4 100644 --- a/docs/integrations/accounting/quickbooksdesktop/quickbooks-desktop-troubleshooting.md +++ b/docs/integrations/accounting/quickbooksdesktop/quickbooks-desktop-troubleshooting.md @@ -65,7 +65,7 @@ Once connector is installed and configured, you can only sync data with QuickBoo - The user's machine is turned off. - The user has closed the web connector (including hitting the "X" in the top right of the web connector window). -- The user has multiple instances of QuickBooks Desktop running, i.e. connected to multiple company files (this functionaility is available in Enterprise edition only). +- The user has multiple instances of QuickBooks Desktop running, i.e. connected to multiple company files (this functionality is available in Enterprise edition only). ## QuickBooks Desktop is not opening diff --git a/docs/integrations/accounting/zoho-books/zoho-book-limits.md b/docs/integrations/accounting/zoho-books/zoho-book-limits.md index 6307ce0a2..8223d47b6 100644 --- a/docs/integrations/accounting/zoho-books/zoho-book-limits.md +++ b/docs/integrations/accounting/zoho-books/zoho-book-limits.md @@ -46,7 +46,7 @@ The daily rate is shared between all API requests made to an organization from a #### Per-minute rate limit -Zoho Books usesrs can make about 100 API calls per minute for each organization — the _per-minute rate limit_. +Zoho Books users can make about 100 API calls per minute for each organization — the _per-minute rate limit_. This rate limit can affect the performance of the integration when reading data from and writing to Zoho Books. diff --git a/docs/integrations/commerce/shopify/commerce-shopify-public-apps.md b/docs/integrations/commerce/shopify/commerce-shopify-public-apps.md index 67f97912d..43ca8ee55 100644 --- a/docs/integrations/commerce/shopify/commerce-shopify-public-apps.md +++ b/docs/integrations/commerce/shopify/commerce-shopify-public-apps.md @@ -14,7 +14,7 @@ This article explains how to set up the Shopify integration using the _public ap - [Create a Shopify app](/integrations/commerce/shopify/commerce-shopify-public-apps#create-a-public-shopify-app) - [Submit your app to Shopify for approval](/integrations/commerce/shopify/commerce-shopify-public-apps#submit-your-app-to-shopify-for-approval) -- [Buid an app for merchant authorization](/integrations/commerce/shopify/commerce-shopify-public-apps#build-an-app-for-merchant-authorization) +- [Build an app for merchant authorization](/integrations/commerce/shopify/commerce-shopify-public-apps#build-an-app-for-merchant-authorization) - [Add your app's credentials to the Shopify integration](/integrations/commerce/shopify/commerce-shopify-public-apps#add-your-apps-credentials-to-the-shopify-integration) - [Enable the Shopify integration](/integrations/commerce/shopify/commerce-shopify-public-apps#enable-the-shopify-integration) - [Check the commerce sync settings](/integrations/commerce/shopify/commerce-shopify-public-apps#check-the-commerce-sync-settings) diff --git a/docs/integrations/commerce/shopify/shopify-app-approval-checklist.md b/docs/integrations/commerce/shopify/shopify-app-approval-checklist.md index 39e0a529e..b3b148638 100644 --- a/docs/integrations/commerce/shopify/shopify-app-approval-checklist.md +++ b/docs/integrations/commerce/shopify/shopify-app-approval-checklist.md @@ -27,7 +27,7 @@ Requirements Contains setup instructions if required Avoid pop ups 3. Functionality and quality - A user interface is required, inluding buttons, controls and any setup instructions + A user interface is required, including buttons, controls and any setup instructions If any charges then it uses the Shopify Billing API Testing credentials included Able to be tested and working diff --git a/docs/lending/guides/loan-qualification/uw-decision.md b/docs/lending/guides/loan-qualification/uw-decision.md index b2e0da893..b46f9b6f6 100644 --- a/docs/lending/guides/loan-qualification/uw-decision.md +++ b/docs/lending/guides/loan-qualification/uw-decision.md @@ -38,7 +38,7 @@ Its threshold is maintained as `RevenueThreshold` in `appsettings.json`. In the - + The gearing ratio used in the example model is the **debt ratio**, calculated by dividing total debt by total assets. It uses the [`balanceSheet`](https://docs.codat.io/assess-api#/operations/get-enhanced-balance-sheet) endpoint and its `Asset` and `Liability.NonCurrent.LoansPayable` values. Having too much debt may indicate a higher financial risk associated with the company. diff --git a/docs/lending/guides/migration-guides/deprecation-account-categories-api.md b/docs/lending/guides/migration-guides/deprecation-account-categories-api.md index dca385e5d..94de2f116 100644 --- a/docs/lending/guides/migration-guides/deprecation-account-categories-api.md +++ b/docs/lending/guides/migration-guides/deprecation-account-categories-api.md @@ -17,7 +17,7 @@ The following endpoints will stop working: PATCH /data/companies/{companyId}/connections/{connectionId}/lending/accounts/categories PATCH /data/companies/{companyId}/connections/{connectionId}/lending/accounts/{accountId}/categories GET /data/companies{companyId}/connections/{connectionId}/lending/enhancedBalanceSheet - GET /data/companies{companyId}/connections/{connectionId}/lending/enhancedProfitandLoss + GET /data/companies{companyId}/connections/{connectionId}/lending/enhancedProfitAndLoss GET /data/companies/{companyId}/connections/{connectionId}/lending/financialMetrics GET /data/companies/{companyId}/connections/{connectionId}/lending/accountingMetrics/marketing diff --git a/docs/lending/guides/migration-guides/deprecation-account-categories-portal.md b/docs/lending/guides/migration-guides/deprecation-account-categories-portal.md index 4ae2d002c..a44e42a9c 100644 --- a/docs/lending/guides/migration-guides/deprecation-account-categories-portal.md +++ b/docs/lending/guides/migration-guides/deprecation-account-categories-portal.md @@ -17,8 +17,8 @@ The following features in the **Assess** section of the portal will no longer be | **Balance sheet** | ![Screenshot of Balance sheet screen that's being deprecated in Assess](/img/lending/balance-sheet.png) | | **Ratios**

**Note**: These appear at the end of the Profit and Loss and Balance Sheet tabs | ![Screenshot of Ratios screen that's being deprecated in Assess](/img/lending/financial-ratios.png) | | **Marketing** | ![Screenshot of Marketing screen that's being deprecated in Assess](/img/lending/marketing-screen-assess.png) | -| **Categorize accounts in Assess**

**Note**: We have new screens available for recategozing accounts using the latest categories. | ![Screenshot of categorize accounts screen that's being deprecated](/img/lending/account-categorization-v2.png) | -| **Categorize accounts in Accounting API**

**Note**: We have new screens available for recategozing accounts using the latest categories. | ![Screenshot of categorize accounts screen that's being deprecated](/img/lending/accounting-api-account-categorisation.png) | +| **Categorize accounts in Assess**

**Note**: We have new screens available for recategorizing accounts using the latest categories. | ![Screenshot of categorize accounts screen that's being deprecated](/img/lending/account-categorization-v2.png) | +| **Categorize accounts in Accounting API**

**Note**: We have new screens available for recategorizing accounts using the latest categories. | ![Screenshot of categorize accounts screen that's being deprecated](/img/lending/accounting-api-account-categorisation.png) | ## Alternative options diff --git a/docs/lending/premium-products/credit-model-overview.md b/docs/lending/premium-products/credit-model-overview.md index e05ae4b0d..51ca9feaa 100644 --- a/docs/lending/premium-products/credit-model-overview.md +++ b/docs/lending/premium-products/credit-model-overview.md @@ -152,8 +152,8 @@ We recommend you [subscribe to the following webhooks](/using-the-api/webhooks/c - [`reports.creditModel.generate.successful`](/lending-api#/webhooks/reports.creditModel.generate.successful/post) - Thia webhook will notify you once the report successfully generates. + This webhook will notify you once the report successfully generates. - [`reports.creditModel.generate.unsuccessful`](/lending-api#/webhooks/reports.creditModel.generate.unsuccessful/post) - Thia webhook will notify you if the report generation fails. + This webhook will notify you if the report generation fails. diff --git a/docs/payroll/overview.mdx b/docs/payroll/overview.mdx index f24fdaf16..cb89ba4ee 100644 --- a/docs/payroll/overview.mdx +++ b/docs/payroll/overview.mdx @@ -54,7 +54,7 @@ flowchart LR end end subgraph Ongoing syncing - E["Run payroll"] --> F["Create journal entry in accounting platofrm"] + E["Run payroll"] --> F["Create journal entry in accounting platform"] D -.-> E end ``` diff --git a/docs/payroll/sync-payroll.mdx b/docs/payroll/sync-payroll.mdx index 01d456d20..1addbb6f7 100644 --- a/docs/payroll/sync-payroll.mdx +++ b/docs/payroll/sync-payroll.mdx @@ -40,7 +40,7 @@ sequenceDiagram codat -->> app: Valid data type model end - app ->> codat: Creat journalEntry to represent payroll + app ->> codat: Create journalEntry to represent payroll codat -->> app: pushOperation key codat -->> app: pushOperation status webhook diff --git a/docs/spend-insights/guides/analyze-spend.md b/docs/spend-insights/guides/analyze-spend.md index df9c8299c..23bb54043 100644 --- a/docs/spend-insights/guides/analyze-spend.md +++ b/docs/spend-insights/guides/analyze-spend.md @@ -201,7 +201,7 @@ Codat has enhanced the Spend Insights solution capability with an AI agent that If your organization has opted to use this feature, you will see a **Lightbulb** icon next to your customer's name on the **Spend Insights** tab of the Codat Portal. Simply click on the button to be directed to Codat's Spend Insights Chat. -![An image of three companies on the Spend Insights tab. A lightbulb icon is visible and highlighted next to aevery company entry.](/img/spend-insights/si-si-chat-lightbulb.png) +![An image of three companies on the Spend Insights tab. A lightbulb icon is visible and highlighted next to every company entry.](/img/spend-insights/si-si-chat-lightbulb.png) The Spend Insights Chat provides three key interaction areas: @@ -209,4 +209,4 @@ The Spend Insights Chat provides three key interaction areas: - Navigate previous conversations with the Spend Insights agent or start new ones via the _Conversations_ section. - Carry the current conversation with the agent in the _Main_ section of the screen, using prompts or writing out the questions. -![An image of three companies on the Spend Insights tab. A lightbulb icon is visible and highlighted next to aevery company entry.](/img/spend-insights/si-si-chat-interface.png) +![An image of three companies on the Spend Insights tab. A lightbulb icon is visible and highlighted next to every company entry.](/img/spend-insights/si-si-chat-interface.png) diff --git a/docs/using-the-api/webhooks/troubleshooting.md b/docs/using-the-api/webhooks/troubleshooting.md index 45242036a..bc0bc8057 100644 --- a/docs/using-the-api/webhooks/troubleshooting.md +++ b/docs/using-the-api/webhooks/troubleshooting.md @@ -67,7 +67,7 @@ Then, click the triple-dot menu on the right and choose one of the applicable op For more granular date control, you can scroll to the endpoint's message attempts, click the triple-dot options menu of a specific message, and choose **Replay > Replay all failed messages since this time**. -During the recovery of mutiple messages, we will send all messages at once, applying some delay between messages. This is to prevent overloading the webhook consumer endpoint. If your system has rate limiting in place, consider this scenario to avoid further failures. See details of [webhook endpoint rate limiting](/using-the-api/webhooks/create-consumer#endpoint-rate-limits). +During the recovery of multiple messages, we will send all messages at once, applying some delay between messages. This is to prevent overloading the webhook consumer endpoint. If your system has rate limiting in place, consider this scenario to avoid further failures. See details of [webhook endpoint rate limiting](/using-the-api/webhooks/create-consumer#endpoint-rate-limits). ### Idempotency From 2f1ef164da7a4884393012f2dbb73f207ddf1027 Mon Sep 17 00:00:00 2001 From: pmckinney-codat Date: Thu, 5 Feb 2026 17:16:37 +0000 Subject: [PATCH 2/5] Fix markdown again --- blog/260116-xero-pricing.md | 2 +- docs/commerce/error-documentation.md | 2 +- .../tech-implementation/consent-journey.md | 18 +++++++++--------- .../deprecation-account-categories-portal.md | 12 ++++++------ 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/blog/260116-xero-pricing.md b/blog/260116-xero-pricing.md index f2801abce..20a96503c 100644 --- a/blog/260116-xero-pricing.md +++ b/blog/260116-xero-pricing.md @@ -34,4 +34,4 @@ To avoid disruption and ensure you’re ready ahead of March, we recommend you: - Review [Xero’s pricing and tier model](https://developer.xero.com/pricing#tier-fees-connection-limits-and-api-volume-usage). - Login to your [Xero developer app](http://developer.xero.com/app/manage/) and check your API usage. - Plan for tier selection/billing readiness ahead of March 2026. -- Please review your datasets' [sync frequency](https://docs.codat.io/using-the-api/queueing-data-syncs#sync-frequency) in the Codat portal. It is always recommended that you only sync data as often as is essential for your use-case. \ No newline at end of file +- Please review your datasets' [sync frequency](https://docs.codat.io/using-the-api/queueing-data-syncs#sync-frequency) in the Codat portal. It is always recommended that you only sync data as often as is essential for your use-case. diff --git a/docs/commerce/error-documentation.md b/docs/commerce/error-documentation.md index 20e05ab71..e0a11970c 100644 --- a/docs/commerce/error-documentation.md +++ b/docs/commerce/error-documentation.md @@ -43,7 +43,7 @@ This section describes the errors that are related to Sync for Commerce configur | Payments config invalid. `{prepaid account}` should not match `{prepaid payment account}`.
Accounts config invalid. Prepaid account in Sales should not match `{CommerceAccountType. PrepaidPayment}` in Payments." | The prepaid account and the payment account should not be the same.
Reconfigure the selected accounts for prepaid and prepaid payments. | | Payments config invalid. `{Card Acount}` should not match `{Payout Account}`. | This error surfaces if the account selected for Payments matches the payout account.
Reconfigure the selected accounts for payments and payouts. | | No sales customer has been configured. | This error surfaces if the sales customer is missing from the configuration.
Configure the sales customer from the available options on the config options. | -| Selected customer not present in customer options. | This error surfaces if the configured sales customer does not match a valid `customerId` present in the `customerOptions`.
**Note**: The `customerOptions` are customer records fetched from the merchant's accounting software.
During the configuration, select from the available options under the `customerOptions` on the Codat configuration API. `selectedCustomerId` must always match with a record surfaced in the `customerOptions` objects. | +| Selected customer not present in customer options. | This error surfaces if the configured sales customer does not match a valid `customerId` present in the `customerOptions`.
**Note**: The `customerOptions` are customer records fetched from the merchant's accounting software.
During the configuration, select from the available options under the `customerOptions` on the Codat configuration API. `selectedCustomerId` must always match with a record surfaced in the `customerOptions` objects. | | Selected Account is not a valid option. | The `selectedAccountId` value for the nominal account for `paymentFees` configuration is not from the list of nominal accounts surfaced under `accountOptions` or is an invalid value.
During the configuration, only select from the available options under `accountOptions` on the Codat configuration API. `selectedAccountId` must always match a valid record surfaced in the `accountOptions` objects. | | No grouping period selected.
Grouping period selected not from options. | Merchants should be able to configure grouping for their invoices. In Sync for Commerce, grouping is done by time (daily) and by country/location of orders.
**Note**: At the time of writing, the only time-based grouping option available is **daily**. This means all orders of a day would be grouped into a daily invoice.
During the configuration, the grouping object in the config API has `groupingPeriod.selectedGroupingPeriod `must have a value available from the `groupingPeriodOptions`.
If in the grouping object in the config API the `groupingPeriod.selectedGroupingPeriod` is set to null, an error surfaces stating there's no grouping period selected.
If the grouping object is set to any value that is not from the `groupingPeriodOptions`, then an error is thrown stating that the value was not selected from the available options.
Update the configuration on the Codat configuration API with a valid grouping period option. | | Invalid invoice level grouping selected. | Merchants should be able to configure grouping for their invoices. In Sync for Commerce, grouping is done by time (daily) and by country/location of orders.
This error surfaces for the locations-based grouping where `selectedGroupByOptions` value is not from `groupByOptions`.
During the configuration, the grouping object in the config API has `groupingLevels.invoiceLevels. selectedGroupByOptions` must have a value available from the `groupByOptions`.
Update the configuration on the Codat configuration API with a valid invoice-level grouping option. | diff --git a/docs/enterprise/tech-implementation/consent-journey.md b/docs/enterprise/tech-implementation/consent-journey.md index f243912af..40a657dff 100644 --- a/docs/enterprise/tech-implementation/consent-journey.md +++ b/docs/enterprise/tech-implementation/consent-journey.md @@ -47,16 +47,16 @@ Codat's Link solution covers a series of API endpoints that you can use to fully Review the key steps and endpoints involved in a build-your-own consent journey. These steps and corresponding endpoints are already considered and covered in our easy-to-use SDK. -| No. | Action | Description | -| :---------------------- | :-------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No. | Action | Description | +| :---------------------- | :-------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Onboarding:** | -| 1 | Customer clicks on “Connect” button | Customer clicks on button within UI to initiate connection | -| 2 | Application triggers company creation | Application places a call to Link's `POST Create company` endpoint to create a Codat company | -| 3 | API responds with Company details | Link's API endpoint responds with unique `CompanyId` to be stored and used by the application | -| 4 | Application triggers connection creation | Application places a call to Link's `POST Create connection` endpoint to create a connection | -| 5 | API responds with Connection details | Link's API endpoint responds with `linkURL` to be shared with customer by the application | -| 6 | Customer authorizes access | Application directs user to the ‘linkURL’ where customer authenticates and authorizes access to data | -| 7 | Customer is redirected to application | Customer's consent journey finishes on a confirmation screen of the application | +| 1 | Customer clicks on “Connect” button | Customer clicks on button within UI to initiate connection | +| 2 | Application triggers company creation | Application places a call to Link's `POST Create company` endpoint to create a Codat company | +| 3 | API responds with Company details | Link's API endpoint responds with unique `CompanyId` to be stored and used by the application | +| 4 | Application triggers connection creation | Application places a call to Link's `POST Create connection` endpoint to create a connection | +| 5 | API responds with Connection details | Link's API endpoint responds with `linkURL` to be shared with customer by the application | +| 6 | Customer authorizes access | Application directs user to the ‘linkURL’ where customer authenticates and authorizes access to data | +| 7 | Customer is redirected to application | Customer's consent journey finishes on a confirmation screen of the application | | **Ongoing management:** | | 8 | Customer wants to connect an additional package at a later date | Customer clicks on button within application to connect an additional package. Application places a call to Link's `POST Create connection` with a `companyId` to create connection and provide `linkURL` | | 9 | Customer wants to disconnect an existing package | Customer clicks on a “Disconnect” button within application. Application places a call to Link's `DELETE Delete connection` | diff --git a/docs/lending/guides/migration-guides/deprecation-account-categories-portal.md b/docs/lending/guides/migration-guides/deprecation-account-categories-portal.md index a44e42a9c..9f460d4f6 100644 --- a/docs/lending/guides/migration-guides/deprecation-account-categories-portal.md +++ b/docs/lending/guides/migration-guides/deprecation-account-categories-portal.md @@ -11,12 +11,12 @@ draft: true The following features in the **Assess** section of the portal will no longer be available: -| Feature | Portal | -| :------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- | -| **Profit and loss** | ![Screenshot of Profit and loss screen that's being deprecated in Assess](/img/lending/profit-and-loss.png) | -| **Balance sheet** | ![Screenshot of Balance sheet screen that's being deprecated in Assess](/img/lending/balance-sheet.png) | -| **Ratios**

**Note**: These appear at the end of the Profit and Loss and Balance Sheet tabs | ![Screenshot of Ratios screen that's being deprecated in Assess](/img/lending/financial-ratios.png) | -| **Marketing** | ![Screenshot of Marketing screen that's being deprecated in Assess](/img/lending/marketing-screen-assess.png) | +| Feature | Portal | +| :--------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- | +| **Profit and loss** | ![Screenshot of Profit and loss screen that's being deprecated in Assess](/img/lending/profit-and-loss.png) | +| **Balance sheet** | ![Screenshot of Balance sheet screen that's being deprecated in Assess](/img/lending/balance-sheet.png) | +| **Ratios**

**Note**: These appear at the end of the Profit and Loss and Balance Sheet tabs | ![Screenshot of Ratios screen that's being deprecated in Assess](/img/lending/financial-ratios.png) | +| **Marketing** | ![Screenshot of Marketing screen that's being deprecated in Assess](/img/lending/marketing-screen-assess.png) | | **Categorize accounts in Assess**

**Note**: We have new screens available for recategorizing accounts using the latest categories. | ![Screenshot of categorize accounts screen that's being deprecated](/img/lending/account-categorization-v2.png) | | **Categorize accounts in Accounting API**

**Note**: We have new screens available for recategorizing accounts using the latest categories. | ![Screenshot of categorize accounts screen that's being deprecated](/img/lending/accounting-api-account-categorisation.png) | From 0c8d9aac73b103c10a783e85c17e6bf7210ed94d Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Fri, 6 Feb 2026 12:18:00 +0000 Subject: [PATCH 3/5] Fix typo in error documentation --- docs/commerce/error-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/commerce/error-documentation.md b/docs/commerce/error-documentation.md index e0a11970c..351ba45bd 100644 --- a/docs/commerce/error-documentation.md +++ b/docs/commerce/error-documentation.md @@ -38,7 +38,7 @@ This section describes the errors that are related to Sync for Commerce configur | Error message | Error resolution | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Company needs to have two valid data connections. | This error surfaces if a company does not have 2 valid data connections **OR** both data connections do not have the `linked` status.
Ensure that the Codat company created for the merchant has 2 valid data connections. One commerce and one accounting connection are required.
Ensure that the Codat company has both data connection statuses set to `linked` by using the public API connection resource **OR** via the-no code merchant link journey using the link URL generated by the Codat app portal. | +| Company needs to have two valid data connections. | This error surfaces if a company doesn't have 2 valid data connections **OR** both data connections do not have the `linked` status.
Ensure that the Codat company created for the merchant has 2 valid data connections. One commerce and one accounting connection are required.
Ensure that the Codat company has both data connection statuses set to `linked` by using the public API connection resource **OR** via the-no code merchant link journey using the link URL generated by the Codat app portal. | | To sync fees:
- Payments section needs to exist
- Payments account id needs to be set | The **Fees** feature cannot be used until the **Payment** feature is configured.
The merchant should complete the configuration of Payments in order to sync Fees. | | Payments config invalid. `{prepaid account}` should not match `{prepaid payment account}`.
Accounts config invalid. Prepaid account in Sales should not match `{CommerceAccountType. PrepaidPayment}` in Payments." | The prepaid account and the payment account should not be the same.
Reconfigure the selected accounts for prepaid and prepaid payments. | | Payments config invalid. `{Card Acount}` should not match `{Payout Account}`. | This error surfaces if the account selected for Payments matches the payout account.
Reconfigure the selected accounts for payments and payouts. | From 9d43433b866b04797ebc323f23d59eabef1e419c Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Fri, 6 Feb 2026 12:22:00 +0000 Subject: [PATCH 4/5] Fix tab item value for Gearing ratio section --- docs/lending/guides/loan-qualification/uw-decision.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/lending/guides/loan-qualification/uw-decision.md b/docs/lending/guides/loan-qualification/uw-decision.md index b46f9b6f6..b2e0da893 100644 --- a/docs/lending/guides/loan-qualification/uw-decision.md +++ b/docs/lending/guides/loan-qualification/uw-decision.md @@ -38,7 +38,7 @@ Its threshold is maintained as `RevenueThreshold` in `appsettings.json`. In the - + The gearing ratio used in the example model is the **debt ratio**, calculated by dividing total debt by total assets. It uses the [`balanceSheet`](https://docs.codat.io/assess-api#/operations/get-enhanced-balance-sheet) endpoint and its `Asset` and `Liability.NonCurrent.LoansPayable` values. Having too much debt may indicate a higher financial risk associated with the company. From 18d849c280a5e81982f52ac093a092ac69d23be5 Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Fri, 6 Feb 2026 12:26:30 +0000 Subject: [PATCH 5/5] Update cspell.json Amend dictionary --- cspell.json | 34 ---------------------------------- 1 file changed, 34 deletions(-) diff --git a/cspell.json b/cspell.json index 46e7ba381..a5e5ffaaa 100644 --- a/cspell.json +++ b/cspell.json @@ -39,16 +39,12 @@ "aiwb", "AISP", "akxx", - "apologise", "API", "APIs", "appsettings", "authentication", - "Authorise", - "authorisation", "authorization", "autoplay", - "Authorised", "Autres", "BACS", "bankfeeds", @@ -61,7 +57,6 @@ "Brex", "brex", "Capchase", - "categorisation", "Chargebee", "chargeback", "chargebacks", @@ -71,24 +66,16 @@ "Clearbooks", "Codat's", "Codat", - "Codats", "Coltman", "companyid", "costcenters", - "createendpoint", "Dashboarding", - "datamodel", - "datasource", - "datasources", - "datatype", - "datatypes", "DDEP", "deauthorization", "Deauthorized", "deauthorize", "decisioning", "demodata", - "downloadendpoint", "drawdowns", "drillable", "dropoff", @@ -96,12 +83,10 @@ "EBITDA", "eCommerce", "endpoint", - "endpointlink", "endpoints", "exez", "exgd", "Fahey", - "familiarise", "fbrh", "fintech", "Financials", @@ -125,7 +110,6 @@ "Intacct", "Intuit's", "Intuit", - "itemised", "Jaro", "jcrp", "Kash", @@ -136,21 +120,15 @@ "Knowledgebase", "ldgh", "Lightspeed", - "listendpoint", "lqai", "lrhd", "ltes", "ltpp", - "maximise", - "maximises", - "Maximising", - "maximising", "Maxio", "metadata", "miscategorized", "MNDA", "Mobbin", - "monetise", "Monzo", "mqjo", "multicurrency", @@ -163,10 +141,8 @@ "NetSuite", "OBWAC", "olpr", - "optimise", "Organisation", "Organisations", - "organised", "otherreceipt", "Pandle", "payables", @@ -182,7 +158,6 @@ "pqsw", "Presta", "PrestaShop", - "prioritise", "qhyg", "qkdj", "Qualys", @@ -210,16 +185,10 @@ "shipto", "signum", "skillset", - "Standardised", "subjournals", "sumup", "suuo", "Svix", - "synchronisation", - "Synchronisation", - "synchronisations", - "synchronise", - "synchronising", "textkey", "textkeys", "tgff", @@ -229,9 +198,6 @@ "TrueLayer", "ugxp", "upvr", - "usecase", - "usecases", - "utilising", "Venmo", "Vipps", "vipps",