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: expenses/docs/models/shared/dataconnection.md
+10-1Lines changed: 10 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,15 @@
1
1
# DataConnection
2
2
3
-
A connection represents the link between a `company` and a source of data.
3
+
A connection represents a [company's](https://docs.codat.io/codat-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.
4
+
5
+
A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:
6
+
7
+
-[Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.
8
+
-[Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.
9
+
-[Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.
10
+
Any combination of accounting, banking, and commerce data connections is allowed.
11
+
12
+
Before you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview).
Copy file name to clipboardExpand all lines: expenses/src/codatsyncexpenses/models/shared/dataconnection.py
+11-1Lines changed: 11 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,17 @@ class DataConnectionSourceType(str, Enum):
22
22
23
23
@dataclasses.dataclass
24
24
classDataConnection:
25
-
r"""A connection represents the link between a `company` and a source of data."""
25
+
r"""A connection represents a [company's](https://docs.codat.io/codat-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.
26
+
27
+
A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:
28
+
29
+
- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.
30
+
- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.
31
+
- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.
32
+
Any combination of accounting, banking, and commerce data connections is allowed.
33
+
34
+
Before you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview).
r"""In Codat's data model, dates and times are represented using the <a class=\\"external\\" href=\\"https://en.wikipedia.org/wiki/ISO_8601\\" target=\\"_blank\\">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
0 commit comments