diff --git a/.claude/skills/docusaurus-config/references/detailed-guide.md b/.claude/skills/docusaurus-config/references/detailed-guide.md index c51dab234..d0ae168fe 100644 --- a/.claude/skills/docusaurus-config/references/detailed-guide.md +++ b/.claude/skills/docusaurus-config/references/detailed-guide.md @@ -204,24 +204,20 @@ function MyComponent() { When modifying config, verify: 1. **Required fields present**: - - ✅ `title` exists - ✅ `url` exists and has no trailing slash - ✅ `baseUrl` exists and starts/ends with `/` 2. **Plugins and themes**: - - ✅ Use proper package names or shorthand - ✅ Options passed as second array element - ✅ No duplicate plugins 3. **Custom data**: - - ✅ Unknown fields in `customFields` object - ✅ No direct custom properties at root level 4. **File format**: - - ✅ Valid JS/TS syntax - ✅ Proper export (ESM or CommonJS) - ✅ TypeScript types imported if using TS diff --git a/blog/250204-new-product-docs.md b/blog/250204-new-product-docs.md index 0e13453fa..9cfc43f5b 100644 --- a/blog/250204-new-product-docs.md +++ b/blog/250204-new-product-docs.md @@ -51,7 +51,7 @@ If you are using or planning to use Codat, this update is for you - our new look | **Sync for Expenses** | Codat now refers to this solution as [Expenses](/expenses/overview) with a focus on the [accounting automation](/usecases/summary/accounting-automation) use case. | | **Sync for Payables** | Codat now refers to this solution as [Bill Pay (async)](/payables/async/suppliers) with a focus on the [accounting automation](/usecases/summary/accounting-automation) use case. | | **Bill Pay kit** | Codat now refers to this solution as [Bill Pay (sync)](/payables/sync/suppliers) with a focus on the [accounting automation](/usecases/summary/accounting-automation) use case. | -| **Sync for Commerce** | This solution is no longer available for sale. If you are an existing client using Sync for Commerce, you can still access its [documentation](/commerce/overview). | +| **Sync for Commerce** | This solution is no longer available for sale. If you are an existing client using Sync for Commerce, you can still access its [documentation](/commerce/overview). | ## How to get started? diff --git a/blog/251003-deprecation-of-legacy-products.md b/blog/251003-deprecation-of-legacy-products.md index 3bb956542..9c314dbe4 100644 --- a/blog/251003-deprecation-of-legacy-products.md +++ b/blog/251003-deprecation-of-legacy-products.md @@ -5,7 +5,7 @@ tags: ["Deprecation"] authors: habbajobir --- -To streamline our platform and enable us to focus on our key products, Codat is deprecating legacy products and consolidating multiple versions into a single variant. +To streamline our platform and enable us to focus on our key products, Codat is deprecating legacy products and consolidating multiple versions into a single variant. diff --git a/blog/260107-accounting-score.md b/blog/260107-accounting-score.md index 38c35dcdd..6a54f06da 100644 --- a/blog/260107-accounting-score.md +++ b/blog/260107-accounting-score.md @@ -26,7 +26,7 @@ The **Accounting Score** metrics are now available via API as part of Codat’s In addition to the overall score, the API identifies the **top three accounting issues** for a company, allowing lenders to quickly focus on the most impactful risks. This helps lenders: - Understand the reliability of borrower data earlier in the underwriting process. -- Reduce manual review by highlighting the key accounting concerns upfront. +- Reduce manual review by highlighting the key accounting concerns upfront. - Make more confident, efficient credit risk decisions. The Accounting Score is available across all accounting integrations supported by the [Lending](/lending/overview) solution. diff --git a/blog/260107-credit-model.md b/blog/260107-credit-model.md index 83b00bfa4..5c3bca74e 100644 --- a/blog/260107-credit-model.md +++ b/blog/260107-credit-model.md @@ -17,14 +17,14 @@ The Credit Model report is a premium feature of Codat’s [Lending](/lending/ove Lending's new **Credit Model report** combines accounting and banking data into a single structured view that supports faster and more consistent underwriting decisions. It includes: -- **Dashboard** – a consolidated view of a borrower’s overall financial health -- **Credit score** – a customizable credit score aligned to the metrics most relevant to your lending criteria -- **Accounting score** – an assessment of the quality, completeness, and reliability of the borrower’s bookkeeping -- **Financial summary** – automatically spread financial statements with calculated metrics and ratios -- **Bank summary** – bank transaction data transformed into a cash-based profit and loss statement -- **Debt summary** – a breakdown of existing debt with historical and projected repayment terms -- **Customer summary** – receivables analysis, including terms, concentration, and payment punctuality -- **Repayment summary** – payables analysis, including terms, concentration, and payment punctuality +- **Dashboard** – a consolidated view of a borrower’s overall financial health +- **Credit score** – a customizable credit score aligned to the metrics most relevant to your lending criteria +- **Accounting score** – an assessment of the quality, completeness, and reliability of the borrower’s bookkeeping +- **Financial summary** – automatically spread financial statements with calculated metrics and ratios +- **Bank summary** – bank transaction data transformed into a cash-based profit and loss statement +- **Debt summary** – a breakdown of existing debt with historical and projected repayment terms +- **Customer summary** – receivables analysis, including terms, concentration, and payment punctuality +- **Repayment summary** – payables analysis, including terms, concentration, and payment punctuality The **Credit Model report** is now available to download via the Codat **Portal** and **API**. @@ -36,12 +36,12 @@ This update is relevant for Lending clients who require deeper insights into the The Credit Model report is ideal for: -- **SME lending:** quickly assess the creditworthiness of small and medium-sized businesses, even with limited traditional financial history. +- **SME lending:** quickly assess the creditworthiness of small and medium-sized businesses, even with limited traditional financial history. - **Dynamic risk assessment:** monitor borrower health in real time or near-real time for proactive risk management. - **Streamlined underwriting:** reduce manual data entry and analysis to accelerate loan origination and improve operational efficiency. ## How to get started? -Contact your **Account Manager** or our **Support team** to enable access to this feature. You must be using our Lending solution to leverage the Credit Model report. +Contact your **Account Manager** or our **Support team** to enable access to this feature. You must be using our Lending solution to leverage the Credit Model report. Once enabled, refer to the [Credit model overview](/lending/premium-products/credit-model-overview#get-started) to start using the report via the Portal or API. diff --git a/blog/260116-xero-pricing.md b/blog/260116-xero-pricing.md index 63caa6ff1..6871c23b2 100644 --- a/blog/260116-xero-pricing.md +++ b/blog/260116-xero-pricing.md @@ -20,15 +20,18 @@ For ecosystem app partners Xero is introducing five pricing tiers based on: The tiers each have different connection limits, included API egress usage, and monthly fees. ## Why this matters + 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. ## What you should do now + 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 reccomended that you only sync data as often as is essential for your use-case. diff --git a/docs/auth-flow/_partial-auth-flow-examples.md b/docs/auth-flow/_partial-auth-flow-examples.md index 73034b9cc..152e49e48 100644 --- a/docs/auth-flow/_partial-auth-flow-examples.md +++ b/docs/auth-flow/_partial-auth-flow-examples.md @@ -73,11 +73,9 @@ function App() { ``` 3. **Conditional steps** - - **If you're using TypeScript**, extend your type declarations with our types by installing the types package using `npm install --save-dev @codat/sdk-link-types`. Otherwise, delete the type-related code in the snippets. - **If you're using content security policy (CSP) headers**, edit these headers: - - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src`, `style-src`, `font-src`, `connect-src`, `img-src`). - Add `unsafe-inline` to `style-src`. Do _not_ use a hash because this can change at any time without warning. @@ -164,11 +162,9 @@ export default function Home() { ``` 3. **Conditional steps** - - **If you're using TypeScript**, extend your type declarations with our types by installing the types package using `npm install --save-dev @codat/sdk-link-types`. Otherwise, delete the type related code in the snippets. - **If you're using content security policy (CSP) headers**, edit these headers: - - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src`, `style-src`, `font-src`, `connect-src`, `img-src`). - Add `unsafe-inline` to `style-src`. Do _not_ use a hash because this can change at any time without warning. @@ -248,7 +244,6 @@ const openModal = () => { ``` 5. **Conditional steps** - - **If you're using TypeScript**, extend your type declarations with our types. Download the `types.d.ts` file, then copy and paste its contents into a new or existing `.d.ts` file. - **If you're using content security policy (CSP) headers**, edit these headers: - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src`, `style-src`, `font-src`, `connect-src`, `img-src`). @@ -328,7 +323,6 @@ In the example below, we use webpack's [magic comments](https://webpack.js.org/a ``` 4. **Conditional steps** - - **If you're using TypeScript**, extend your type declarations with our types. Download the `types.d.ts` file, then copy and paste its contents into a new or existing `.d.ts` file. - **If you're using content security policy (CSP) headers**, edit these headers: - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src`, `style-src`, `font-src`, `connect-src`, `img-src`). @@ -395,7 +389,6 @@ For an example of the component in action, [see our demo app](https://github.com ``` 4. **Conditional steps** - - **If you're using TypeScript**, extend your type declarations with our types. Download the `types.d.ts` file, then copy and paste its contents into a new or existing `.d.ts` file. - **If you're using content security policy (CSP) headers**, edit these headers: - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src`, `style-src`, `font-src`, `connect-src`, `img-src`). @@ -462,7 +455,6 @@ For an example of the component in action, [see our demo app](https://github.com ``` 4. **Conditional steps** - - **If you're using TypeScript**, extend your type declarations with our types. Download the `types.d.ts` file, then copy and paste its contents into a new or existing `.d.ts` file. - **If you're using content security policy (CSP) headers**, edit these headers: - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src`, `style-src`, `font-src`, `connect-src`, `img-src`). diff --git a/docs/auth-flow/optimize/connection-management.md b/docs/auth-flow/optimize/connection-management.md index f01801a2e..1462b2833 100644 --- a/docs/auth-flow/optimize/connection-management.md +++ b/docs/auth-flow/optimize/connection-management.md @@ -241,7 +241,6 @@ export const ConnectionManagement = ({ ``` 3. **If you're using content security policy (CSP) headers:** - - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src, style-src, font-src, connect-src, img-src`). - Add `unsafe-inline` to `style-src`. Don't use a hash because this can change at any time without warning. @@ -322,7 +321,6 @@ export default function Home() { ``` 3. **If you're using content security policy (CSP) headers:** - - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src, style-src, font-src, connect-src, img-src`). - Add `unsafe-inline` to `style-src`. Do _not_ use a hash because this can change at any time without warning. @@ -393,7 +391,6 @@ const openModal = () => { ``` 4. **If you're using content security policy (CSP) headers**: - - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src, style-src, font-src, connect-src, img-src`). - Add `unsafe-inline` to `style-src`. Do _not_ use a hash because this can change at any time without warning. @@ -464,7 +461,6 @@ onError(error) { ``` 4. **If you're using content security policy (CSP) headers**: - - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src, style-src, font-src, connect-src, img-src`). - Add `unsafe-inline` to `style-src`. Do _not_ use a hash because this can change at any time without warning. @@ -518,7 +514,6 @@ We suggest wrapping the `CodatConnections` component in a modal so that you can ``` 4. **If you're using content security policy (CSP) headers**: - - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src, style-src, font-src, connect-src, img-src`). - Add `unsafe-inline` to `style-src`. Do _not_ use a hash because this can change at any time without warning. @@ -584,7 +579,6 @@ We suggest wrapping the `CodatConnections` component in a modal so that you can ``` 4. **If you're using content security policy (CSP) headers**: - - Allowlist Codat by adding `*.codat.io` to `default-src` (or each of `script-src, style-src, font-src, connect-src, img-src`). - Add `unsafe-inline` to `style-src`. Do _not_ use a hash because this can change at any time without warning. diff --git a/docs/bank-feeds/overview.mdx b/docs/bank-feeds/overview.mdx index d80c31b1f..0583e884f 100644 --- a/docs/bank-feeds/overview.mdx +++ b/docs/bank-feeds/overview.mdx @@ -129,11 +129,11 @@ on your customer's software, there are [three methods](/bank-feeds/mapping/overview) you can use for mapping: Codat's UI, your own UI, or the integration's UI. -:::note Platform requirements +:::note Platform requirements -The setup process and platform registration -requirements vary for each Bank Feeds integration. For detailed instructions, -refer to the documentation we provide for each integration. +The setup process and platform registration requirements vary for each Bank +Feeds integration. For detailed instructions, refer to the documentation we +provide for each integration. ::: diff --git a/docs/configure/user-management/user-roles.md b/docs/configure/user-management/user-roles.md index 8a257933b..7b1fb2ef7 100644 --- a/docs/configure/user-management/user-roles.md +++ b/docs/configure/user-management/user-roles.md @@ -34,19 +34,19 @@ _Administrator_ users have full access to all the features available in the Coda | Action | Onboarding | Analyst | Developer | Administrator | | ------------------------------------------------ | ---------- | ------- | --------- | ------------- | -| Add Companies | ✔ | ✔ | ✔ | ✔ | -| Edit Companies | ✔ | ✔ | ✔ | ✔ | -| Delete Companies | | ✔ | ✔ | ✔ | -| Add connections, view their status and Link URLs | ✔ | ✔ | ✔ | ✔ | -| Add or remove products from companies | ✔ | ✔ | ✔ | ✔ | -| Manage (delete and unlink) connections | | | ✔ | ✔ | -| View contributed company data (Portal) | | ✔ | ✔ | ✔ | -| View contributed company data (API) | ✔ | ✔ | ✔ | ✔ | -| Upload files on behalf of a company | ✔ | ✔ | ✔ | ✔ | -| Manage and view webhooks | | | ✔ | ✔ | -| Configure Link | | | ✔ | ✔ | -| Manage integrations | | | ✔ | ✔ | -| Manage data type settings | | | ✔ | ✔ | -| Manage upcoming deprecations | | | ✔ | ✔ | -| Manage other settings | | | ✔ | ✔ | -| Add and update users | | | | ✔ | +| Add Companies | ✔ | ✔ | ✔ | ✔ | +| Edit Companies | ✔ | ✔ | ✔ | ✔ | +| Delete Companies | | ✔ | ✔ | ✔ | +| Add connections, view their status and Link URLs | ✔ | ✔ | ✔ | ✔ | +| Add or remove products from companies | ✔ | ✔ | ✔ | ✔ | +| Manage (delete and unlink) connections | | | ✔ | ✔ | +| View contributed company data (Portal) | | ✔ | ✔ | ✔ | +| View contributed company data (API) | ✔ | ✔ | ✔ | ✔ | +| Upload files on behalf of a company | ✔ | ✔ | ✔ | ✔ | +| Manage and view webhooks | | | ✔ | ✔ | +| Configure Link | | | ✔ | ✔ | +| Manage integrations | | | ✔ | ✔ | +| Manage data type settings | | | ✔ | ✔ | +| Manage upcoming deprecations | | | ✔ | ✔ | +| Manage other settings | | | ✔ | ✔ | +| Add and update users | | | | ✔ | diff --git a/docs/core-concepts/status.md b/docs/core-concepts/status.md index fb77d36b7..6a63e98a5 100644 --- a/docs/core-concepts/status.md +++ b/docs/core-concepts/status.md @@ -30,17 +30,17 @@ Datasets can also transition to the _NotSupported_ state if the dataset you are alt="A diagram of possible dataset statuses from Queued to Complete" /> -| State | Description | -| :-------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Fetching | The data is currently being read from the integration. | -| Mapping | The data is being converted into Codat's standard model. | -| Validating | The data is being checked for consistency and correctness. | -| Processing | The data is being stored into Codat's cache. | -| Complete | The dataset has completed, and the data is available to be queried via Codat's API. | -| NotSupported | The integration does not support the datatype that was requested. For example, Clearbooks does not support reading the Profit and Loss Report. | +| State | Description | +| :-------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Fetching | The data is currently being read from the integration. | +| Mapping | The data is being converted into Codat's standard model. | +| Validating | The data is being checked for consistency and correctness. | +| Processing | The data is being stored into Codat's cache. | +| Complete | The dataset has completed, and the data is available to be queried via Codat's API. | +| NotSupported | The integration does not support the datatype that was requested. For example, Clearbooks does not support reading the Profit and Loss Report. | | FetchError, MapError, ValidationError, ProcessingError, InternalError, PermissionsError | The dataset failed in one of the above states. These are monitored by our engineering teams, but you may contact support team for assistance as required. | -| AuthError | The authentication to the data source has expired. This usually means you will need to relink, by getting the end user to follow the data connections's `linkUrl` to re-enter their credentials. | -| Queued | The dataset has just been requested, and will move into `fetching` shortly. | +| AuthError | The authentication to the data source has expired. This usually means you will need to relink, by getting the end user to follow the data connections's `linkUrl` to re-enter their credentials. | +| Queued | The dataset has just been requested, and will move into `fetching` shortly. | ## Examples diff --git a/docs/enterprise/tech-implementation/consent-journey.md b/docs/enterprise/tech-implementation/consent-journey.md index 3018478cf..52659b693 100644 --- a/docs/enterprise/tech-implementation/consent-journey.md +++ b/docs/enterprise/tech-implementation/consent-journey.md @@ -158,7 +158,6 @@ Link, Codat’s authentication solution, is used at multiple stages of the custo We address questions most commonly asked by our clients' customers on our [Help Hub](https://help.codat.io/resources/about#how-we-access-your-data). You can share the customer-centric responses provided there directly with your clients or use them as a foundation to prepare your own. Some of the questions we hear most often include: - - Will you have access to all my data? - Will my data be shared securely? - What if my accounting software isn’t listed? diff --git a/docs/enterprise/tech-implementation/managing-platform-credentials.md b/docs/enterprise/tech-implementation/managing-platform-credentials.md index a405796b4..6bbd4a3f6 100644 --- a/docs/enterprise/tech-implementation/managing-platform-credentials.md +++ b/docs/enterprise/tech-implementation/managing-platform-credentials.md @@ -34,7 +34,6 @@ Your organization usually needs to register with each of your preferred software 1. Review the registration or partnership requirements for the platforms you plan to use. Codat provides the following summary guidance: - - [Setting up accounting integrations](/integrations/accounting/overview#setting-up-accounting-integrations) - [Setting up commerce integrations](/integrations/commerce/overview#setting-up-commerce-integrations) diff --git a/docs/enterprise/tech-implementation/multiple-use-cases.md b/docs/enterprise/tech-implementation/multiple-use-cases.md index 8aa09337b..37c3112d2 100644 --- a/docs/enterprise/tech-implementation/multiple-use-cases.md +++ b/docs/enterprise/tech-implementation/multiple-use-cases.md @@ -24,7 +24,7 @@ You can apply either **sync settings** that fit your use case best. Codat distin To avoid the risk of dual syncs, you must only apply one type of sync settings. -Products are represented by an additional `products` property on calls to the [Create company](/platform-api#/operations/create-company) endpoint and can be added to an existing company using the [Add product](/platform-api#/operations/add-product) endpoint. +Products are represented by an additional `products` property on calls to the [Create company](/platform-api#/operations/create-company) endpoint and can be added to an existing company using the [Add product](/platform-api#/operations/add-product) endpoint. Codat's [webhook service](/using-the-api/webhooks/overview) provides a range of event types for standard products. To be notified about data read events for custom products, use the `{productIdentifier}.read.completed` webhooks. diff --git a/docs/enterprise/tech-overview/security/product-based-permissions.md b/docs/enterprise/tech-overview/security/product-based-permissions.md index 96b5d1ac5..b356b158f 100644 --- a/docs/enterprise/tech-overview/security/product-based-permissions.md +++ b/docs/enterprise/tech-overview/security/product-based-permissions.md @@ -32,8 +32,8 @@ Once a product has been assigned, these users can create companies. | Role | Access to product | Can edit user roles | Can assign products | Can access **Settings > Users** | Can create/view companies | | ----------------- | ----------------- | ------------------- | ------------------- | ------------------------------- | --------------------------- | -| **Administrator** | Full access | ✔ | ✔ | ✔ | ✔ | -| **Developer** | Full access | ✘ | ✘ | ✔ | ✔ | +| **Administrator** | Full access | ✔ | ✔ | ✔ | ✔ | +| **Developer** | Full access | ✘ | ✘ | ✔ | ✔ | | **Analyst** | Product required | ✘ | ✘ | ✘ | Only after product assigned | | **Onboarding** | Product required | ✘ | ✘ | ✘ | Only after product assigned | diff --git a/docs/enterprise/tech-overview/security/sso.md b/docs/enterprise/tech-overview/security/sso.md index 70db77edf..5c58be602 100644 --- a/docs/enterprise/tech-overview/security/sso.md +++ b/docs/enterprise/tech-overview/security/sso.md @@ -47,7 +47,6 @@ In your IdP, perform the following setup: `https://authentication.codat.io/login/callback?connection=[client-name]-[instance-name]-saml-connection` c. Include the following claims for each user in the SAML responses from the authenticating IdP: - - `email` - `groups` array (one ID representing each AD group the user belongs to and matches the mapping for the client/role access) - `displayname` (comprised of the first and last name) @@ -55,7 +54,6 @@ In your IdP, perform the following setup: If claims are not named as above, please let us know the names and namespaces of the claims. 3. Send us the `metadata.xml` file or, alternatively, all of the following: - - IdP sign-in URL - IdP sign-out URL (if required) - Signing certificate diff --git a/docs/expenses/overview.md b/docs/expenses/overview.md index 2443db2ba..1262052d2 100644 --- a/docs/expenses/overview.md +++ b/docs/expenses/overview.md @@ -142,16 +142,16 @@ When creating an expense transaction, allow your SMB customer to save a copy of
Supported integrations by endpoint -| Integration | expense-transactions | reimbursable-expense-transactions | transfer-transactions | adjustment-transactions | -| ------------------ | --------------------- | --------------------------------- | --------------------- | ----------------------- | -| Dynamics 365 | ✔️ | | | ✔️ | -| FreeAgent | ✔️ | ✔️ | ✔️ | | -| Oracle NetSuite | ✔️ | ✔️ | | | -| QuickBooks Desktop | ✔️ | ✔️ | ✔️ | ✔️ | -| QuickBooks Online | ✔️ | ✔️ | ✔️ | ✔️ | -| Sage Intacct | ✔️ | ✔️ | | | -| Xero | ✔️ | | ✔️ | ✔️ | -| Zoho Books | ✔️ | ✔️ | | | +| Integration | expense-transactions | reimbursable-expense-transactions | transfer-transactions | adjustment-transactions | +| ------------------ | -------------------- | --------------------------------- | --------------------- | ----------------------- | +| Dynamics 365 | ✔️ | | | ✔️ | +| FreeAgent | ✔️ | ✔️ | ✔️ | | +| Oracle NetSuite | ✔️ | ✔️ | | | +| QuickBooks Desktop | ✔️ | ✔️ | ✔️ | ✔️ | +| QuickBooks Online | ✔️ | ✔️ | ✔️ | ✔️ | +| Sage Intacct | ✔️ | ✔️ | | | +| Xero | ✔️ | | ✔️ | ✔️ | +| Zoho Books | ✔️ | ✔️ | | |
diff --git a/docs/integrations/accounting/clearbooks/accounting-clearbooks.md b/docs/integrations/accounting/clearbooks/accounting-clearbooks.md index 15a464800..4d0a3366a 100644 --- a/docs/integrations/accounting/clearbooks/accounting-clearbooks.md +++ b/docs/integrations/accounting/clearbooks/accounting-clearbooks.md @@ -23,7 +23,6 @@ To find their API key, the SMB user does the following: ![Clear Book: SMB user selects API keys from Settings > Configure system in the menu bar.](/img/old/00c84fa-clear-books_select-api-key.png) 3. Selects **Provide required information**, then provides the following information: - 1. Under **Intended API usage**, selects the second option: **I want to connect Clear Books with a piece of third-party software, exclusively for my own use**. 2. Under **Third-party software information**, enters the name of your app or website in the first box and "Codat" in the second box. diff --git a/docs/integrations/accounting/dynamics365businesscentral/accounting-dynamics365businesscentral-setup.md b/docs/integrations/accounting/dynamics365businesscentral/accounting-dynamics365businesscentral-setup.md index 5005850f9..6ffa20644 100644 --- a/docs/integrations/accounting/dynamics365businesscentral/accounting-dynamics365businesscentral-setup.md +++ b/docs/integrations/accounting/dynamics365businesscentral/accounting-dynamics365businesscentral-setup.md @@ -35,7 +35,6 @@ We also assume that your organization already has its Microsoft account configur Register your Business Central application on the Microsoft Azure portal. 1. Sign in to the Microsoft Azure portal. - - If you already have a Dynamics 365 Business Central account, use those account details to sign in. If not, you can create an account. - To gain access to any Azure configuration that your company has already set up—for example, for user authentication—enter your company email when you sign up. @@ -57,7 +56,6 @@ Register your Business Central application on the Microsoft Azure portal. ![Image](/img/old/7484936-d365-App_registrations.png) 5. Enter the following details: - - **Name**: Enter a short name for your application. Your customers will see this name when they authorize your connection to their accounting system. - **Supported account types**: Select **Accounts in any organizational directory (Any Microsoft Entra ID directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)**. This allows Codat to access data in Dynamics 365 Business Central. @@ -83,7 +81,6 @@ In the Azure Portal: 2. Under **Client secrets**, click **New client secret**. 3. In the **Add a client secret** dialog, update the following information: - - **Description**: Enter a short description for your client secret to make it easier to find. - **Expires**: Select the most appropriate option that complies with your company's security policy. @@ -104,7 +101,6 @@ Now update the access permissions for your application. These control the data t 3. In the **Request API permissions** pane, scroll down and select **Dynamics 365 Business Central**. 4. Select **Delegated permissions** and also select the first two listed permissions: - - **user_impersonation** - **Financials.ReadWrite.All** diff --git a/docs/integrations/accounting/dynamics365businesscentral/test-your-dynamics-365-business-central-integration.md b/docs/integrations/accounting/dynamics365businesscentral/test-your-dynamics-365-business-central-integration.md index 3b2d42b3f..a16a81b27 100644 --- a/docs/integrations/accounting/dynamics365businesscentral/test-your-dynamics-365-business-central-integration.md +++ b/docs/integrations/accounting/dynamics365businesscentral/test-your-dynamics-365-business-central-integration.md @@ -25,7 +25,6 @@ Before sending Link URLs to your SMB customers, we recommend you test your integ 4. Locate your test company, then click **Request data**. 5. Open the **Link URL** and follow the steps in Link to connect to your Microsoft Dynamics 365 account. - - Select **Microsoft Dynamics 365 Business Central** and then select **Continue to Dynamics 365 Business Central**. - Log in to your Dynamics 365 account. - Authorize access to your account details. diff --git a/docs/integrations/accounting/freeagent/accounting-freeagent-setup.md b/docs/integrations/accounting/freeagent/accounting-freeagent-setup.md index a37db1130..ef93406f3 100644 --- a/docs/integrations/accounting/freeagent/accounting-freeagent-setup.md +++ b/docs/integrations/accounting/freeagent/accounting-freeagent-setup.md @@ -44,7 +44,6 @@ Create an application in FreeAgent and then retrieve the secure application cred 2. Locate **FreeAgent** and click **Set up**. 3. Under **Integration settings**, enter the values for the **Client ID** and **Client secret** from the FreeAgent developer site. - - In the **Client ID** box, enter the **OAuth identifier** for your FreeAgent app. - In the **Client Secret** box, enter the **OAuth secret** for your FreeAgent app. diff --git a/docs/integrations/accounting/freshbooks/accounting-freshbooks.md b/docs/integrations/accounting/freshbooks/accounting-freshbooks.md index 9e0042137..3ef4ea960 100644 --- a/docs/integrations/accounting/freshbooks/accounting-freshbooks.md +++ b/docs/integrations/accounting/freshbooks/accounting-freshbooks.md @@ -33,7 +33,6 @@ Create and configure an application in the FreshBooks Developer Portal. 3. Click **Create New App**. 4. Enter the following information into the boxes on the **Create Application** page: - - **Application Name**: Enter a name for your application. This is displayed to your users when they authorize your access to their accounting data, so choose a name that clearly identifies your organization. - **Application Type**: Select **Private App**. diff --git a/docs/integrations/accounting/myob/accounting-myob-setup.md b/docs/integrations/accounting/myob/accounting-myob-setup.md index ebc29baa3..eda109490 100644 --- a/docs/integrations/accounting/myob/accounting-myob-setup.md +++ b/docs/integrations/accounting/myob/accounting-myob-setup.md @@ -58,7 +58,6 @@ MYOB will only automatically activate the first two API keys you create. All fur 2. Locate **MYOB Business** and click **Set up**. 3. Under **Integration settings**, enter the values for the **Client ID** and **Client secret** from your app in your MYOB developer account. - - Enter your application key in the **Client Key** box. - Enter your application secret in the **Client secret** box. diff --git a/docs/integrations/accounting/offline-connectors.md b/docs/integrations/accounting/offline-connectors.md index 90c6104f5..53a0e07f4 100644 --- a/docs/integrations/accounting/offline-connectors.md +++ b/docs/integrations/accounting/offline-connectors.md @@ -22,7 +22,6 @@ On-premise connector configuration is set in the Codat Portal at the integration 2. In the navigation bar, select **Settings > Integrations > Accounting**. 3. Find either the **QuickBooks Desktop** or **Sage 50 (UK & Ireland)** integrations and then select **Set up**. 4. Choose one of the following options: - - **Do not install / one-time sync** - **Install on the customer's machine** diff --git a/docs/integrations/accounting/overview.md b/docs/integrations/accounting/overview.md index 65f3c6094..dc2eb8c89 100644 --- a/docs/integrations/accounting/overview.md +++ b/docs/integrations/accounting/overview.md @@ -29,7 +29,7 @@ Some integrations have more complex requirements in terms of registration and pa | Platform | Registration complexity | Marketplace partner program | Connection restrictions | Additional information | | ----------------------------------------------------------------------------------------------------------------- | ------------------------- | --------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Microsoft Dynamics 365 Business Central](https://www.microsoft.com/en-gb/dynamics-365/products/business-central) | Medium | ❌ | ❌ | You must have a Microsoft Azure account to register. | -| [Microsoft Dynamics 365 Finance & Operations](https://www.microsoft.com/en-gb/dynamics-365/products/finance) | Medium | ❌ | ❌ | You must have a Microsoft Azure account to register.
This integration is only supported by our [Spend Insights](/spend-insights/overview) solution. | +| [Microsoft Dynamics 365 Finance & Operations](https://www.microsoft.com/en-gb/dynamics-365/products/finance) | Medium | ❌ | ❌ | You must have a Microsoft Azure account to register.
This integration is only supported by our [Spend Insights](/spend-insights/overview) solution. | | [Exact Online](https://www.exact.com/) | Medium | ✅ | ❌ | You must request permission to connect companies in production. | | [FreeAgent](https://www.freeagent.com/) | Easy | ✅ | ❌ | | | [FreshBooks](https://www.freshbooks.com/en-gb/) | Medium | ✅ | ❌ | Scopes are now required for all apps. | @@ -60,25 +60,25 @@ We can sometimes facilitate introductions to accounting software providers, part Each integration has a unique 4-character key that identifies it in our APIs. For reference, a list of all accounting integration platform keys can be found below: -| Platform name | Platform key | -| ------------------------------ | ------------ | -| Dynamics 365 Business Central | trji | -| Dynamics 365 Finance & Operations | rqwd | -| Exact (Netherlands) | qudb | -| Exact (UK) | pbbf | -| FreeAgent | fbrh | -| FreshBooks | vxvy | -| MYOB Business | pdvj | -| Oracle NetSuite | akxx | -| QuickBooks Desktop | pqsw | -| QuickBooks Online | qhyg | -| QuickBooks Online Sandbox | ndsk | -| Sage 200 Standard | jcrp | -| Sage 50 (UK) | hbql | -| Sage Accounting | tgff | -| Sage Intacct | knfz | -| Sandbox | mqjo | -| Wave | pbtz | -| Workday | rvam | -| Xero | gbol | -| Zoho Books | rwuv | +| Platform name | Platform key | +| --------------------------------- | ------------ | +| Dynamics 365 Business Central | trji | +| Dynamics 365 Finance & Operations | rqwd | +| Exact (Netherlands) | qudb | +| Exact (UK) | pbbf | +| FreeAgent | fbrh | +| FreshBooks | vxvy | +| MYOB Business | pdvj | +| Oracle NetSuite | akxx | +| QuickBooks Desktop | pqsw | +| QuickBooks Online | qhyg | +| QuickBooks Online Sandbox | ndsk | +| Sage 200 Standard | jcrp | +| Sage 50 (UK) | hbql | +| Sage Accounting | tgff | +| Sage Intacct | knfz | +| Sandbox | mqjo | +| Wave | pbtz | +| Workday | rvam | +| Xero | gbol | +| Zoho Books | rwuv | diff --git a/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline-new-setup.md b/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline-new-setup.md index ddfd60fa6..4de8657cf 100644 --- a/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline-new-setup.md +++ b/docs/integrations/accounting/quickbooksonline/accounting-quickbooksonline-new-setup.md @@ -66,7 +66,6 @@ In the Intuit Developer Portal, create and register a QuickBooks Online app and 4. Select the **QuickBooks Online and Payments** option. 5. Provide the following information on the **Give your app a name** page: - 1. Enter a name for your app. 2. Select the **com.intuit.quickbooks.accounting** scope. 3. Click **Create app**. @@ -127,7 +126,6 @@ For app hosting details, see Create bank transactions endpoint. Note that: - - You can only write bank transactions to one target account at a time. - Bank transactions must be written in chronological order. - Bank transactions can't be older than the most recent transaction available on the destination bank account. diff --git a/docs/integrations/banking/plaid/banking-plaid-setup.md b/docs/integrations/banking/plaid/banking-plaid-setup.md index 85bd4e29e..6fdd750a5 100644 --- a/docs/integrations/banking/plaid/banking-plaid-setup.md +++ b/docs/integrations/banking/plaid/banking-plaid-setup.md @@ -40,7 +40,6 @@ You'll need to: The **Integration settings** page for Plaid is displayed. 4. Locate the secure keys that you retrieved earlier and enter the following values: - - **client_id** value into **Client ID**. - **Sandbox** secret value into **Sandbox secret**. - **Development** secret value into **Development secret**. diff --git a/docs/integrations/banking/proxy-access-banking-data/enabling-proxy-access.md b/docs/integrations/banking/proxy-access-banking-data/enabling-proxy-access.md index 11da38384..9d5bbe1cb 100644 --- a/docs/integrations/banking/proxy-access-banking-data/enabling-proxy-access.md +++ b/docs/integrations/banking/proxy-access-banking-data/enabling-proxy-access.md @@ -16,7 +16,6 @@ In the Codat Portal: 2. Click **Manage** next to the Plaid or TrueLayer integration. 3. To enable proxy access to Plaid: - 1. Under _Proxy access to additional Plaid data types_, set the toggle to **ON**. The **Filter by products** box is displayed. @@ -25,7 +24,6 @@ In the Codat Portal: 3. Click **Save**. 4. To enable proxy access to TrueLayer: - 1. (Optional) Under _Proxy access to additional TrueLayer data types_, set the toggle to **ON**. The **Additional scopes** box is displayed. diff --git a/docs/integrations/commerce/amazon-seller-central/amazon-registration-steps.md b/docs/integrations/commerce/amazon-seller-central/amazon-registration-steps.md index 3fb6af0af..cf1f8f87e 100644 --- a/docs/integrations/commerce/amazon-seller-central/amazon-registration-steps.md +++ b/docs/integrations/commerce/amazon-seller-central/amazon-registration-steps.md @@ -94,7 +94,6 @@ To use Amazon Seller Central app credentials in a production environment (connec 5. You are re-directed to another page; click **Add App Listing**. 6. On the **List your App** form, complete the required sections: - - **App information** - **Pricing** - **Details** diff --git a/docs/integrations/commerce/api-workflow.md b/docs/integrations/commerce/api-workflow.md index 51b5ae8dd..c7c76812a 100644 --- a/docs/integrations/commerce/api-workflow.md +++ b/docs/integrations/commerce/api-workflow.md @@ -22,7 +22,6 @@ Create a Codat company and data connection for your customer. 1. Open the [Create a company](/platform-api#/operations/create-company) endpoint. 2. Enter a **companyName** and **platformType** and submit your request. The response returned includes: - - The **linkUrl** which allows your customer to authorize your connection to their data. - The data connection **id** which allows you to sync the company's data. diff --git a/docs/integrations/commerce/bigcommerce/commerce-bigcommerce-setup.md b/docs/integrations/commerce/bigcommerce/commerce-bigcommerce-setup.md index 88b14e5ed..c3b54b5f3 100644 --- a/docs/integrations/commerce/bigcommerce/commerce-bigcommerce-setup.md +++ b/docs/integrations/commerce/bigcommerce/commerce-bigcommerce-setup.md @@ -88,7 +88,6 @@ Your SMB customer does the following: 6. Click **API accounts > Create API account**. 7. On the **Create account** page, enter the following details: - - Leave the **Token type** as **V2/V3 API token**. - Enter the name of your organization in the **Name** box. - Set the [required OAuth scopes](/integrations/commerce/bigcommerce/commerce-bigcommerce-setup#required-oauth-scopes). @@ -100,7 +99,6 @@ Your SMB customer does the following: 8. Open the downloaded text file to view the store API account credentials. 9. Copy and paste the values from the text file into the corresponding boxes on the **Your BigCommerce Credentials** page (see step three). The following values are required: - - **Client ID** - **Client Secret** - **Access Token** diff --git a/docs/integrations/commerce/chargebee/commerce-chargebee-setup.md b/docs/integrations/commerce/chargebee/commerce-chargebee-setup.md index ec9ff66ec..a4228598e 100644 --- a/docs/integrations/commerce/chargebee/commerce-chargebee-setup.md +++ b/docs/integrations/commerce/chargebee/commerce-chargebee-setup.md @@ -58,7 +58,6 @@ Your SMB customer performs the following steps: 6. In the **API Keys and Webhooks** section, clicks **API Keys** to view their API key. 7. On the **Your Chargebee credentials** page, they enter the following details: - - Chargebee site name. This is part of the URL, for example, `https://site-name.chargebee.com`. - Chargebee API key. diff --git a/docs/integrations/commerce/clover/set-up-your-clover-integration.md b/docs/integrations/commerce/clover/set-up-your-clover-integration.md index 235c86b5c..6cbfc8370 100644 --- a/docs/integrations/commerce/clover/set-up-your-clover-integration.md +++ b/docs/integrations/commerce/clover/set-up-your-clover-integration.md @@ -17,7 +17,6 @@ Before you can access commerce data from customers using Clover, you need to set - If you already have a Clover developer account, have your account details to hand. - If you don't, sign up to the Clover developer portal before you start to create your application. Note that Clover's market currently covers many geographic regions and each is assigned a different domain. Create your developer portal by choosing your geographic area first: - - [US and Canada](https://www.clover.com) - [UK and Republic of Ireland/Europe](https://www.eu.clover.com) @@ -28,7 +27,6 @@ Before you can access commerce data from customers using Clover, you need to set 1. Go to the Clover developer portal and log in to your account. 2. Select **Create App** to create an app and get API credentials. 3. Fill in the required details for your app: - - Under **Requested Permissions**, tick "Read" for Customers, Inventory, Merchant, Orders, and Payments. - Set the** App type** to Web. - Under **REST Configuration** enter `https://clover.codat.io/oauth/callback` @@ -42,7 +40,6 @@ You'll be taken to your API credentials page with App ID and secret generated. K 3. Find **Clover**, then select **Set up** to view the **Integration settings** page. 4. Choose what [type of access to company data](/core-concepts/data-type-settings) you wish to have for this integration: one-off or continuous. 5. From the **API keys** page on the Clover developer portal, copy and paste: - - **App ID** value into **Client Id** - **App secret** value into **Client Secret**. diff --git a/docs/integrations/commerce/commerce-sync-settings.md b/docs/integrations/commerce/commerce-sync-settings.md index bcc5f3530..6a1baa1c5 100644 --- a/docs/integrations/commerce/commerce-sync-settings.md +++ b/docs/integrations/commerce/commerce-sync-settings.md @@ -13,7 +13,6 @@ In the Codat Portal: 1. In the navigation bar, click **Settings > Data types**. 2. Find the following data types and set the **Fetch on first link** toggle to **On**: - - **Commerce - Company Info** - **Commerce - Orders** - **Commerce - Products** diff --git a/docs/integrations/commerce/lightspeed-k/commerce-lightspeed-k-setup.md b/docs/integrations/commerce/lightspeed-k/commerce-lightspeed-k-setup.md index 75eaa1516..30e8492ff 100644 --- a/docs/integrations/commerce/lightspeed-k/commerce-lightspeed-k-setup.md +++ b/docs/integrations/commerce/lightspeed-k/commerce-lightspeed-k-setup.md @@ -41,7 +41,6 @@ Once your application has been processed, you should be sent your credentials to 1. On the navigation bar, select **Settings > Integrations > Commerce**. 2. Select the correct integration depending on whether you're configuring your app for testing or use by live clients - - For testing, click **Set up** next to the **Lightspeed K Trial** integration. - For production, click **Set up** next to the **Lightspeed K** integration. The **Integration settings** page is displayed. @@ -49,12 +48,10 @@ Once your application has been processed, you should be sent your credentials to 3. Under **Access to company data**, configure the permitted sync frequency for the integration. Select **Allow one-off data sync…** or **Allow continuous data sync**. 4. Enter the provided Client ID for your Lightspeed K app in the **Client ID** box. - - For testing, enter the **Staging Client ID** from Lightspeed. - For production, enter the **Production Client ID** from Lightspeed. 5. Enter the application secret for your Lightspeed K app in the **Client Secret** box. - - For testing, enter the **Staging Client secret** from Lightspeed. - For production, enter the **Production Client secret** from Lightspeed. diff --git a/docs/integrations/commerce/mollie/commerce-mollie-setup.md b/docs/integrations/commerce/mollie/commerce-mollie-setup.md index f9f9b270f..ddf25e051 100644 --- a/docs/integrations/commerce/mollie/commerce-mollie-setup.md +++ b/docs/integrations/commerce/mollie/commerce-mollie-setup.md @@ -43,7 +43,6 @@ In the Codat 1. In the navigation bar, select **Settings > Integrations > Commerce**. 2. Select the correct integration depending on whether you're testing the integration or building for production. - - If you want to test the integration and read sample data, click **Set up** next to the **Mollie Test** integration. - If you want to build for production and read live data, click **Set up** next to the **Mollie** integration. diff --git a/docs/integrations/commerce/shopify/commerce-shopify-public-apps.md b/docs/integrations/commerce/shopify/commerce-shopify-public-apps.md index 67f97912d..4058e58ac 100644 --- a/docs/integrations/commerce/shopify/commerce-shopify-public-apps.md +++ b/docs/integrations/commerce/shopify/commerce-shopify-public-apps.md @@ -48,7 +48,6 @@ When the app is created, you can view the app's secure credentials. 6. Click **Create app**. Your app is created and the app page is displayed. 7. In the side panel, click **App setup** to view the app's configuration settings. 8. Optional: if you plan to use Codat's `commerce-customers` data type, do the following on the **App setup** page: - 1. In the **Protected customer data access** box, click **Request access**. 2. Enter the details requested in the dialog, then submit your request to Shopify. @@ -139,7 +138,6 @@ In the Codat Portal, add the secure credentials for your Shopify app to the inte The **Integration settings** page is displayed. 3. Enter your app's credentials from Shopify (to find these, see [Create a Shopify public app](/integrations/commerce/shopify/commerce-shopify-public-apps#create-a-shopify-public-app)). - - For **Client ID**, enter the **API key** from Shopify. - For **Client secret**, enter the **API secret key** from Shopify. - For **App Redirect URL**, enter the location of your [authentication endpoint](/integrations/commerce/shopify/commerce-shopify-public-apps#build-an-app-for-merchant-authorization). diff --git a/docs/integrations/commerce/shopify/test-shopify.md b/docs/integrations/commerce/shopify/test-shopify.md index faa54c0bd..93378349c 100644 --- a/docs/integrations/commerce/shopify/test-shopify.md +++ b/docs/integrations/commerce/shopify/test-shopify.md @@ -62,7 +62,6 @@ When the Link flow is complete, your Development Store opens and your app is aut 6. (If using custom apps.) Complete the steps in Link; the exact steps shown depend on your Link settings. You'll need to: - 1. On the **Connect your Shopify store** screen, enter the name of your Development Store and your API Access Token, then click **Continue**. When the Link flow is complete, your Development Store opens and your custom app is automatically installed into the Store. diff --git a/docs/integrations/commerce/square/commerce-square-setup.md b/docs/integrations/commerce/square/commerce-square-setup.md index c79ddb664..14cb1742f 100644 --- a/docs/integrations/commerce/square/commerce-square-setup.md +++ b/docs/integrations/commerce/square/commerce-square-setup.md @@ -61,7 +61,6 @@ In the Codat 1. On the navigation bar, select **Settings > Integrations > Commerce**. 2. Select the correct integration depending on whether you're configuring your app in the Square Sandbox or production. - - For sandbox, click **Set up** next to the **Square Sandbox** integration. - For production, click **Set up** next to the **Square** integration. The **Integration settings** page is displayed. @@ -69,12 +68,10 @@ In the Codat 3. Under **Access to company data**, configure the permitted sync frequency for the integration. Select **Allow one-off data sync…** or **Allow continuous data sync**. 4. Enter the application ID for your Square app in the **Application ID** box. - - For sandbox, enter the **Sandbox Application ID** from Square. - For production, enter the **Production Application ID** from Square. 5. Enter the application secret for your Square app in the **Application Secret** box. - - For sandbox, enter the **Sandbox Application secret** from Square. - For production, enter the **Production Application secret** from Square. diff --git a/docs/integrations/commerce/stripe/commerce-stripe-setup.md b/docs/integrations/commerce/stripe/commerce-stripe-setup.md index ac8c30fb9..a5697dd4a 100644 --- a/docs/integrations/commerce/stripe/commerce-stripe-setup.md +++ b/docs/integrations/commerce/stripe/commerce-stripe-setup.md @@ -68,7 +68,6 @@ To access your live credentials in Stripe, you must have [added your business de 1. Go to the Connect settings page. 2. Use the **Test mode** switch at the top right to switch between live mode or test mode. - - Enable _test mode_ if you're setting up the Stripe Test integration. - Enable _live mode_ if you're setting up the Stripe integration. @@ -85,7 +84,6 @@ To access your live credentials in Stripe, you must have [added your business de ``` 7. Copy your client ID from the **Integration** section and paste it to a text file or similar. - - In test mode, copy the **Test mode client ID**. - In live mode, copy the **Live mode client ID**. @@ -108,7 +106,6 @@ In the Coda The **Integration settings** page is displayed. 3. In the **Client ID** box, enter your client ID for your Stripe Connect platform. - - For the **Stripe Test** integration, enter the **Test mode client ID**. - For the **Stripe** integration, enter the **Live mode client ID**. diff --git a/docs/integrations/commerce/stripe/test-stripe.md b/docs/integrations/commerce/stripe/test-stripe.md index f8b81d894..2b85c0612 100644 --- a/docs/integrations/commerce/stripe/test-stripe.md +++ b/docs/integrations/commerce/stripe/test-stripe.md @@ -25,7 +25,6 @@ In the Coda 1. Sign in to the Stripe Developers Dashboard. 2. Within your Stripe profile, create a new account for testing. The account will be created in test mode and can't be switched to live mode without activation. - 1. Select the account menu at the top left. 2. Select **New account**. 3. Enter a name for your testing account, then click **Create account**. diff --git a/docs/payables/get-started.md b/docs/payables/get-started.md index 6ac8136de..5e3f6b636 100644 --- a/docs/payables/get-started.md +++ b/docs/payables/get-started.md @@ -33,7 +33,7 @@ Once you decide to build with Bill Pay, you need to configure Codat accordingly. In the Codat Portal, navigate to **Settings > Integrations > Data types**. Enable the [data types](/core-concepts/data-type-settings#override-the-default-sync-settings) required for Bill Pay and set them to `Fetch on first link`: -| Data source | Data types | +| Data source | Data types | | ----------- | --------------------------------------------------------------------------------------------------------------------------------- | | Accounting | `bankAccounts`
`bills`
`billPayments`
`chartOfAccounts`
`company`
`paymentMethods`
`suppliers`
| diff --git a/docs/payables/guides/bill-pay/use-bill-pay-demo-app.md b/docs/payables/guides/bill-pay/use-bill-pay-demo-app.md index ed6a446a4..225b815b6 100644 --- a/docs/payables/guides/bill-pay/use-bill-pay-demo-app.md +++ b/docs/payables/guides/bill-pay/use-bill-pay-demo-app.md @@ -78,14 +78,12 @@ In Codat, create and update operations are asynchronous, which means that writin 2. From the **API Docs & Tools** tab, open the sandbox company you connected to the demo app. 3. In the sidebar, select **Get paid & pay**. 4. Check the status of the bill you paid in the demo app: - 1. Select **Bills > Paid**. 2. Select the bill and check the payment status is **Paid**. ![bill-pay_bill-status-paid](/img/use-cases/bill-pay/bill-pay_qbo-sandbox-company-bill-status-of-paid.png "A bill in QBO with a status of PAID.") 5. Check which bank account the payment was reconciled to: - 1. Go back to **Bills > Paid**. 2. In the **Action** column, select **Show payments** to reveal the payment row. 3. Click **View details** to open the bill payment that corresponds to the bill. diff --git a/docs/payables/overview.mdx b/docs/payables/overview.mdx index 775deaf02..95c19d00e 100644 --- a/docs/payables/overview.mdx +++ b/docs/payables/overview.mdx @@ -116,7 +116,9 @@ Pay process consists of three key steps: to Codat. We will reflect this transaction in your customer's accounting software and reconcile it against the original bill, marking it as paid. -Bill Pay is designed to integrate a bill pay flow into your app as quickly as possible, focusing on simplicity and efficiency of its endpoints and real-time updates with your SMBs' accounting systems. +Bill Pay is designed to integrate a bill pay flow into your app as quickly as +possible, focusing on simplicity and efficiency of its endpoints and real-time +updates with your SMBs' accounting systems. ## Supported integrations diff --git a/docs/spend-insights/guides/onboard-customer.md b/docs/spend-insights/guides/onboard-customer.md index b853bfcc1..2ab9ed22a 100644 --- a/docs/spend-insights/guides/onboard-customer.md +++ b/docs/spend-insights/guides/onboard-customer.md @@ -55,7 +55,6 @@ The steps to request this information are the same across these options: ![An image of the Companies tab with four companies listed as examples. A Request data button is highlighted next to a company entry called Hairosmith.](/img/spend-insights/si-manage-company-request-info.png) 2. In the _Onboarding_ window, choose how you want to ask your customer for their data: - - Copy the **Link URL** if you want to send a direct connection link to your customer or use the link in your own communication. - Copy the **Email template** if you would like support in providing additional context to your customer. You can view the template by clicking the dropdown icon. diff --git a/docs/using-the-api/best-practices/implementing-a-mapping-page.md b/docs/using-the-api/best-practices/implementing-a-mapping-page.md index 52769b4e7..4f6a3c835 100644 --- a/docs/using-the-api/best-practices/implementing-a-mapping-page.md +++ b/docs/using-the-api/best-practices/implementing-a-mapping-page.md @@ -33,7 +33,6 @@ Build your account mapping process to use the Codat API as follows: 2. [Configure a webhook consumer](/using-the-api/webhooks/create-consumer) to listen for the [DatasetDataChanged](/using-the-api/webhooks/event-types) event that indicates changes in the underlying data for the `chartOfAccounts` data type. You will receive a notification when the data sync completes successfully. 3. Once notified by the webhook, call our [List accounts](/accounting-api#/operations/list-accounts) endpoint and use the response to display `account.name` and `account.id` in a dropdown box for your customer to choose the correct mapping. You can also query the response to simplify the mapping experience for your customer: - - Display only active accounts of relevant account type needed for your mapping page, such as `type=income` and `status=active`. ``` diff --git a/docs/using-the-api/overview.md b/docs/using-the-api/overview.md index 4b7bb9a83..978b5ec14 100644 --- a/docs/using-the-api/overview.md +++ b/docs/using-the-api/overview.md @@ -10,12 +10,12 @@ While the Portal provides a simple way of exploring data, you'll need to use the We've packaged up Codat's functionality mainly by _solution_, with our _Platform API_ providing core functionalities used across our solution. You can explore each API and its endpoints in our API references. -| Solution API | Description | -| :------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------- | -| **[Bank Feeds](/bank-feeds-api)** | Set up bank feeds from accounts in your application to supported accounting software. | -| **[Lending](/lending-api)** | Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. | -| **[Expenses](/sync-for-expenses-api)** | Streamline expense reconciliation from the corporate card and expense management systems to your customers' accounting software. | -| **[Bill Pay](/sync-for-payables-v2-api#/)** | Make it easier for your customers to manage and pay suppliers from a single interface. | +| Solution API | Description | +| :------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------- | +| **[Bank Feeds](/bank-feeds-api)** | Set up bank feeds from accounts in your application to supported accounting software. | +| **[Lending](/lending-api)** | Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. | +| **[Expenses](/sync-for-expenses-api)** | Streamline expense reconciliation from the corporate card and expense management systems to your customers' accounting software. | +| **[Bill Pay](/sync-for-payables-v2-api#/)** | Make it easier for your customers to manage and pay suppliers from a single interface. | Explore the underlying [OpenAPI Spec](https://github.com/codatio/oas). diff --git a/docs/using-the-api/querying.md b/docs/using-the-api/querying.md index 202084212..80f102778 100644 --- a/docs/using-the-api/querying.md +++ b/docs/using-the-api/querying.md @@ -24,13 +24,13 @@ The below query functionality will only work when searching for company data (e. | Operator | Name | Encoded | Number | String | Date | | -------- | ------------------------ | :----------- | ------ | ------ | ---- | -| `=` | Equals | `%3d` | ✔ | ✔ | ✔ | -| `!=` | Not equals | `%21%3d` | ✔ | ✔ | ✔ | -| `~` | Contains | `%7E` | ❌ | ✔ | ❌ | -| `>` | Greater than | `%3e` | ✔ | ❌ | ✔ | -| `<` | Less than | `%3c` | ✔ | ❌ | ✔ | -| `>=` | Greater than or equal to | `%3e%3d` | ✔ | ❌ | ✔ | -| `<=` | Less than or equal to | `%3c%3d` | ✔ | ❌ | ✔ | +| `=` | Equals | `%3d` | ✔ | ✔ | ✔ | +| `!=` | Not equals | `%21%3d` | ✔ | ✔ | ✔ | +| `~` | Contains | `%7E` | ❌ | ✔ | ❌ | +| `>` | Greater than | `%3e` | ✔ | ❌ | ✔ | +| `<` | Less than | `%3c` | ✔ | ❌ | ✔ | +| `>=` | Greater than or equal to | `%3e%3d` | ✔ | ❌ | ✔ | +| `<=` | Less than or equal to | `%3c%3d` | ✔ | ❌ | ✔ | | `&&` | AND | `%26%26` | - | - | - | | `\|\|` | OR | `%7C%7C` | - | - | - | | `{`, `}` | Logical separator | `%7B`, `%7D` | - | - | - | diff --git a/docs/using-the-api/webhooks/migrating-to-new-event-types.md b/docs/using-the-api/webhooks/migrating-to-new-event-types.md index b07ba7974..9e01b5b65 100644 --- a/docs/using-the-api/webhooks/migrating-to-new-event-types.md +++ b/docs/using-the-api/webhooks/migrating-to-new-event-types.md @@ -23,7 +23,6 @@ To switch to new event types using the recommended "expand/contract" strategy, f 1. **Update your application logic** Modify your application logic to handle the existing and the new event types at the same time: - - Create a new POST endpoint specifically designed to consume the new webhook event type. - Create a feature toggle to control the activation of the **new** endpoint. **Enabling** the toggle should **activate** the endpoint to start processing events. - Create another feature toggle to control your **existing** webhook consumer. **Disabling** the toggle should **stop** the endpoint from processing the old rule types. diff --git a/docs/using-the-api/webhooks/troubleshooting.md b/docs/using-the-api/webhooks/troubleshooting.md index 45242036a..a97d9a2cd 100644 --- a/docs/using-the-api/webhooks/troubleshooting.md +++ b/docs/using-the-api/webhooks/troubleshooting.md @@ -29,10 +29,10 @@ A webhook consumer endpoint which is disabled after the 5 min retry, but then re ## Message Status -- **Success** indicates that there was at least one attempt for that message that succeeded against it's endpoint. +- **Success** indicates that there was at least one attempt for that message that succeeded against it's endpoint. - **Failure** indicates that all attempts were exhausted, and none of them succeeded. - **Attempting** indicates that at least one attempt has been sent and there are further attempts scheduled as part of the retry policy. -- **Sending** indicates that the process of sending the webhook has begun but there have been no delivery attempts yet. +- **Sending** indicates that the process of sending the webhook has begun but there have been no delivery attempts yet. ## Recover failed and missed messages