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: bankfeeds/docs/sdks/bankaccounttransactions/README.md
+36-13Lines changed: 36 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,22 @@ Bank feed bank accounts
6
6
7
7
### Available Operations
8
8
9
-
*[create](#create) - Create bank transactions
10
-
*[get](#get) - List push options for bank account bank transactions
11
-
*[list](#list) - List bank transactions for bank account
9
+
*[create](#create) - Create bank account transactions
10
+
*[get](#get) - Get create bank account transactions model
11
+
*[list](#list) - List bank account transactions
12
12
13
13
## create
14
14
15
-
Posts bank transactions to the accounting package for a given company.
15
+
The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.
16
+
17
+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
18
+
19
+
**Integration-specific behaviour**
20
+
21
+
Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/accounting-api#/operations/get-create-bankTransactions-model).
22
+
23
+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions.
16
24
17
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) to see which integrations support this endpoint.
18
25
19
26
### Example Usage
20
27
@@ -86,7 +93,16 @@ if res.create_bank_transactions_response is not None:
86
93
87
94
## get
88
95
89
-
Gets the options of pushing bank account transactions.
96
+
The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company and integration.
97
+
98
+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
99
+
100
+
**Integration-specific behaviour**
101
+
102
+
See the *response examples* for integration-specific indicative models.
103
+
104
+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating an bank transaction.
105
+
90
106
91
107
### Example Usage
92
108
@@ -100,7 +116,7 @@ s = codatbankfeeds.CodatBankFeeds(
|`request`|[operations.GetCreateBankAccountModelRequest](../../models/operations/getcreatebankaccountmodelrequest.md)|:heavy_check_mark:| The request object to use for the request. |
120
-
|`retries`|[Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)|:heavy_minus_sign:| Configuration to override the default retry behavior of the client. |
|`request`|[operations.GetCreateBankTransactionsModelRequest](../../models/operations/getcreatebanktransactionsmodelrequest.md)|:heavy_check_mark:| The request object to use for the request.|
136
+
|`retries`|[Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)|:heavy_minus_sign:| Configuration to override the default retry behavior of the client.|
Gets bank transactions for a given bank account ID
146
+
The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.
147
+
148
+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
149
+
150
+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support listing bank transactions.
151
+
152
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
Posts bank transactions to the accounting package for a given company.
17
+
r"""Create bank account transactions
18
+
The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.
19
19
20
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) to see which integrations support this endpoint.
20
+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
21
+
22
+
**Integration-specific behaviour**
23
+
24
+
Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/accounting-api#/operations/get-create-bankTransactions-model).
25
+
26
+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions.
The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company and integration.
72
+
73
+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
74
+
75
+
**Integration-specific behaviour**
76
+
77
+
See the *response examples* for integration-specific indicative models.
78
+
79
+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating an bank transaction.
Gets bank transactions for a given bank account ID
119
+
r"""List bank account transactions
120
+
The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.
121
+
122
+
[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.
123
+
124
+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support listing bank transactions.
125
+
126
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
0 commit comments