|
3 | 3 | Embedded accounting integrations for POS and eCommerce platforms. |
4 | 4 |
|
5 | 5 | <!-- Start SDK Installation --> |
6 | | -replace me |
| 6 | +## SDK Installation |
| 7 | + |
| 8 | +```bash |
| 9 | +pip install codat-sync-for-commerce-version-1 |
| 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 codatsynccommerce |
| 19 | +from codatsynccommerce.models import operations, shared |
| 20 | +from decimal import Decimal |
| 21 | + |
| 22 | +s = codatsynccommerce.CodatSyncCommerce( |
| 23 | + security=shared.Security( |
| 24 | + auth_header="Basic BASE_64_ENCODED(API_KEY)", |
| 25 | + ), |
| 26 | +) |
| 27 | + |
| 28 | +req = operations.CreateAccountingAccountRequest( |
| 29 | + accounting_account=shared.AccountingAccount( |
| 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.AccountingAccountMetadata( |
| 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.AccountingAccountValidDataTypeLinks( |
| 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.accounting_accounts.create_accounting_account(req) |
| 61 | + |
| 62 | +if res.accounting_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 | +### [accounting_accounts](docs/sdks/accountingaccounts/README.md) |
| 72 | + |
| 73 | +* [create_accounting_account](docs/sdks/accountingaccounts/README.md#create_accounting_account) - Create account |
| 74 | +* [get_accounting_account](docs/sdks/accountingaccounts/README.md#get_accounting_account) - Get account |
| 75 | +* [list_accounting_accounts](docs/sdks/accountingaccounts/README.md#list_accounting_accounts) - List accounts |
| 76 | + |
| 77 | +### [accounting_bank_accounts](docs/sdks/accountingbankaccounts/README.md) |
| 78 | + |
| 79 | +* [get_accounting_bank_account](docs/sdks/accountingbankaccounts/README.md#get_accounting_bank_account) - Get bank account |
| 80 | +* [list_accounting_bank_accounts](docs/sdks/accountingbankaccounts/README.md#list_accounting_bank_accounts) - List bank accounts |
| 81 | + |
| 82 | +### [accounting_company_info](docs/sdks/accountingcompanyinfo/README.md) |
| 83 | + |
| 84 | +* [get_accounting_company_info](docs/sdks/accountingcompanyinfo/README.md#get_accounting_company_info) - Get company info |
| 85 | +* [refresh](docs/sdks/accountingcompanyinfo/README.md#refresh) - Refresh company info |
| 86 | + |
| 87 | +### [accounting_credit_notes](docs/sdks/accountingcreditnotes/README.md) |
| 88 | + |
| 89 | +* [create_accounting_credit_note](docs/sdks/accountingcreditnotes/README.md#create_accounting_credit_note) - Create credit note |
| 90 | + |
| 91 | +### [accounting_customers](docs/sdks/accountingcustomers/README.md) |
| 92 | + |
| 93 | +* [create_accounting_customer](docs/sdks/accountingcustomers/README.md#create_accounting_customer) - Create customer |
| 94 | + |
| 95 | +### [accounting_direct_incomes](docs/sdks/accountingdirectincomes/README.md) |
| 96 | + |
| 97 | +* [create_accounting_direct_income](docs/sdks/accountingdirectincomes/README.md#create_accounting_direct_income) - Create direct income |
| 98 | + |
| 99 | +### [accounting_invoices](docs/sdks/accountinginvoices/README.md) |
| 100 | + |
| 101 | +* [create_accounting_invoice](docs/sdks/accountinginvoices/README.md#create_accounting_invoice) - Create invoice |
| 102 | + |
| 103 | +### [accounting_journal_entries](docs/sdks/accountingjournalentries/README.md) |
| 104 | + |
| 105 | +* [create_accounting_journal_entry](docs/sdks/accountingjournalentries/README.md#create_accounting_journal_entry) - Create journal entry |
| 106 | + |
| 107 | +### [accounting_payments](docs/sdks/accountingpayments/README.md) |
| 108 | + |
| 109 | +* [create_accounting_payment](docs/sdks/accountingpayments/README.md#create_accounting_payment) - Create payment |
| 110 | + |
| 111 | +### [commerce_company_info](docs/sdks/commercecompanyinfo/README.md) |
| 112 | + |
| 113 | +* [get_commerce_company_info](docs/sdks/commercecompanyinfo/README.md#get_commerce_company_info) - Get company info |
| 114 | + |
| 115 | +### [commerce_customers](docs/sdks/commercecustomers/README.md) |
| 116 | + |
| 117 | +* [get_commerce_customer](docs/sdks/commercecustomers/README.md#get_commerce_customer) - Get customer |
| 118 | +* [list_commerce_customers](docs/sdks/commercecustomers/README.md#list_commerce_customers) - List customers |
| 119 | + |
| 120 | +### [commerce_locations](docs/sdks/commercelocations/README.md) |
| 121 | + |
| 122 | +* [get_commerce_location](docs/sdks/commercelocations/README.md#get_commerce_location) - Get location |
| 123 | +* [list_commerce_locations](docs/sdks/commercelocations/README.md#list_commerce_locations) - List locations |
| 124 | + |
| 125 | +### [commerce_orders](docs/sdks/commerceorders/README.md) |
| 126 | + |
| 127 | +* [get_commerce_order](docs/sdks/commerceorders/README.md#get_commerce_order) - Get order |
| 128 | +* [list_commerce_orders](docs/sdks/commerceorders/README.md#list_commerce_orders) - List orders |
| 129 | + |
| 130 | +### [commerce_payments](docs/sdks/commercepayments/README.md) |
| 131 | + |
| 132 | +* [get_commerce_payment](docs/sdks/commercepayments/README.md#get_commerce_payment) - Get payment |
| 133 | +* [get_method](docs/sdks/commercepayments/README.md#get_method) - Get payment method |
| 134 | +* [list_commerce_payments](docs/sdks/commercepayments/README.md#list_commerce_payments) - List payments |
| 135 | +* [list_methods](docs/sdks/commercepayments/README.md#list_methods) - List payment methods |
| 136 | + |
| 137 | +### [commerce_products](docs/sdks/commerceproducts/README.md) |
| 138 | + |
| 139 | +* [get_commerce_product](docs/sdks/commerceproducts/README.md#get_commerce_product) - Get product |
| 140 | +* [list_commerce_products](docs/sdks/commerceproducts/README.md#list_commerce_products) - List products |
| 141 | + |
| 142 | +### [commerce_transactions](docs/sdks/commercetransactions/README.md) |
| 143 | + |
| 144 | +* [get_commerce_transaction](docs/sdks/commercetransactions/README.md#get_commerce_transaction) - Get transaction |
| 145 | +* [list_commerce_transactions](docs/sdks/commercetransactions/README.md#list_commerce_transactions) - List transactions |
| 146 | + |
| 147 | +### [companies](docs/sdks/companies/README.md) |
| 148 | + |
| 149 | +* [delete_company](docs/sdks/companies/README.md#delete_company) - Delete a company |
| 150 | +* [get_company](docs/sdks/companies/README.md#get_company) - Get company |
| 151 | +* [update_company](docs/sdks/companies/README.md#update_company) - Update company |
| 152 | + |
| 153 | +### [company_management](docs/sdks/companymanagement/README.md) |
| 154 | + |
| 155 | +* [create_company](docs/sdks/companymanagement/README.md#create_company) - Create Sync for Commerce company |
| 156 | +* [create_connection](docs/sdks/companymanagement/README.md#create_connection) - Create connection |
| 157 | +* [list_companies](docs/sdks/companymanagement/README.md#list_companies) - List companies |
| 158 | +* [list_connections](docs/sdks/companymanagement/README.md#list_connections) - List data connections |
| 159 | +* [update_connection](docs/sdks/companymanagement/README.md#update_connection) - Update data connection |
| 160 | + |
| 161 | +### [configuration](docs/sdks/configuration/README.md) |
| 162 | + |
| 163 | +* [get_configuration](docs/sdks/configuration/README.md#get_configuration) - Retrieve config preferences set for a company. |
| 164 | +* [set_configuration](docs/sdks/configuration/README.md#set_configuration) - Create or update configuration. |
| 165 | + |
| 166 | +### [connections](docs/sdks/connections/README.md) |
| 167 | + |
| 168 | +* [delete_connection](docs/sdks/connections/README.md#delete_connection) - Delete connection |
| 169 | +* [get_connection](docs/sdks/connections/README.md#get_connection) - Get connection |
| 170 | +* [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection |
| 171 | + |
| 172 | +### [integrations](docs/sdks/integrations/README.md) |
| 173 | + |
| 174 | +* [get_integration_branding](docs/sdks/integrations/README.md#get_integration_branding) - Get branding for an integration |
| 175 | +* [list_integrations](docs/sdks/integrations/README.md#list_integrations) - List information on Codat's supported integrations |
| 176 | + |
| 177 | +### [push_data](docs/sdks/pushdata/README.md) |
| 178 | + |
| 179 | +* [get_operation](docs/sdks/pushdata/README.md#get_operation) - Get push operation |
| 180 | +* [list_operations](docs/sdks/pushdata/README.md#list_operations) - List push operations |
| 181 | + |
| 182 | +### [refresh_data](docs/sdks/refreshdata/README.md) |
| 183 | + |
| 184 | +* [all](docs/sdks/refreshdata/README.md#all) - Refresh all data |
| 185 | +* [by_data_type](docs/sdks/refreshdata/README.md#by_data_type) - Refresh data type |
| 186 | +* [get_company_data_status](docs/sdks/refreshdata/README.md#get_company_data_status) - Get data status |
| 187 | +* [get_pull_operation](docs/sdks/refreshdata/README.md#get_pull_operation) - Get pull operation |
| 188 | +* [list_pull_operations](docs/sdks/refreshdata/README.md#list_pull_operations) - List pull operations |
| 189 | + |
| 190 | +### [sync](docs/sdks/sync/README.md) |
| 191 | + |
| 192 | +* [get_sync_status](docs/sdks/sync/README.md#get_sync_status) - Get status for a company's syncs |
| 193 | +* [request_sync](docs/sdks/sync/README.md#request_sync) - Sync new |
| 194 | +* [request_sync_for_date_range](docs/sdks/sync/README.md#request_sync_for_date_range) - Sync range |
| 195 | + |
| 196 | +### [sync_flow_preferences](docs/sdks/syncflowpreferences/README.md) |
| 197 | + |
| 198 | +* [get_config_text_sync_flow](docs/sdks/syncflowpreferences/README.md#get_config_text_sync_flow) - Retrieve preferences for text fields on Sync Flow |
| 199 | +* [get_sync_flow_url](docs/sdks/syncflowpreferences/README.md#get_sync_flow_url) - Retrieve sync flow url |
| 200 | +* [get_visible_accounts](docs/sdks/syncflowpreferences/README.md#get_visible_accounts) - List visible accounts |
| 201 | +* [update_config_text_sync_flow](docs/sdks/syncflowpreferences/README.md#update_config_text_sync_flow) - Update preferences for text fields on sync flow |
| 202 | +* [update_visible_accounts_sync_flow](docs/sdks/syncflowpreferences/README.md#update_visible_accounts_sync_flow) - Update the visible accounts on Sync Flow |
16 | 203 | <!-- End SDK Available Operations --> |
17 | 204 | ### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) |
0 commit comments