|
1 | 1 | # Bank Feeds |
2 | 2 |
|
3 | 3 | <!-- Start Codat Library Description --> |
4 | | -<!-- End Codat Library Description --> |
5 | 4 | Bank Feeds API enables your SMB users to set up bank feeds from accounts in your application to supported accounting platforms. |
| 5 | +<!-- End Codat Library Description --> |
6 | 6 |
|
7 | 7 | <!-- Start SDK Installation --> |
8 | | -replace me |
| 8 | +## SDK Installation |
| 9 | + |
| 10 | +```bash |
| 11 | +pip install codat-bankfeeds |
| 12 | +``` |
9 | 13 | <!-- End SDK Installation --> |
10 | 14 |
|
11 | 15 | ## Example Usage |
12 | 16 | <!-- Start SDK Example Usage --> |
13 | | -replace me |
| 17 | + |
| 18 | + |
| 19 | +```python |
| 20 | +import codatbankfeeds |
| 21 | +from codatbankfeeds.models import operations, shared |
| 22 | + |
| 23 | +s = codatbankfeeds.CodatBankFeeds( |
| 24 | + security=shared.Security( |
| 25 | + auth_header="Basic BASE_64_ENCODED(API_KEY)", |
| 26 | + ), |
| 27 | +) |
| 28 | + |
| 29 | +req = operations.CreateBankAccountMappingRequest( |
| 30 | + request_body=operations.CreateBankAccountMappingBankFeedAccountMapping( |
| 31 | + feed_start_date='2022-10-23T00:00:00.000Z', |
| 32 | + source_account_id='provident', |
| 33 | + target_account_id='distinctio', |
| 34 | + ), |
| 35 | + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', |
| 36 | + connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', |
| 37 | +) |
| 38 | + |
| 39 | +res = s.account_mapping.create(req) |
| 40 | + |
| 41 | +if res.bank_feed_account_mapping_response is not None: |
| 42 | + # handle response |
| 43 | +``` |
14 | 44 | <!-- End SDK Example Usage --> |
15 | 45 |
|
16 | 46 | <!-- Start SDK Available Operations --> |
17 | | -replace me |
| 47 | +## Available Resources and Operations |
| 48 | + |
| 49 | + |
| 50 | +### [AccountMapping](docs/sdks/accountmapping/README.md) |
| 51 | + |
| 52 | +* [create](docs/sdks/accountmapping/README.md#create) - Create bank feed account mapping |
| 53 | +* [get](docs/sdks/accountmapping/README.md#get) - List bank feed account mappings |
| 54 | + |
| 55 | +### [Companies](docs/sdks/companies/README.md) |
| 56 | + |
| 57 | +* [create](docs/sdks/companies/README.md#create) - Create company |
| 58 | +* [delete](docs/sdks/companies/README.md#delete) - Delete a company |
| 59 | +* [get](docs/sdks/companies/README.md#get) - Get company |
| 60 | +* [list](docs/sdks/companies/README.md#list) - List companies |
| 61 | +* [update](docs/sdks/companies/README.md#update) - Update company |
| 62 | + |
| 63 | +### [Connections](docs/sdks/connections/README.md) |
| 64 | + |
| 65 | +* [create](docs/sdks/connections/README.md#create) - Create connection |
| 66 | +* [delete](docs/sdks/connections/README.md#delete) - Delete connection |
| 67 | +* [get](docs/sdks/connections/README.md#get) - Get connection |
| 68 | +* [list](docs/sdks/connections/README.md#list) - List connections |
| 69 | +* [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection |
| 70 | + |
| 71 | +### [SourceAccounts](docs/sdks/sourceaccounts/README.md) |
| 72 | + |
| 73 | +* [create](docs/sdks/sourceaccounts/README.md#create) - Create source account |
| 74 | +* [delete](docs/sdks/sourceaccounts/README.md#delete) - Delete source account |
| 75 | +* [delete_credentials](docs/sdks/sourceaccounts/README.md#delete_credentials) - Delete all source account credentials |
| 76 | +* [generate_credentials](docs/sdks/sourceaccounts/README.md#generate_credentials) - Generate source account credentials |
| 77 | +* [list](docs/sdks/sourceaccounts/README.md#list) - List source accounts |
| 78 | +* [update](docs/sdks/sourceaccounts/README.md#update) - Update source account |
| 79 | + |
| 80 | +### [Transactions](docs/sdks/transactions/README.md) |
| 81 | + |
| 82 | +* [create](docs/sdks/transactions/README.md#create) - Create bank transactions |
| 83 | +* [get_create_operation](docs/sdks/transactions/README.md#get_create_operation) - Get create operation |
| 84 | +* [list_create_operations](docs/sdks/transactions/README.md#list_create_operations) - List create operations |
18 | 85 | <!-- End SDK Available Operations --> |
19 | 86 | ### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) |
0 commit comments