|
3 | 3 |
|
4 | 4 |
|
5 | 5 | <!-- Start SDK Installation --> |
6 | | -replace me |
| 6 | +## SDK Installation |
| 7 | + |
| 8 | +```bash |
| 9 | +pip install codat-sync-for-payroll |
| 10 | +``` |
7 | 11 | <!-- End SDK Installation --> |
8 | 12 |
|
9 | 13 | ## Example Usage |
10 | 14 | <!-- Start SDK Example Usage --> |
11 | | -replace me |
| 15 | + |
| 16 | + |
| 17 | +```python |
| 18 | +import codatsyncpayroll |
| 19 | +from codatsyncpayroll.models import operations, shared |
| 20 | +from decimal import Decimal |
| 21 | + |
| 22 | +s = codatsyncpayroll.CodatSyncPayroll( |
| 23 | + security=shared.Security( |
| 24 | + auth_header="Basic BASE_64_ENCODED(API_KEY)", |
| 25 | + ), |
| 26 | +) |
| 27 | + |
| 28 | +req = operations.CreateAccountRequest( |
| 29 | + account=shared.Account( |
| 30 | + currency='USD', |
| 31 | + current_balance=Decimal('0'), |
| 32 | + description='Invoices the business has issued but has not yet collected payment on.', |
| 33 | + fully_qualified_category='Asset.Current', |
| 34 | + fully_qualified_name='Fixed Asset', |
| 35 | + id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e', |
| 36 | + is_bank_account=False, |
| 37 | + metadata=shared.AccountMetadata( |
| 38 | + is_deleted=False, |
| 39 | + ), |
| 40 | + modified_date='2022-10-23T00:00:00.000Z', |
| 41 | + name='Accounts Receivable', |
| 42 | + nominal_code='610', |
| 43 | + source_modified_date='2022-10-23T00:00:00.000Z', |
| 44 | + status=shared.AccountStatus.ACTIVE, |
| 45 | + type=shared.AccountType.ASSET, |
| 46 | + valid_datatype_links=[ |
| 47 | + shared.AccountValidDataTypeLinks( |
| 48 | + links=[ |
| 49 | + 'unde', |
| 50 | + ], |
| 51 | + property='nulla', |
| 52 | + ), |
| 53 | + ], |
| 54 | + ), |
| 55 | + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', |
| 56 | + connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', |
| 57 | + timeout_in_minutes=544883, |
| 58 | +) |
| 59 | + |
| 60 | +res = s.accounts.create(req) |
| 61 | + |
| 62 | +if res.create_account_response is not None: |
| 63 | + # handle response |
| 64 | +``` |
12 | 65 | <!-- End SDK Example Usage --> |
13 | 66 |
|
14 | 67 | <!-- Start SDK Available Operations --> |
15 | | -replace me |
| 68 | +## Available Resources and Operations |
| 69 | + |
| 70 | + |
| 71 | +### [accounts](docs/sdks/accounts/README.md) |
| 72 | + |
| 73 | +* [create](docs/sdks/accounts/README.md#create) - Create account |
| 74 | +* [get](docs/sdks/accounts/README.md#get) - Get account |
| 75 | +* [get_create_model](docs/sdks/accounts/README.md#get_create_model) - Get create account model |
| 76 | +* [list](docs/sdks/accounts/README.md#list) - List accounts |
| 77 | + |
| 78 | +### [companies](docs/sdks/companies/README.md) |
| 79 | + |
| 80 | +* [create](docs/sdks/companies/README.md#create) - Create company |
| 81 | +* [delete](docs/sdks/companies/README.md#delete) - Delete a company |
| 82 | +* [get](docs/sdks/companies/README.md#get) - Get company |
| 83 | +* [list](docs/sdks/companies/README.md#list) - List companies |
| 84 | +* [update](docs/sdks/companies/README.md#update) - Update company |
| 85 | + |
| 86 | +### [company_info](docs/sdks/companyinfo/README.md) |
| 87 | + |
| 88 | +* [get_accounting_profile](docs/sdks/companyinfo/README.md#get_accounting_profile) - Get company accounting profile |
| 89 | + |
| 90 | +### [connections](docs/sdks/connections/README.md) |
| 91 | + |
| 92 | +* [create](docs/sdks/connections/README.md#create) - Create connection |
| 93 | +* [delete](docs/sdks/connections/README.md#delete) - Delete connection |
| 94 | +* [get](docs/sdks/connections/README.md#get) - Get connection |
| 95 | +* [list](docs/sdks/connections/README.md#list) - List connections |
| 96 | +* [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection |
| 97 | + |
| 98 | +### [journal_entries](docs/sdks/journalentries/README.md) |
| 99 | + |
| 100 | +* [create](docs/sdks/journalentries/README.md#create) - Create journal entry |
| 101 | +* [delete](docs/sdks/journalentries/README.md#delete) - Delete journal entry |
| 102 | +* [get](docs/sdks/journalentries/README.md#get) - Get journal entry |
| 103 | +* [get_create_model](docs/sdks/journalentries/README.md#get_create_model) - Get create journal entry model |
| 104 | +* [list](docs/sdks/journalentries/README.md#list) - List journal entries |
| 105 | + |
| 106 | +### [journals](docs/sdks/journals/README.md) |
| 107 | + |
| 108 | +* [create](docs/sdks/journals/README.md#create) - Create journal |
| 109 | +* [get](docs/sdks/journals/README.md#get) - Get journal |
| 110 | +* [get_create_model](docs/sdks/journals/README.md#get_create_model) - Get create journal model |
| 111 | +* [list](docs/sdks/journals/README.md#list) - List journals |
| 112 | + |
| 113 | +### [manage_data](docs/sdks/managedata/README.md) |
| 114 | + |
| 115 | +* [get_data_status](docs/sdks/managedata/README.md#get_data_status) - Get data status |
| 116 | +* [get_pull_operation](docs/sdks/managedata/README.md#get_pull_operation) - Get pull operation |
| 117 | +* [get_push_operation](docs/sdks/managedata/README.md#get_push_operation) - Get push operation |
| 118 | +* [list](docs/sdks/managedata/README.md#list) - List push operations |
| 119 | +* [list_pull_operations](docs/sdks/managedata/README.md#list_pull_operations) - List pull operations |
| 120 | +* [refresh_all_data_types](docs/sdks/managedata/README.md#refresh_all_data_types) - Refresh all data |
| 121 | +* [refresh_data_type](docs/sdks/managedata/README.md#refresh_data_type) - Refresh data type |
| 122 | + |
| 123 | +### [tracking_categories](docs/sdks/trackingcategories/README.md) |
| 124 | + |
| 125 | +* [get](docs/sdks/trackingcategories/README.md#get) - Get tracking categories |
| 126 | +* [list](docs/sdks/trackingcategories/README.md#list) - List tracking categories |
16 | 127 | <!-- End SDK Available Operations --> |
17 | 128 | ### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) |
0 commit comments