Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update multiple-use-cases.md #1595

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/enterprise/tech-implementation/multiple-use-cases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,13 @@ 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.

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.

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.
Expand All @@ -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.

![Sync flow diagram for creating new companies with products](/img/enterprise/implementation/consent/syncflowproductsnew.png)
![Sync flow diagram for updating existing companies with products](/img/enterprise/implementation/consent/syncflowproductsexisting.png)

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

![Sync flow diagram for updating existing companies with products](/img/enterprise/implementation/consent/syncflowproductsexisting.png)
![Sync flow diagram for creating new companies with products](/img/enterprise/implementation/consent/syncflowproductsnew.png)

To remove a product from an existing company, use the [Remove product](/platform-api#/operations/remove-product) endpoint.

Expand Down
Loading