You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<Description>An API for the common components of all of Codat's products.
13
-
14
-
These end points cover creating and managing your companies, data connections, and integrations.
15
-
16
-
[Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas)
17
-
18
-
---
19
-
<!-- Start Codat Tags Table -->
20
-
## Endpoints
21
-
22
-
| Endpoints | Description |
23
-
| :- |:- |
24
-
| Companies | Create and manage your SMB users' companies. |
25
-
| Connections | Create new and manage existing data connections for a company. |
26
-
| Connection management | Configure connection management UI and retrieve access tokens for authentication. |
27
-
| Webhooks | Create and manage webhooks that listen to Codat's events. |
28
-
| Integrations | Get a list of integrations supported by Codat and their logos. |
29
-
| Refresh data | Initiate data refreshes, view pull status and history. |
30
-
| Settings | Manage company profile configuration, sync settings, and API keys. |
31
-
| Push data | Initiate and monitor Create, Update, and Delete operations. |
32
-
| Supplemental data | Configure and pull additional data you can include in Codat's standard data types. |
33
-
| Custom data type | Configure and pull additional data types that are not included in Codat's standardized data model. |
34
-
<!-- End Codat Tags Table --></Description>
12
+
<Description>An API for the common components of all of Codat's products.<br/>
13
+
<br/>
14
+
These end points cover creating and managing your companies, data connections, and integrations.<br/>
15
+
<br/>
16
+
<ahref="https://docs.codat.io/core-concepts/companies">Read about the building blocks of Codat...</a> | <ahref="https://github.com/codatio/oas">See our OpenAPI spec</a> <br/>
17
+
<br/>
18
+
---<br/>
19
+
<!-- Start Codat Tags Table --><br/>
20
+
## Endpoints<br/>
21
+
<br/>
22
+
| Endpoints | Description |<br/>
23
+
| :- |:- |<br/>
24
+
| Companies | Create and manage your SMB users' companies. |<br/>
25
+
| Connections | Create new and manage existing data connections for a company. |<br/>
26
+
| Connection management | Configure connection management UI and retrieve access tokens for authentication. |<br/>
27
+
| Webhooks | Create and manage webhooks that listen to Codat's events. |<br/>
28
+
| Integrations | Get a list of integrations supported by Codat and their logos. |<br/>
29
+
| Refresh data | Initiate data refreshes, view pull status and history. |<br/>
30
+
| Settings | Manage company profile configuration, sync settings, and API keys. |<br/>
31
+
| Push data | Initiate and monitor Create, Update, and Delete operations. |<br/>
32
+
| Supplemental data | Configure and pull additional data you can include in Codat's standard data types. |<br/>
33
+
| Custom data type | Configure and pull additional data types that are not included in Codat's standardized data model. |<br/>
Copy file name to clipboardExpand all lines: platform/Codat/Platform/Companies.cs
+133-4Lines changed: 133 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ public interface ICompanies
32
32
/// List companies
33
33
///
34
34
/// <remarks>
35
-
/// The *List companies* endpoint returns a list of [companies] associated to your instances.<br/>
35
+
/// The *List companies* endpoint returns a list of <a href="https://docs.codat.io/platform-api#/schemas/Company">companies</a> associated to your instances.<br/>
36
36
/// <br/>
37
37
/// A <a href="https://docs.codat.io/platform-api#/schemas/Company">company</a> represents a business sharing access to their data.<br/>
38
38
/// Each company can have multiple <a href="https://docs.codat.io/platform-api#/schemas/Connection">connections</a> to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
/// Use the _Get company access token_ endpoint to return an access token for the specified company ID to use in Codat's embedded UI products.<br/>
0 commit comments