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
Copy file name to clipboardExpand all lines: platform/CodatPlatform/Companies.cs
+25-10Lines changed: 25 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -29,11 +29,12 @@ public interface ICompanies
29
29
/// Create company
30
30
///
31
31
/// <remarks>
32
-
/// Creates a new company that can be used to assign connections to. <br/>
32
+
/// Use the *Create company* endpoint to create a new <a href="https://docs.codat.io/platform-api#/schemas/Company">company</a> that represents your customer in Codat. <br/>
33
33
/// <br/>
34
-
/// If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.<br/>
34
+
/// A <a href="https://docs.codat.io/platform-api#/schemas/Company">company</a> represents a business sharing access to their data.<br/>
35
+
/// 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.<br/>
35
36
/// <br/>
36
-
///
37
+
/// If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
/// The *Delete company* endpoint permanently deletes a <a href="https://docs.codat.io/platform-api#/schemas/Company">company</a>, its <a href="https://docs.codat.io/platform-api#/schemas/Connection">connections</a> and any cached data. This operation is irreversible.<br/>
45
47
/// <br/>
46
-
/// Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned.
48
+
/// A <a href="https://docs.codat.io/platform-api#/schemas/Company">company</a> represents a business sharing access to their data.<br/>
49
+
/// 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.<br/>
/// Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned.
59
+
/// The *Get company* endpoint returns a single company for a given `companyId`.<br/>
60
+
/// <br/>
61
+
/// A <a href="https://docs.codat.io/platform-api#/schemas/Company">company</a> represents a business sharing access to their data.<br/>
62
+
/// 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.<br/>
/// Returns a list of your companies. The company schema contains a list of <a href="https://docs.codat.io/platform-api#/schemas/Connection">connections</a> related to the company.
72
+
/// The *List companies* endpoint returns a list of [companies] associated to your instances.<br/>
73
+
/// <br/>
74
+
/// A <a href="https://docs.codat.io/platform-api#/schemas/Company">company</a> represents a business sharing access to their data.<br/>
75
+
/// 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.
/// Updates both the name and description of the company.
84
+
/// Use the *Update company* endpoint to update both the name and description of the company. <br/>
85
+
/// If you use <a href="https://docs.codat.io/platform-api#/schemas/Group">groups</a> to manage a set of companies, use the <a href="https://docs.codat.io/platform-api#/operations/add-company-to-group">Add company</a> or <a href="https://docs.codat.io/platform-api#/operations/remove-company-from-group">Remove company</a> endpoints to add or remove a company from a group.<br/>
86
+
/// <br/>
87
+
/// A <a href="https://docs.codat.io/platform-api#/schemas/Company">company</a> represents a business sharing access to their data.<br/>
88
+
/// 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.
0 commit comments