-
Notifications
You must be signed in to change notification settings - Fork 41
Update multiple-use-cases.md #1595
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,12 +17,14 @@ This guide is aimed at enterprise clients who use Codat's solutions for multiple | |
| - **Standard products** that include data types defined by Codat as relevant and are available globally for all clients, such as Bank Feeds, Expenses, or Lending. | ||
| - **Custom products** that include data types requested by the client for a bespoke solution and are only available for use by that client. | ||
|
|
||
| You can apply **sync settings** that fit your use case best to these data types. Codat distinguishes: | ||
| You can apply either **sync settings** that fit your use case best. Codat distinguishes either: | ||
|
|
||
| - **Client-level** sync settings that are managed via **Settings > Data Types** in the Codat Portal. | ||
| - **Client-level** sync settings that are managed via **Settings > Data Types** in the Codat Portal, or | ||
| - **Product-level** sync settings that are maintained by Codat upon client request. | ||
|
|
||
| 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. | ||
| 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. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| 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. | ||
|
|
||
|
|
@@ -34,15 +36,15 @@ The following guidance is suitable for enterprise clients who have implemented C | |
|
|
||
| You can assign a product to a company at the point of creating that company. As a result, product-level sync settings will apply to the first data fetch every time the company gains a new connection in the `Linked` status. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ### Update existing company | ||
|
|
||
| You can assign a product to an existing company that already has a connection in the `Linked` status using the [Add product](/platform-api#/operations/add-product) endpoint. The product-level sync settings will apply to the connection once the product is added. | ||
|
|
||
| This scenario assumes your customer has consented to the data type requirements of the additional use case. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| To remove a product from an existing company, use the [Remove product](/platform-api#/operations/remove-product) endpoint. | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('are represented').