From b1c00cd7ea8c5545a0d419a7d62d29922deb1dcb Mon Sep 17 00:00:00 2001 From: pmckinney-codat Date: Thu, 7 May 2026 16:22:37 +0100 Subject: [PATCH] Tidy cspell issues and add cspell to pre-commit hook Fix 8 typos in docs, accept en-GB spellings, and add legitimate domain terms / sample-data names to the cspell dictionary so cspell runs clean across all .md/.mdx files. Add cspell to the lint-staged pre-commit hook so future typos block the commit. Co-Authored-By: Claude Opus 4.7 (1M context) --- cspell.json | 22 +++++++- docs/auth-flow/optimize/maximize-links.md | 2 +- docs/configure/portal/dashboard.mdx | 2 +- .../installing-the-quickbooks-connector.md | 2 +- .../accounting-quickbooksonline.md | 2 +- docs/payroll/mapping.mdx | 2 +- docs/spend-insights/guides/get-report.md | 2 +- docs/spend-insights/reports/spend-analysis.md | 54 +++++++++---------- package.json | 5 +- 9 files changed, 58 insertions(+), 35 deletions(-) diff --git a/cspell.json b/cspell.json index a5e5ffaaa..9059056c3 100644 --- a/cspell.json +++ b/cspell.json @@ -1,6 +1,6 @@ { "version": "0.2", - "language": "en", + "language": "en,en-GB", "files": ["**/*.md", "**/*.mdx"], "exclude": ["**/node_modules/**", "**/dist/**", "**/.git/**"], "ignorePaths": [ @@ -35,6 +35,7 @@ ], "words": [ "Abila", + "Abra", "AEST", "aiwb", "AISP", @@ -51,12 +52,15 @@ "bankstatement", "Basiq", "bento", + "Berge", "BigCommerce", "billpayasync", "billpaysync", "Brex", "brex", "Capchase", + "Cardable", + "cardable", "Chargebee", "chargeback", "chargebacks", @@ -69,13 +73,18 @@ "Coltman", "companyid", "costcenters", + "createendpoint", "Dashboarding", + "datamodel", + "datatypes", "DDEP", "deauthorization", "Deauthorized", "deauthorize", + "deauthorizing", "decisioning", "demodata", + "downloadendpoint", "drawdowns", "drillable", "dropoff", @@ -83,6 +92,7 @@ "EBITDA", "eCommerce", "endpoint", + "endpointlink", "endpoints", "exez", "exgd", @@ -91,6 +101,7 @@ "fintech", "Financials", "fqly", + "Freetext", "FreshBooks", "fztf", "GAAP", @@ -98,6 +109,7 @@ "Gamify", "gbol", "generalledgers", + "grat", "Hairosmith", "hbql", "hcws", @@ -114,12 +126,14 @@ "jcrp", "Kash", "Kashflow", + "Kedabra", "keyss", "Kleppman", "knfz", "Knowledgebase", "ldgh", "Lightspeed", + "listendpoint", "lqai", "lrhd", "ltes", @@ -165,11 +179,13 @@ "QWAC", "QuickBooks", "quickbooksdesktop", + "quickbooksonline", "recategorization", "recategorize", "Recategorize", "recategorizing", "Recategorizing", + "reengagement", "Recurly", "Rightworks", "Rockstar", @@ -198,6 +214,9 @@ "TrueLayer", "ugxp", "upvr", + "Usecases", + "usecase", + "usecases", "Venmo", "Vipps", "vipps", @@ -222,6 +241,7 @@ "Xero's", "Xero", "YNAB", + "Yundt", "yzth", "Zettle", "zpqy", diff --git a/docs/auth-flow/optimize/maximize-links.md b/docs/auth-flow/optimize/maximize-links.md index 93ca3fa4e..26077ae74 100644 --- a/docs/auth-flow/optimize/maximize-links.md +++ b/docs/auth-flow/optimize/maximize-links.md @@ -39,7 +39,7 @@ Maximising the number of companies who choose to link their data to maximise the User journey considerations -Embedding the link flow into your own application journey has enabled more links than manual approaches across Codats clients to date. Bearing this in mind, guidelines for Codat Portal and for API implementation are below. +Embedding the link flow into your own application journey has enabled more links than manual approaches across Codat's clients to date. Bearing this in mind, guidelines for Codat Portal and for API implementation are below. API diff --git a/docs/configure/portal/dashboard.mdx b/docs/configure/portal/dashboard.mdx index 15b20994f..2e0bd0fd1 100644 --- a/docs/configure/portal/dashboard.mdx +++ b/docs/configure/portal/dashboard.mdx @@ -12,7 +12,7 @@ Before you start using our API... diff --git a/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline.md b/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline.md index e29221594..373cf1514 100644 --- a/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline.md +++ b/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline.md @@ -19,7 +19,7 @@ See [Set up the QuickBooks Online integration](/integrations/accounting/quickboo Intuit's [App Partner Program](https://blogs.intuit.com/2025/05/15/introducing-the-intuit-app-partner-program/) supports providers of applications built on Intuit's platform with higher security standards, early access to new features, and more reliable data synchronization. -If you plan to publish an app in the QuickBooks ecosystem, you must register with the partner program and fill in the app assessment questionnnaire. We created an [App assessment questionnaire guide](/integrations/accounting/quickbooksonline/qbo-app-assessment-questionnaire) to help you answer its questions. +If you plan to publish an app in the QuickBooks ecosystem, you must register with the partner program and fill in the app assessment questionnaire. We created an [App assessment questionnaire guide](/integrations/accounting/quickbooksonline/qbo-app-assessment-questionnaire) to help you answer its questions. #### Tiered usage model diff --git a/docs/payroll/mapping.mdx b/docs/payroll/mapping.mdx index 9a73a0abf..e30f4f500 100644 --- a/docs/payroll/mapping.mdx +++ b/docs/payroll/mapping.mdx @@ -59,7 +59,7 @@ const payrollComponents = [ You should provide your customer with a flexible interface to enable companies to handle the nuances of how they want to reconcile their data. Mapping could be -as complex or granular as suits your usecase. +as complex or granular as suits your use case. ### Get the accounts diff --git a/docs/spend-insights/guides/get-report.md b/docs/spend-insights/guides/get-report.md index 691165174..808fc5a52 100644 --- a/docs/spend-insights/guides/get-report.md +++ b/docs/spend-insights/guides/get-report.md @@ -73,7 +73,7 @@ Codat offers three report types with a different level of detail that serve a di | ---------------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | **[Spend Summary](/spend-insights/reports/spend-summary)** | PowerPoint | A one-page customer-ready snapshot of top supplier opportunities and key metrics, such as cashback potential and time saved. | Sales enablement, quick value demonstration, client-facing conversations | | **[Spend Analysis](/spend-insights/reports/spend-analysis)** | Excel | A detailed breakdown of your customer's accounts payable data, payment methods, supplier spend, and settlement terms. | Deep spend analysis, identification of cardable suppliers, input for supplier onboarding campaigns | -| **[Ongoing Insights](/spend-insights/reports/ongoing-insights)** | Excel | An automated quarterly report that compares the latest spend data to previous periods and highlights new suppliers, trends, and payment method changes. | Continuous monitoring of opportunitites, supplier onboarding prioritization | +| **[Ongoing Insights](/spend-insights/reports/ongoing-insights)** | Excel | An automated quarterly report that compares the latest spend data to previous periods and highlights new suppliers, trends, and payment method changes. | Continuous monitoring of opportunities, supplier onboarding prioritization | | **[Mastercard Match](/spend-insights/reports/vendor-match)** | Excel | Supplier data formatted for Mastercard's supplier matching platform. | Supplier enablement using third party tools. | | **[PayTech](/spend-insights/reports/vendor-match)** | Excel | Supplier data formatted for PayTech's supplier matching processes. | Supplier enablement using third party tools. | | **[Visa Vendor Match](/spend-insights/reports/vendor-match)** | Excel | Supplier data formatted for Visa's supplier matching processes. | Supplier enablement using third party tools. | diff --git a/docs/spend-insights/reports/spend-analysis.md b/docs/spend-insights/reports/spend-analysis.md index 98604d112..76bfa6dae 100644 --- a/docs/spend-insights/reports/spend-analysis.md +++ b/docs/spend-insights/reports/spend-analysis.md @@ -13,7 +13,7 @@ Codat's **Spend Analysis** report is a detailed Excel file generated from your c ## Source data -The report proivides a structured breakdown of your customer's overall spend, payment methods, and supplier-level activity. This gives you the insights you need to identify card conversion opportunities, run supplier outreach campaigns, and monitor spend on an ongoing basis. It uses the following financial data to surface these insights: +The report provides a structured breakdown of your customer's overall spend, payment methods, and supplier-level activity. This gives you the insights you need to identify card conversion opportunities, run supplier outreach campaigns, and monitor spend on an ongoing basis. It uses the following financial data to surface these insights: - **Bills** — the full list of documents issued by your customer's suppliers as requests for payments - **Payments** — the full list of payments made by your customer against those bills @@ -82,31 +82,31 @@ Each row in the tab represents a payment method (Credit Card, Debit Card, Bank T ### Definitions -| Column | Description | What it tells you | -| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Payment method** | The inferred payment method grouping this row (e.g. Credit Card, Check, Bank Transfer). | Use to identify which payment methods are most prevalent in your customer's supplier spend and where the card conversion opportunity lies. | -| **# of suppliers** | Count of suppliers whose most common payment method is this type. | Compare across rows to understand how supplier relationships are distributed by payment method. | -| **% of all suppliers** | Share of total suppliers using this payment method. | Use alongside _# of suppliers_ because percentage alone can be misleading with small supplier numbers. | -| **% of all bills (by #)** | Share of total bill count attributed to this payment method. | Compare with _% of all bills (by amount)_. A significant difference means this method handles many small transactions or a few large ones. | -| **% of all bills (by amount)** | Share of total bill value attributed to this payment method. | The primary measure of spend share by payment method. Use to quantify how much of total supplier spend is on non-card methods. | -| **Total spend** | Combined bills and expenses amount for this payment method. | Compare _Card_ with _Non-Card_ rows to quantify the total card migration opportunity, including spend not captured as bills. | -| **# of bills** | Count of all bills in this payment method group within the reporting period. | A high count with low total spend may indicate many small transactions and could be good candidates for card consolidation. | -| **# of bills outstanding** | Count of unpaid bills in this group. | Use with _Bills outstanding amount_ and _% bills outstanding_ to assess unpaid supplier exposure by payment method. | -| **Bills amount** | Total value of all bills in this group. | The base figure for outstanding and late payment percentage calculations in this row. | -| **Bills outstanding amount** | Total value of unpaid bills in this group. | Quantifies supplier exposure by payment method. For example, high outstanding amounts on non-card methods may indicate cash flow or process issues. | -| **% bills outstanding (by amount)** | Outstanding bill value as a percentage of total bill value for this group. | Use with _# of bills outstanding_, _Average payment terms_, and _Average settlement period_ to understand why bills are outstanding. | -| **# of bills paid late** | Count of bills in this group paid after their due date. | Indicates payment reliability by method. High late counts on check or bank transfer act as a strong argument for card migration. | -| **Bills paid late amount** | Total value of bills in this group paid after their due date. | Use with _% bills paid late_ to assess whether lateness is concentrated in high or low-value bills. | -| **% bills paid late (by amount)** | Late bill value as a percentage of total bill value for this group. | Compare with _Average payment terms_ and _Average settlement period_. If settlement period consistently exceeds terms, this percentage will be high. Together these three columns build the case for card programs that extend effective payment terms. | -| **# of payments** | Count of payment transactions across all suppliers in this group. | Use to understand transaction volume by payment method. | -| **Payments amount** | Total value of all payments made in this group. | Cross-reference with _Bills amount_ to check alignment across the reporting period. | -| **Average payment amount** | Total payments value divided by number of payments in this group. | Smaller average payments are typically better virtual card candidates than large single payments. | -| **Average payment terms** | The average number of days between bill issue date and bill due date across all bills in this group.

Calculated across all bills and weighted so that higher-value bills have more influence on the result. | Compare with _Average settlement period_. Terms greater than settlement means the customer repays early, and settlement greater than terms means customer repays late. | -| **Average settlement period** | The averae number of days between bill issue date and actual payment date across all bills in this group.

Calculated across all bills and weighted so that higher-value bills have more influence on the result. | Compare directly with _Average payment terms_ to identify which payment methods have the worst payment timing. | -| **% of all Expenses (by #)** | Share of total expense transaction count attributed to this payment method. | Shows whether expense transactions are concentrated in particular payment methods. | -| **% of all Expenses (by amount)** | Share of total expense value attributed to this payment method. | Use to identify payment methods where significant spend is occurring outside of Accounts Payable. | -| **# of Expenses** | Count of expense transactions in this group. | High expense counts on non-card methods indicate ad hoc spend that isn't reflected in Accounts Payable. | -| **Expenses amount** | Total value of expenses in this group. | Compare with bills amount to understand the full spend picture for this payment method, including spend that isn't reflected in Accounts Payable. | +| Column | Description | What it tells you | +| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Payment method** | The inferred payment method grouping this row (e.g. Credit Card, Check, Bank Transfer). | Use to identify which payment methods are most prevalent in your customer's supplier spend and where the card conversion opportunity lies. | +| **# of suppliers** | Count of suppliers whose most common payment method is this type. | Compare across rows to understand how supplier relationships are distributed by payment method. | +| **% of all suppliers** | Share of total suppliers using this payment method. | Use alongside _# of suppliers_ because percentage alone can be misleading with small supplier numbers. | +| **% of all bills (by #)** | Share of total bill count attributed to this payment method. | Compare with _% of all bills (by amount)_. A significant difference means this method handles many small transactions or a few large ones. | +| **% of all bills (by amount)** | Share of total bill value attributed to this payment method. | The primary measure of spend share by payment method. Use to quantify how much of total supplier spend is on non-card methods. | +| **Total spend** | Combined bills and expenses amount for this payment method. | Compare _Card_ with _Non-Card_ rows to quantify the total card migration opportunity, including spend not captured as bills. | +| **# of bills** | Count of all bills in this payment method group within the reporting period. | A high count with low total spend may indicate many small transactions and could be good candidates for card consolidation. | +| **# of bills outstanding** | Count of unpaid bills in this group. | Use with _Bills outstanding amount_ and _% bills outstanding_ to assess unpaid supplier exposure by payment method. | +| **Bills amount** | Total value of all bills in this group. | The base figure for outstanding and late payment percentage calculations in this row. | +| **Bills outstanding amount** | Total value of unpaid bills in this group. | Quantifies supplier exposure by payment method. For example, high outstanding amounts on non-card methods may indicate cash flow or process issues. | +| **% bills outstanding (by amount)** | Outstanding bill value as a percentage of total bill value for this group. | Use with _# of bills outstanding_, _Average payment terms_, and _Average settlement period_ to understand why bills are outstanding. | +| **# of bills paid late** | Count of bills in this group paid after their due date. | Indicates payment reliability by method. High late counts on check or bank transfer act as a strong argument for card migration. | +| **Bills paid late amount** | Total value of bills in this group paid after their due date. | Use with _% bills paid late_ to assess whether lateness is concentrated in high or low-value bills. | +| **% bills paid late (by amount)** | Late bill value as a percentage of total bill value for this group. | Compare with _Average payment terms_ and _Average settlement period_. If settlement period consistently exceeds terms, this percentage will be high. Together these three columns build the case for card programs that extend effective payment terms. | +| **# of payments** | Count of payment transactions across all suppliers in this group. | Use to understand transaction volume by payment method. | +| **Payments amount** | Total value of all payments made in this group. | Cross-reference with _Bills amount_ to check alignment across the reporting period. | +| **Average payment amount** | Total payments value divided by number of payments in this group. | Smaller average payments are typically better virtual card candidates than large single payments. | +| **Average payment terms** | The average number of days between bill issue date and bill due date across all bills in this group.

Calculated across all bills and weighted so that higher-value bills have more influence on the result. | Compare with _Average settlement period_. Terms greater than settlement means the customer repays early, and settlement greater than terms means customer repays late. | +| **Average settlement period** | The average number of days between bill issue date and actual payment date across all bills in this group.

Calculated across all bills and weighted so that higher-value bills have more influence on the result. | Compare directly with _Average payment terms_ to identify which payment methods have the worst payment timing. | +| **% of all Expenses (by #)** | Share of total expense transaction count attributed to this payment method. | Shows whether expense transactions are concentrated in particular payment methods. | +| **% of all Expenses (by amount)** | Share of total expense value attributed to this payment method. | Use to identify payment methods where significant spend is occurring outside of Accounts Payable. | +| **# of Expenses** | Count of expense transactions in this group. | High expense counts on non-card methods indicate ad hoc spend that isn't reflected in Accounts Payable. | +| **Expenses amount** | Total value of expenses in this group. | Compare with bills amount to understand the full spend picture for this payment method, including spend that isn't reflected in Accounts Payable. | ## Supplier Analysis tab @@ -162,7 +162,7 @@ Total spend gives you a single figure that represents the full extent of your cu ### Bills -This section covers the requests for payment raised by the supplier to your customer, highlighting the amounts and quantities still oustanding. +This section covers the requests for payment raised by the supplier to your customer, highlighting the amounts and quantities still outstanding. diff --git a/package.json b/package.json index caa57c3e0..3bfe3df9f 100644 --- a/package.json +++ b/package.json @@ -84,6 +84,9 @@ }, "lint-staged": { "*.{js,jsx,ts,tsx}": "prettier --write", - "*.{md,mdx}": "prettier --write" + "*.{md,mdx}": [ + "prettier --write", + "cspell --no-must-find-files --config cspell.json" + ] } }