diff --git a/previous-versions/sync-for-commerce-version-1/README.md b/previous-versions/sync-for-commerce-version-1/README.md index 5dda8da23..158adef54 100644 --- a/previous-versions/sync-for-commerce-version-1/README.md +++ b/previous-versions/sync-for-commerce-version-1/README.md @@ -14,8 +14,6 @@ pip install codat-sync-for-commerce-version-1 ## Example Usage - - ```python import codatsynccommerce from codatsynccommerce.models import operations, shared @@ -29,40 +27,43 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.CreateAccountingAccountRequest( accounting_account=shared.AccountingAccount( - currency='USD', + currency='GBP', current_balance=Decimal('0'), description='Invoices the business has issued but has not yet collected payment on.', fully_qualified_category='Asset.Current', - fully_qualified_name='Fixed Asset', + fully_qualified_name='Cash On Hand', id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e', - is_bank_account=False, - metadata=shared.AccountingAccountMetadata( - is_deleted=False, - ), + metadata=shared.AccountingAccountMetadata(), modified_date='2022-10-23T00:00:00.000Z', name='Accounts Receivable', nominal_code='610', source_modified_date='2022-10-23T00:00:00.000Z', status=shared.AccountStatus.ACTIVE, + supplemental_data=shared.SupplementalData( + content={ + "Gasoline": { + "Wall": 'Oriental', + }, + }, + ), type=shared.AccountType.ASSET, valid_datatype_links=[ shared.AccountingAccountValidDataTypeLinks( links=[ - 'unde', + 'Intranet', ], - property='nulla', ), ], ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=544883, ) res = s.accounting_accounts.create_accounting_account(req) if res.accounting_create_account_response is not None: # handle response + pass ``` @@ -154,7 +155,7 @@ if res.accounting_create_account_response is not None: ### [company_management](docs/sdks/companymanagement/README.md) -* [create_company](docs/sdks/companymanagement/README.md#create_company) - Create Sync for Commerce company +* [create_company](docs/sdks/companymanagement/README.md#create_company) - Create sync for commerce company * [create_connection](docs/sdks/companymanagement/README.md#create_connection) - Create connection * [list_companies](docs/sdks/companymanagement/README.md#list_companies) - List companies * [list_connections](docs/sdks/companymanagement/README.md#list_connections) - List data connections @@ -162,8 +163,8 @@ if res.accounting_create_account_response is not None: ### [configuration](docs/sdks/configuration/README.md) -* [get_configuration](docs/sdks/configuration/README.md#get_configuration) - Retrieve config preferences set for a company. -* [set_configuration](docs/sdks/configuration/README.md#set_configuration) - Create or update configuration. +* [get_configuration](docs/sdks/configuration/README.md#get_configuration) - Retrieve config preferences set for a company +* [set_configuration](docs/sdks/configuration/README.md#set_configuration) - Create or update configuration ### [connections](docs/sdks/connections/README.md) @@ -174,7 +175,7 @@ if res.accounting_create_account_response is not None: ### [integrations](docs/sdks/integrations/README.md) * [get_integration_branding](docs/sdks/integrations/README.md#get_integration_branding) - Get branding for an integration -* [list_integrations](docs/sdks/integrations/README.md#list_integrations) - List information on Codat's supported integrations +* [list_integrations](docs/sdks/integrations/README.md#list_integrations) - List integrations ### [push_data](docs/sdks/pushdata/README.md) @@ -197,10 +198,22 @@ if res.accounting_create_account_response is not None: ### [sync_flow_preferences](docs/sdks/syncflowpreferences/README.md) -* [get_config_text_sync_flow](docs/sdks/syncflowpreferences/README.md#get_config_text_sync_flow) - Retrieve preferences for text fields on Sync Flow +* [get_config_text_sync_flow](docs/sdks/syncflowpreferences/README.md#get_config_text_sync_flow) - Retrieve preferences for text fields on sync flow * [get_sync_flow_url](docs/sdks/syncflowpreferences/README.md#get_sync_flow_url) - Retrieve sync flow url * [get_visible_accounts](docs/sdks/syncflowpreferences/README.md#get_visible_accounts) - List visible accounts * [update_config_text_sync_flow](docs/sdks/syncflowpreferences/README.md#update_config_text_sync_flow) - Update preferences for text fields on sync flow -* [update_visible_accounts_sync_flow](docs/sdks/syncflowpreferences/README.md#update_visible_accounts_sync_flow) - Update the visible accounts on Sync Flow +* [update_visible_accounts_sync_flow](docs/sdks/syncflowpreferences/README.md#update_visible_accounts_sync_flow) - Update the visible accounts on sync flow + + + + + + + + + + + + ### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/RELEASES.md b/previous-versions/sync-for-commerce-version-1/RELEASES.md new file mode 100644 index 000000000..c787f099c --- /dev/null +++ b/previous-versions/sync-for-commerce-version-1/RELEASES.md @@ -0,0 +1,11 @@ + + +## 2023-10-17 14:13:25 +### Changes +Based on: +- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce-v1.yaml +- Speakeasy CLI 1.100.2 (2.159.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.2.0] previous-versions/sync-for-commerce-version-1 +### Releases +- [PyPI v0.2.0] https://pypi.org/project/codat-sync-for-commerce-version-1/0.2.0 - previous-versions/sync-for-commerce-version-1 \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/USAGE.md b/previous-versions/sync-for-commerce-version-1/USAGE.md index abb659f83..27344f8ce 100755 --- a/previous-versions/sync-for-commerce-version-1/USAGE.md +++ b/previous-versions/sync-for-commerce-version-1/USAGE.md @@ -14,39 +14,42 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.CreateAccountingAccountRequest( accounting_account=shared.AccountingAccount( - currency='USD', + currency='GBP', current_balance=Decimal('0'), description='Invoices the business has issued but has not yet collected payment on.', fully_qualified_category='Asset.Current', - fully_qualified_name='Fixed Asset', + fully_qualified_name='Cash On Hand', id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e', - is_bank_account=False, - metadata=shared.AccountingAccountMetadata( - is_deleted=False, - ), + metadata=shared.AccountingAccountMetadata(), modified_date='2022-10-23T00:00:00.000Z', name='Accounts Receivable', nominal_code='610', source_modified_date='2022-10-23T00:00:00.000Z', status=shared.AccountStatus.ACTIVE, + supplemental_data=shared.SupplementalData( + content={ + "Gasoline": { + "Wall": 'Oriental', + }, + }, + ), type=shared.AccountType.ASSET, valid_datatype_links=[ shared.AccountingAccountValidDataTypeLinks( links=[ - 'unde', + 'Intranet', ], - property='nulla', ), ], ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=544883, ) res = s.accounting_accounts.create_accounting_account(req) if res.accounting_create_account_response is not None: # handle response + pass ``` \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingaccountrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingaccountrequest.md index bcea37a44..f362c6486 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingaccountrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingaccountrequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `accounting_account` | [Optional[shared.AccountingAccount]](../../models/shared/accountingaccount.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingaccountresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingaccountresponse.md index 197ae8d2c..c88ba9f52 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingaccountresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingaccountresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `accounting_create_account_response` | [Optional[shared.AccountingCreateAccountResponse]](../../models/shared/accountingcreateaccountresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcreditnoterequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcreditnoterequest.md index 1a923aa8a..a061a10d2 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcreditnoterequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcreditnoterequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | `accounting_credit_note` | [Optional[shared.AccountingCreditNote]](../../models/shared/accountingcreditnote.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcreditnoteresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcreditnoteresponse.md index 987b8bc58..acfe495c9 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcreditnoteresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcreditnoteresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | `accounting_create_credit_note_response` | [Optional[shared.AccountingCreateCreditNoteResponse]](../../models/shared/accountingcreatecreditnoteresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcustomerrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcustomerrequest.md index 092b45be3..a3a4e9667 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcustomerrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcustomerrequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | `accounting_customer` | [Optional[shared.AccountingCustomer]](../../models/shared/accountingcustomer.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcustomerresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcustomerresponse.md index 27e27602c..c17100d89 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcustomerresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingcustomerresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `accounting_create_customer_response` | [Optional[shared.AccountingCreateCustomerResponse]](../../models/shared/accountingcreatecustomerresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingdirectincomerequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingdirectincomerequest.md index 1be1d22c6..ab872008f 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingdirectincomerequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingdirectincomerequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_direct_income` | [Optional[shared.AccountingDirectIncome]](../../models/shared/accountingdirectincome.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingdirectincomeresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingdirectincomeresponse.md index 082e1056d..9ac96d98f 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingdirectincomeresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingdirectincomeresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `accounting_create_direct_income_response` | [Optional[shared.AccountingCreateDirectIncomeResponse]](../../models/shared/accountingcreatedirectincomeresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountinginvoicerequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountinginvoicerequest.md index ae1346323..3e0e76887 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountinginvoicerequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountinginvoicerequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `accounting_invoice` | [Optional[shared.AccountingInvoice]](../../models/shared/accountinginvoice.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountinginvoiceresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountinginvoiceresponse.md index 7432d3012..b359d1f32 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountinginvoiceresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountinginvoiceresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `accounting_create_invoice_response` | [Optional[shared.AccountingCreateInvoiceResponse]](../../models/shared/accountingcreateinvoiceresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingjournalentryrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingjournalentryrequest.md index e38f4ff20..1e9085fdf 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingjournalentryrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingjournalentryrequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_journal_entry` | [Optional[shared.AccountingJournalEntry]](../../models/shared/accountingjournalentry.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingjournalentryresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingjournalentryresponse.md index 6a1288621..725462ff4 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingjournalentryresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingjournalentryresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `accounting_create_journal_entry_response` | [Optional[shared.AccountingCreateJournalEntryResponse]](../../models/shared/accountingcreatejournalentryresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingpaymentrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingpaymentrequest.md index 8832e9086..604e9f4be 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingpaymentrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingpaymentrequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `accounting_payment` | [Optional[shared.AccountingPayment]](../../models/shared/accountingpayment.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingpaymentresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingpaymentresponse.md index 782784306..d2d37a0fe 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingpaymentresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createaccountingpaymentresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `accounting_create_payment_response` | [Optional[shared.AccountingCreatePaymentResponse]](../../models/shared/accountingcreatepaymentresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createcompanyresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createcompanyresponse.md index 93be9bfbc..3f480892c 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createcompanyresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createcompanyresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createconnectionrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createconnectionrequest.md index c5aea4e2e..8eeeadf6f 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createconnectionrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createconnectionrequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | | `request_body` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createconnectionresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createconnectionresponse.md index 9b4b0a988..b9843aea9 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/createconnectionresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/createconnectionresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/deletecompanyrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/deletecompanyrequest.md index 268537e13..338ee40e5 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/deletecompanyrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/deletecompanyrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/deletecompanyresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/deletecompanyresponse.md index ee9fe7cd3..f3f21c2cb 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/deletecompanyresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/deletecompanyresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/deleteconnectionrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/deleteconnectionrequest.md index 2cab8bf4a..9650dc387 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/deleteconnectionrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/deleteconnectionrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/deleteconnectionresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/deleteconnectionresponse.md index 973be81b3..30889c508 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/deleteconnectionresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/deleteconnectionresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingaccountrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingaccountrequest.md index 85df1ba43..35c2fba87 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingaccountrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingaccountrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingaccountresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingaccountresponse.md index 775510461..21f40fd94 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingaccountresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingaccountresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_account` | [Optional[shared.AccountingAccount]](../../models/shared/accountingaccount.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingbankaccountrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingbankaccountrequest.md index 1c09df7ba..6cb306832 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingbankaccountrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingbankaccountrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingbankaccountresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingbankaccountresponse.md index 1590b2552..6f5df92ca 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingbankaccountresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingbankaccountresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `accounting_bank_account` | [Optional[shared.AccountingBankAccount]](../../models/shared/accountingbankaccount.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingcompanyinforequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingcompanyinforequest.md index cf5e5f0e9..4d62df7d2 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingcompanyinforequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingcompanyinforequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingcompanyinforesponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingcompanyinforesponse.md index 63868966e..590e00352 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingcompanyinforesponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getaccountingcompanyinforesponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `accounting_company_dataset` | [Optional[shared.AccountingCompanyDataset]](../../models/shared/accountingcompanydataset.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecompanyinforequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecompanyinforequest.md index cb8a50e45..c422f23dd 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecompanyinforequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecompanyinforequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecompanyinforesponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecompanyinforesponse.md index 17078ad27..2041e909b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecompanyinforesponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecompanyinforesponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_company_info` | [Optional[shared.CommerceCompanyInfo]](../../models/shared/commercecompanyinfo.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecustomerrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecustomerrequest.md index 7362c77cf..9fcdaf94b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecustomerrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecustomerrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `customer_id` | *str* | :heavy_check_mark: | Unique identifier for a customer. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecustomerresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecustomerresponse.md index 73f0c94c5..08c14c6e7 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecustomerresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercecustomerresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_customer` | [Optional[shared.CommerceCustomer]](../../models/shared/commercecustomer.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercelocationrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercelocationrequest.md index 1afc9673d..36d6bb5b3 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercelocationrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercelocationrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `location_id` | *str* | :heavy_check_mark: | Unique identifier for a location. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercelocationresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercelocationresponse.md index a6e102cf1..b798ae049 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercelocationresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercelocationresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_location` | [Optional[shared.CommerceLocation]](../../models/shared/commercelocation.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceorderrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceorderrequest.md index 918361a15..31ea882ff 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceorderrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceorderrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_id` | *str* | :heavy_check_mark: | Unique identifier for an order. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceorderresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceorderresponse.md index 0f678299e..48fdadff9 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceorderresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceorderresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_order` | [Optional[shared.CommerceOrder]](../../models/shared/commerceorder.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentmethodrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentmethodrequest.md index e9c247e6a..b8a9f58d2 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentmethodrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentmethodrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `payment_method_id` | *str* | :heavy_check_mark: | Unique identifier for a payment method. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentmethodresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentmethodresponse.md index 716bb74db..0917904b0 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentmethodresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentmethodresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `commerce_payment_method` | [Optional[shared.CommercePaymentMethod]](../../models/shared/commercepaymentmethod.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentrequest.md index b62069c23..4e0808209 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `payment_id` | *str* | :heavy_check_mark: | Unique identifier for a payment. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentresponse.md index db311f3f3..53e4f188b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercepaymentresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_payment` | [Optional[shared.CommercePayment]](../../models/shared/commercepayment.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceproductrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceproductrequest.md index d0d962234..8fdff797e 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceproductrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceproductrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `product_id` | *str* | :heavy_check_mark: | Unique identifier for a product. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceproductresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceproductresponse.md index 2fc0026b6..c45a8463b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceproductresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommerceproductresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_product` | [Optional[shared.CommerceProduct]](../../models/shared/commerceproduct.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercetransactionrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercetransactionrequest.md index 32bd837f0..77c693889 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercetransactionrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercetransactionrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `transaction_id` | *str* | :heavy_check_mark: | Unique identifier for a transaction. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercetransactionresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercetransactionresponse.md index 550fc854c..a9ac47847 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercetransactionresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcommercetransactionresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_transaction` | [Optional[shared.CommerceTransaction]](../../models/shared/commercetransaction.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanydatastatusrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanydatastatusrequest.md index e61fba1ae..5df9c3c5b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanydatastatusrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanydatastatusrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanydatastatusresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanydatastatusresponse.md index ea0eda1e3..c9f2917e7 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanydatastatusresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanydatastatusresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `data_status_response` | dict[str, [shared.DataStatus](../../models/shared/datastatus.md)] | :heavy_minus_sign: | OK | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `data_status_response` | Dict[str, [shared.DataStatus](../../models/shared/datastatus.md)] | :heavy_minus_sign: | OK | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanypushhistoryrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanypushhistoryrequest.md index ab7187109..46b30c39e 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanypushhistoryrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanypushhistoryrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanypushhistoryresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanypushhistoryresponse.md index 7ce47d63a..84e0d2562 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanypushhistoryresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanypushhistoryresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | | `push_operations` | [Optional[shared.PushOperations]](../../models/shared/pushoperations.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanyrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanyrequest.md index 4c9629ab6..240b811b6 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanyrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanyrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanyresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanyresponse.md index a0c0a41b1..2f82e6ca0 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanyresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getcompanyresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigtextsyncflowresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigtextsyncflowresponse.md index 189eebe58..e3f563883 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigtextsyncflowresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigtextsyncflowresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `localization_info` | dict[str, [shared.Localization](../../models/shared/localization.md)] | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `localization_info` | Dict[str, [shared.Localization](../../models/shared/localization.md)] | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigurationrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigurationrequest.md index b047fed66..04c0fd3b2 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigurationrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigurationrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigurationresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigurationresponse.md index 0d073341f..6f1cabe85 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigurationresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconfigurationresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `configuration` | [Optional[shared.Configuration]](../../models/shared/configuration.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconnectionrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconnectionrequest.md index d9d6f6c13..6e9f3d18b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconnectionrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconnectionrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconnectionresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconnectionresponse.md index 32fb66433..c308aece1 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconnectionresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getconnectionresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getintegrationbrandingrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getintegrationbrandingrequest.md index d652e2d96..5abf8823d 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getintegrationbrandingrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getintegrationbrandingrequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `platform_key` | *str* | :heavy_check_mark: | PlatformKey | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `platform_key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getintegrationbrandingresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getintegrationbrandingresponse.md index 58fc20583..193c58136 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getintegrationbrandingresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getintegrationbrandingresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `branding` | [Optional[shared.Branding]](../../models/shared/branding.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpulloperationrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpulloperationrequest.md index a965477f9..d2382bd6c 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpulloperationrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpulloperationrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `dataset_id` | *str* | :heavy_check_mark: | Unique ID of a dataset or pull operation. | eaed9f0f-e77b-4bc9-a58f-ab8b4b99ab18 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `dataset_id` | *str* | :heavy_check_mark: | Unique identifier for the dataset that completed its sync. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpulloperationresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpulloperationresponse.md index 1527d9f32..41674afa9 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpulloperationresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpulloperationresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpushoperationrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpushoperationrequest.md index 8a7e2f877..d667790b5 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpushoperationrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpushoperationrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `push_operation_key` | *str* | :heavy_check_mark: | Push operation key. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpushoperationresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpushoperationresponse.md index 0477eb0ec..7dd02aeed 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpushoperationresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getpushoperationresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `push_operation` | [Optional[shared.PushOperation]](../../models/shared/pushoperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncflowurlresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncflowurlresponse.md index dbd46259a..8c1c3d861 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncflowurlresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncflowurlresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `sync_flow_url` | [Optional[shared.SyncFlowURL]](../../models/shared/syncflowurl.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncstatusrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncstatusrequest.md index 3ab6117f8..59d18bd12 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncstatusrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncstatusrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncstatusresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncstatusresponse.md index 0c96de63b..869151d89 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncstatusresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getsyncstatusresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getvisibleaccountsrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getvisibleaccountsrequest.md index 931218cfd..356b8d1c2 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getvisibleaccountsrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getvisibleaccountsrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `client_id` | *str* | :heavy_check_mark: | N/A | -| `platform_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `client_id` | *str* | :heavy_check_mark: | Unique identifier for your client in Codat. | | +| `platform_key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getvisibleaccountsresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getvisibleaccountsresponse.md index 788ea5595..b7201e748 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/getvisibleaccountsresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/getvisibleaccountsresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `visible_accounts` | [Optional[shared.VisibleAccounts]](../../models/shared/visibleaccounts.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingaccountsrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingaccountsrequest.md index beaeb974d..cf0856de4 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingaccountsrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingaccountsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingaccountsresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingaccountsresponse.md index 31cc04db9..191e47635 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingaccountsresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingaccountsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_accounts` | [Optional[shared.AccountingAccounts]](../../models/shared/accountingaccounts.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingbankaccountsrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingbankaccountsrequest.md index 58ea43fed..06b0c52bd 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingbankaccountsrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingbankaccountsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingbankaccountsresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingbankaccountsresponse.md index e92df5c5a..d895a812f 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingbankaccountsresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listaccountingbankaccountsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_bank_accounts` | [Optional[shared.AccountingBankAccounts]](../../models/shared/accountingbankaccounts.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercecustomersrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercecustomersrequest.md index 8e8182130..a8dc553f9 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercecustomersrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercecustomersrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercecustomersresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercecustomersresponse.md index 6e1960e2b..8b8a57ef6 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercecustomersresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercecustomersresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_customers` | [Optional[shared.CommerceCustomers]](../../models/shared/commercecustomers.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercelocationsrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercelocationsrequest.md index 210e397bc..8f84b7fe8 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercelocationsrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercelocationsrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercelocationsresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercelocationsresponse.md index 2826e01d7..c56356007 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercelocationsresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercelocationsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_locations` | [Optional[shared.CommerceLocations]](../../models/shared/commercelocations.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceordersrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceordersrequest.md index c2277180f..8a41c33c2 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceordersrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceordersrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceordersresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceordersresponse.md index a8dfb6e27..de4b9eccb 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceordersresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceordersresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_orders` | [Optional[shared.CommerceOrders]](../../models/shared/commerceorders.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentmethodsrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentmethodsrequest.md index b092aca91..75202a1d7 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentmethodsrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentmethodsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentmethodsresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentmethodsresponse.md index 0e7218d16..1dfcf08cb 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentmethodsresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentmethodsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `commerce_payment_methods` | [Optional[shared.CommercePaymentMethods]](../../models/shared/commercepaymentmethods.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentsrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentsrequest.md index 94c52bbcc..cf019922d 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentsrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentsresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentsresponse.md index 03d62908f..6534b615e 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentsresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercepaymentsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_payments` | [Optional[shared.CommercePayments]](../../models/shared/commercepayments.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceproductsrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceproductsrequest.md index 7732ebee7..9d8dbae8e 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceproductsrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceproductsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceproductsresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceproductsresponse.md index d6b25fb86..c8b2b1c0d 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceproductsresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommerceproductsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_products` | [Optional[shared.CommerceProducts]](../../models/shared/commerceproducts.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercetransactionsrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercetransactionsrequest.md index 32b12a7f2..2ad4e2072 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercetransactionsrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercetransactionsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercetransactionsresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercetransactionsresponse.md index ea3f9f9f4..b5f60c346 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercetransactionsresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcommercetransactionsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_transactions` | [Optional[shared.CommerceTransactions]](../../models/shared/commercetransactions.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcompaniesresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcompaniesresponse.md index bc2775ec5..e28be1e0f 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcompaniesresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listcompaniesresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `companies` | [Optional[shared.Companies]](../../models/shared/companies.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listconnectionsrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listconnectionsrequest.md index 1cdcf0879..e13ad736b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listconnectionsrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listconnectionsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listconnectionsresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listconnectionsresponse.md index 1398de519..5ab40a593 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listconnectionsresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listconnectionsresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connections` | [Optional[shared.Connections]](../../models/shared/connections.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listintegrationsresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listintegrationsresponse.md index d5be54169..ef0691959 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listintegrationsresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listintegrationsresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `integrations` | [Optional[shared.Integrations]](../../models/shared/integrations.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listpulloperationsrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listpulloperationsrequest.md index d5a4b553d..bdf3bef92 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listpulloperationsrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listpulloperationsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listpulloperationsresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listpulloperationsresponse.md index 23240bd20..feff59654 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/listpulloperationsresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/listpulloperationsresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | | `pull_operations` | [Optional[shared.PullOperations]](../../models/shared/pulloperations.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanydatarequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanydatarequest.md index 5a91007e2..73f8e3d12 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanydatarequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanydatarequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanydataresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanydataresponse.md index 916129295..79e971619 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanydataresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanydataresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanyinforequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanyinforequest.md index 7b7ec6497..c41564639 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanyinforequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanyinforequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanyinforesponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanyinforesponse.md index dce350b9c..482c2d008 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanyinforesponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshcompanyinforesponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `dataset` | [Optional[shared.Dataset]](../../models/shared/dataset.md) | :heavy_minus_sign: | Success | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshdatatyperequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshdatatyperequest.md index cbefc996f..257381833 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshdatatyperequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshdatatyperequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `connection_id` | *Optional[str]* | :heavy_minus_sign: | Optionally, provide a data connection id to only queue pull operations on that connection. | | | `data_type` | [shared.DataType](../../models/shared/datatype.md) | :heavy_check_mark: | The key of a Codat data type | invoices | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshdatatyperesponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshdatatyperesponse.md index 73215c3bd..5a4e614bb 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshdatatyperesponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/refreshdatatyperesponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncfordaterangerequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncfordaterangerequest.md index bb540a43b..337fd509b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncfordaterangerequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncfordaterangerequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | | `sync_range` | [Optional[shared.SyncRange]](../../models/shared/syncrange.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncfordaterangeresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncfordaterangeresponse.md index 92b2a8909..9a6d8dd12 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncfordaterangeresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncfordaterangeresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `sync_summary` | [Optional[shared.SyncSummary]](../../models/shared/syncsummary.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncrequest.md index 89f3e6091..61b6ab0c0 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncrequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | `sync_to_latest_args` | [Optional[shared.SyncToLatestArgs]](../../models/shared/synctolatestargs.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncresponse.md index 4ff2e8e6a..351b5643a 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/requestsyncresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `sync_summary` | [Optional[shared.SyncSummary]](../../models/shared/syncsummary.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/setconfigurationrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/setconfigurationrequest.md index 5653e277f..08b95ad02 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/setconfigurationrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/setconfigurationrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/setconfigurationresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/setconfigurationresponse.md index c18f3ccc1..38ca2c629 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/setconfigurationresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/setconfigurationresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `configuration` | [Optional[shared.Configuration]](../../models/shared/configuration.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/unlinkconnectionrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/unlinkconnectionrequest.md index c6a89d01d..2c5b7147c 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/unlinkconnectionrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/unlinkconnectionrequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | `update_connection` | [Optional[shared.UpdateConnection]](../../models/shared/updateconnection.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/unlinkconnectionresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/unlinkconnectionresponse.md index ced538908..642e8e815 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/unlinkconnectionresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/unlinkconnectionresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatecompanyrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatecompanyrequest.md index 0481d404d..bd69590c7 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatecompanyrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatecompanyrequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | | `create_company` | [Optional[shared.CreateCompany]](../../models/shared/createcompany.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatecompanyresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatecompanyresponse.md index 9b9c51eef..b60ed7a56 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatecompanyresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatecompanyresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconfigtextsyncflowresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconfigtextsyncflowresponse.md index 0834865e6..7459413c1 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconfigtextsyncflowresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconfigtextsyncflowresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `localization_info` | dict[str, [shared.Localization](../../models/shared/localization.md)] | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `localization_info` | Dict[str, [shared.Localization](../../models/shared/localization.md)] | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconnectionrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconnectionrequest.md index 9afc16fac..8fe98610b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconnectionrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconnectionrequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | `update_connection` | [Optional[shared.UpdateConnection]](../../models/shared/updateconnection.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconnectionresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconnectionresponse.md index 5f99ed17e..2357b641b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconnectionresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updateconnectionresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatevisibleaccountssyncflowrequest.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatevisibleaccountssyncflowrequest.md index 53ba28daa..717387468 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatevisibleaccountssyncflowrequest.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatevisibleaccountssyncflowrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `visible_accounts` | [Optional[shared.VisibleAccounts]](../../models/shared/visibleaccounts.md) | :heavy_minus_sign: | N/A | -| `platform_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `visible_accounts` | [Optional[shared.VisibleAccounts]](../../models/shared/visibleaccounts.md) | :heavy_minus_sign: | N/A | | +| `platform_key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatevisibleaccountssyncflowresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatevisibleaccountssyncflowresponse.md index e0e563ba4..743f98980 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatevisibleaccountssyncflowresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/operations/updatevisibleaccountssyncflowresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `visible_accounts` | [Optional[shared.VisibleAccounts]](../../models/shared/visibleaccounts.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccount.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccount.md index 001c16be9..0282fafe2 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccount.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccount.md @@ -47,5 +47,6 @@ To determine the list of allowed categories for a specific integration, you can: | `nominal_code` | *Optional[str]* | :heavy_minus_sign: | Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system. | 610 | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `status` | [Optional[AccountStatus]](../../models/shared/accountstatus.md) | :heavy_minus_sign: | Status of the account | Active | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | | `type` | [Optional[AccountType]](../../models/shared/accounttype.md) | :heavy_minus_sign: | Type of account | Asset | -| `valid_datatype_links` | list[[AccountingAccountValidDataTypeLinks](../../models/shared/accountingaccountvaliddatatypelinks.md)] | :heavy_minus_sign: | The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/accounting-api#/schemas/ValidDataTypeLinks). | | \ No newline at end of file +| `valid_datatype_links` | List[[AccountingAccountValidDataTypeLinks](../../models/shared/accountingaccountvaliddatatypelinks.md)] | :heavy_minus_sign: | The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/accounting-api#/schemas/ValidDataTypeLinks). | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccounts.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccounts.md index 21007a9e8..e47ee4ee7 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccounts.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccounts.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingAccount](../../models/shared/accountingaccount.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingAccount](../../models/shared/accountingaccount.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccountvaliddatatypelinks.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccountvaliddatatypelinks.md index b5f41a9e1..fd889b8c6 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccountvaliddatatypelinks.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingaccountvaliddatatypelinks.md @@ -46,5 +46,5 @@ If you'd like us to extend support to more data types or integrations, suggest o | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `links` | list[*str*] | :heavy_minus_sign: | Supported `dataTypes` that the record can be linked to. | +| `links` | List[*str*] | :heavy_minus_sign: | Supported `dataTypes` that the record can be linked to. | | `property` | *Optional[str]* | :heavy_minus_sign: | The property from the account that can be linked. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingbankaccount.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingbankaccount.md index e388d8ed0..48b1385dc 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingbankaccount.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingbankaccount.md @@ -36,4 +36,5 @@ Bank accounts data includes: | `nominal_code` | *Optional[str]* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | | `overdraft_limit` | *Optional[Decimal]* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | | `sort_code` | *Optional[str]* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | -| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | \ No newline at end of file +| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingbankaccounts.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingbankaccounts.md index 7eb246961..20e31a072 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingbankaccounts.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingbankaccounts.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingBankAccount](../../models/shared/accountingbankaccount.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingBankAccount](../../models/shared/accountingbankaccount.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcompanydataset.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcompanydataset.md index 134c8ffce..f0e01695d 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcompanydataset.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcompanydataset.md @@ -14,15 +14,16 @@ Company info provides standard details about a linked company such as their addr | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accounting_platform_ref` | *Optional[str]* | :heavy_minus_sign: | Identifier or reference for the company in the accounting platform. | | -| `addresses` | list[[AccountingCompanyDatasetAccountingAddress](../../models/shared/accountingcompanydatasetaccountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | +| `addresses` | List[[AccountingCompanyDatasetAccountingAddress](../../models/shared/accountingcompanydatasetaccountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | | `base_currency` | *Optional[str]* | :heavy_minus_sign: | Currency set in the accounting platform of the linked company. Used by the currency rate. | | | `company_legal_name` | *Optional[str]* | :heavy_minus_sign: | Registered legal name of the linked company. | | | `company_name` | *Optional[str]* | :heavy_minus_sign: | Name of the linked company. | | | `created_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `financial_year_start_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `ledger_lock_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `phone_numbers` | list[[AccountingCompanyDatasetPhone](../../models/shared/accountingcompanydatasetphone.md)] | :heavy_minus_sign: | An array of phone numbers. | | +| `phone_numbers` | List[[AccountingCompanyDatasetPhone](../../models/shared/accountingcompanydatasetphone.md)] | :heavy_minus_sign: | An array of phone numbers. | | | `registration_number` | *Optional[str]* | :heavy_minus_sign: | Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. | | -| `source_urls` | dict[str, *str*] | :heavy_minus_sign: | URL addresses for the accounting source.

For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). | | +| `source_urls` | Dict[str, *str*] | :heavy_minus_sign: | URL addresses for the accounting source.

For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). | | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | | `tax_number` | *Optional[str]* | :heavy_minus_sign: | Company tax number. | | -| `web_links` | list[[AccountingCompanyDatasetWeblink](../../models/shared/accountingcompanydatasetweblink.md)] | :heavy_minus_sign: | An array of weblinks. | | \ No newline at end of file +| `web_links` | List[[AccountingCompanyDatasetWeblink](../../models/shared/accountingcompanydatasetweblink.md)] | :heavy_minus_sign: | An array of weblinks. | [object Object] | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcompanydatasetphone.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcompanydatasetphone.md index dda661d40..e8a2bc4d9 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcompanydatasetphone.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcompanydatasetphone.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `number` | *str* | :heavy_check_mark: | A phone number. | +44 25691 154789 | +| `number` | *Optional[str]* | :heavy_check_mark: | A phone number. | +44 25691 154789 | | `type` | [PhoneNumberType](../../models/shared/phonenumbertype.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreateaccountresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreateaccountresponse.md index f986f328c..df03c27e7 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreateaccountresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreateaccountresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `data` | [Optional[AccountingAccount]](../../models/shared/accountingaccount.md) | :heavy_minus_sign: | > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.

View the coverage for accounts in the Data coverage explorer.

## Overview

Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.

The categories for an account include:
* Asset
* Expense
* Income
* Liability
* Equity.

The same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.

At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.

To determine the list of allowed categories for a specific integration, you can:
- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model).
- Refer to the integration's own documentation.

> **Accounts with no category**
>
> If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.
>
> This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports. | | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatecreditnoteresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatecreditnoteresponse.md index f19b15398..e7e76a864 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatecreditnoteresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatecreditnoteresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `data` | [Optional[AccountingCreditNote]](../../models/shared/accountingcreditnote.md) | :heavy_minus_sign: | > View the coverage for credit notes in the Data coverage explorer.

## Overview

Think of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely.

In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/accounting-api#/schemas/Customer) accounts receivable.

It contains details of:
* The amount of credit remaining and its status.
* Payment allocations against the payments type, in this case an invoice.
* Which customers the credit notes have been issued to. | | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatecustomerresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatecustomerresponse.md index cd7cac8a5..f83c6b692 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatecustomerresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatecustomerresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `data` | [Optional[AccountingCustomer]](../../models/shared/accountingcustomer.md) | :heavy_minus_sign: | > View the coverage for customers in the Data coverage explorer.

## Overview

A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers).

Customers' data links to accounts receivable [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice).
| | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatedirectincomeresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatedirectincomeresponse.md index 8c5a47ad0..80e752bc0 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatedirectincomeresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatedirectincomeresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `data` | [Optional[AccountingDirectIncome]](../../models/shared/accountingdirectincome.md) | :heavy_minus_sign: | > **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting platforms.

> View the coverage for direct incomes in the Data coverage explorer.

## Overview

Direct incomes are incomes received directly from the business' operations. For example, cash sales of items to a customer, referral commissions, and service fee refunds are considered direct incomes.

Direct incomes include:

- Selling an item directly to a contact, and receiving payment at the point of the sale.
- Refunding an item in cash to a contact.
- Depositing money into a bank account.

Direct incomes is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
| | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreateinvoiceresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreateinvoiceresponse.md index 07371841d..f26d6f116 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreateinvoiceresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreateinvoiceresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `data` | [Optional[AccountingInvoice]](../../models/shared/accountinginvoice.md) | :heavy_minus_sign: | > **Invoices or bills?**
>
> We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice.
>
> See [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) for the accounts payable equivalent of bills.

View the coverage for invoices in the Data coverage explorer.

## Overview

An invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/accounting-api#/schemas/Customer).

In Codat, an invoice contains details of:

- The timeline of the invoice—when it was raised, marked as paid, last edited, and so on.
- How much the invoice is for, what portion of the invoice is tax or discounts, and what currency the amounts are represented in.
- Who the invoice has been raised to; the _customer_.
- The breakdown of what the invoice is for; the _line items_.
- Any [payments](https://docs.codat.io/accounting-api#/schemas/Payment) assigned to the invoice; the _payment allocations_.

> **Invoice PDF downloads**
>
> You can download a PDF version of an invoice for supported integrations.
>
> The filename will be invoice-{number}.pdf.

> **Referencing an invoice in Sage 50 and ClearBooks**
>
> In Sage 50 and ClearBooks, you may prefer to use the **invoiceNumber** to identify an invoice rather than the invoice **id**. Each time a draft invoice is submitted or printed, the draft **id** becomes void and a submitted invoice with a new **id** exists in its place. In both platforms, the **invoiceNumber** should remain the same. | | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatejournalentryresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatejournalentryresponse.md index 7c756a0bc..451cfc757 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatejournalentryresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatejournalentryresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `data` | [Optional[AccountingJournalEntry]](../../models/shared/accountingjournalentry.md) | :heavy_minus_sign: | > **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type

> View the coverage for journal entries in the Data coverage explorer.

## Overview

A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/accounting-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance.

A journal entry line item is a single transaction line on the journal entry. For example:

- When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items.
- When a company needs to recognise revenue from an annual contract on a monthly basis, on receipt of cash for month one, they make a debit to deferred income and a credit to revenue.

In Codat a journal entry contains details of:

- The date on which the entry was created and posted.
- Itemised lines, including amounts and currency.
- A reference to the associated accounts.
- A reference to the underlying record. For example, the invoice, bill, or other data type that triggered the posting of the journal entry to the general ledger.

> **Pushing journal entries**
> Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency. | | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatepaymentresponse.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatepaymentresponse.md index 2b4597c12..de0dc0f38 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatepaymentresponse.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreatepaymentresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `data` | [Optional[AccountingPayment]](../../models/shared/accountingpayment.md) | :heavy_minus_sign: | > **Payments or bill payments?**
>
> In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/accounting-api#/schemas/Bill) and credit notes against bills.

> View the coverage for payments in the Data coverage explorer.

## Overview

Payments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote).

A payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to:

- A payment made against an invoice, like a credit card, cheque, or cash payment.
- An allocation of a customer's credit note, either to an invoice or maybe a refund.
- A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account.

Depending on the payments allowed by the underlying accounting package, some payment types may be combined. Please see the example for more details.

In Codat, a payment contains details of:

- When the payment was recorded in the accounting system.
- How much it is for and in what currency that amount is in.
- Who the payment was _paid by_ – the _customer_.
- The payment method used.
- The breakdown of the types of payments – the _line items_.

Payments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).

## Payment types

## Payment of an invoice

A payment paying a single invoice has one entry in its `lines` array. This **line** has the following properties:

- An _amount_ that indicates the amount of the invoice that was paid. This is always positive.
- A **links** array containing one element with the following properties:
- A **type** that indicates the type of **link**, in this case an `Invoice`.
- An **id** that contains the ID of the invoice that was paid.
- An **amount** for the link. The sum of the **line.amount** and the **links.amount** must equal `0`.

The **amount** field on the **line** equals the **totalAmount** on the payment.

## Payment of multiple invoices

A single payment can pay multiple invoices. This can be represented in one of two formats depending on how the customer keeps their books:

- The payment has multiple entries in its **lines** array, one for each invoice that is paid. Each line follows the example and rules described in [Payment of an invoice](#payment-of-an-invoice).
- The payment has a line with multiple links to each invoice. This occurs when the proportion of the original payment allocated to each invoice is not available.

Each **line** has the same properties as those described in [Payment of an invoice](#payment-of-an-invoice), with the **amount** indicating how much of the payment was allocated to the invoice. The sum of line amounts equals the **totalAmount** on the payment.

## Payments and refunds on account

A payment on account, that is a payment that doesn’t pay a specific invoice, has one entry in its lines array. The **line** has the following properties:

- A **totalAmount** that indicates the amount paid by a customer or refunded to them by a company. A payment to the customer is always negative. A refund is always positive.
- A **links** array containing one element with the following properties:
- A **type** that indicates the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`.
- The **id** containing the ID of the customer.
- The **amount** for the link is `0` – the **totalAmount** _or_ the amount of the payment or refund.

It is possible to have a payment that is part _on account_ and part _allocated_ to an invoice. Each line should follow the examples above.

## Using a credit note to pay an invoice

The payment of an invoice using a credit note has one entry in its **lines** array. This **line** has the following properties:

- An **amount** that indicates the amount of money moved, which in this case is `0`, as the credit note and invoice allocation must balance each other.
- A **links** array containing two elements:
- The first **link** has:
- A **type** that indicates the type of **link**, in this case an `Invoice`.
- An **id** that contains the ID of the invoice that was paid.
- The second **link** has:
- A **type** that indicates the type of **link**, in this case a `CreditNote`.
- An **id** that contains the ID of the credit note used by this payment.

The **amount** field on the **line** equals the **totalAmount** on the payment.

## Refunding a credit note

A payment refunding a credit note has one entry in its **lines** array. This **line** has the following properties:

- An **amount** that indicates the amount of the credit note that was refunded. This is always negative for a refund.
- A **links** array that contains one element with the following properties:
- A **type** that indicates the type of **link**, in this case a `CreditNote`.
- An **id** that contains the ID of the credit note that was refunded.

The **totalAmount** field on the payment equals the **amount** field of the **line**. These are both negative, as this is money leaving accounts receivable.

## Refunding a payment

If a payment is refunded, for example, if a customer overpaid an invoice and the overpayment is returned to the customer, there are two payment records:

- One for the incoming over payment.
- Another for the outgoing refund.

The payment issuing the refund has a negative **totalAmount**. This payment also has one entry in its lines array with the following properties:

- An **amount** that indicates the amount that was refunded. This is always negative.
- A **links** array that contains one element with the following properties:
- A **type** that indicates the type of **link**, in this case a `Payment`.
- An **id** that contains the ID of the payment that was refunded.

The **amount** field on the **line** equals the **totalAmount** on the payment and is negative, as this is money leaving accounts receivable.

The payment that was refunded has a line where the **amount** is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was used to partly pay an invoice.

For example: A £1,050 payment on a £1,000 invoice with a refund of £50 has two lines:

- One for £1,000 linked to the invoice that was paid.
- Another for £50 linked to the payment that refunded the overpayment with a** type** of `Refund` and an ID that corresponds to the payment.

The **line** linked to the payment has the following properties:

- An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.
- A **links** array containing one element with the following properties:
- A **type** that indicates the type of **link**, in this case a `Refund`.
- An **id** that contains the ID of the payment that refunded this line.

> **Support for linked payments**
>
> Not all accounting packages support linking payments in this way. In some platforms, you may see a payment on account and a refund on account.

## Foreign currencies

There are two types of currency rate that are included in the payments data type:

Payment currency rate:

- Base currency of the accounts receivable account.
- Foreign currency of the payment.

Payment line link currency rate:

- Base currency of the item the link represents.
- Foreign currency of the payment.

These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:

- The base currency for the accounts receivable account.
- The currency of the item.

```json title="Currency rate example"
{
"id": "123",
"note": ""
"totalAmount": 99.99,
"currency": "GBP",
"lines": [
{
"amount": 99.99,
"links": [
{
"type": "Invoice",
"id": "178",
"amount": -50,
"currencyRate": 1.9998,
}
]
}
]
}
```



## Example data

> **Object properties**
>
> For the sake of brevity, the examples here may omit properties from objects. For the full object definition, see [Payments](https://api.codat.io/swagger/index.html#/Payments).

## Simple examples

```json title="Payment for invoice"
{
"totalAmount": 1000,
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
}
]
}
]
}
```



```json title="Allocation of credit note"
{
"totalAmount": 0,
"lines": [
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
}
]
}
]
}
```



```json title="Payment of invoice and payment on account"
{
"totalAmount": 2000,
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "PaymentOnAccount",
"id" : "y",
"amount" : -1000
}
]
}
]
}
```



```json title="Refund of credit note"
{
"totalAmount": -1000,
"lines": [
{
"amount" : -1000,
"links" : [
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
}
]
}
]
}
```



```json title="Refund on accounts receivable account"
{
"totalAmount": -1000,
"lines": [
{
"amount" : -1000,
"links" : [
{
"type" : "PaymentOnAccount",
"id" : "y",
"amount" : 1000
}
]
}
]
}
```



```json title="Linked refund on accounts receivable account"
{
"id" : "payment-001",
"totalAmount": 1000,
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Refund",
"id" : "refund-001",
"amount" : -1000
}
]
}
]
}
{
"id" : "refund-001",
"totalAmount": -1000,
"lines": [
{
"amount" : -1000,
"links" : [
{
"type" : "Payment",
"id" : "payment-001",
"amount" : 1000
}
]
}
]
}
```



```json title="Using a credit note and cash to pay an invoice"
{
"totalAmount": 250,
"lines": [
{
"amount": 0,
"links": [
{
"type": "Invoice",
"id": "x",
"amount": -750
},
{
"type": "CreditNote",
"id": "y",
"amount": 750
}
]
},
{
"amount": 250,
"links": [
{
"type": "Invoice",
"id": "x",
"amount": -250
}
]
}
]
}
```



## Complex examples

```json title="Use two credit notes and 1000 in to "bank" (cash, cheque etc.) to pay invoice"
{
"totalAmount": 1000,
"lines": [
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
}
]
},
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "z",
"amount" : 1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
}
]
}
]
}
```



```json title="Pay an invoice with two credit notes and cash, with 1000 left 'on account'"
{
"totalAmount": 2000,
"lines": [
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
}
]
},
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "z",
"amount" : 1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "PaymentOnAccount",
"id" : "customer-001",
"amount" : -1000
}
]
}
]
}
```



```json title="Two credit notes pay two invoices with no allocation amount specified"
{
"totalAmount": 0,
"lines": [
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "w",
"amount" : -1000
},
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
},
{
"type" : "CreditNote",
"id" : "z",
"amount" : 1000
}
]
}
]
}
```



```json title="Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash"
{
"totalAmount": 2000,
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "w",
"amount" : -1000
},
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "Invoice",
"id" : "u",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
},
{
"type" : "CreditNote",
"id" : "z",
"amount" : 1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "Refund",
"id" : "refund-001",
"amount" : -1000
}
]
}
]
}
{
"id" : "refund-001",
"totalAmount": -1000,
"lines": [
{
"amount" : -1000,
"links" : [
{
"type" : "Payment",
"id" : "payment-001",
"amount" : 1000
}
]
}
]
}
```



In this example, a payment on account is used to pay the same invoice in January and again in February.

```json title="January"
{
"id": "001",
"totalAmount": 5000,
"date" : "1901-01-01",
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "Invoice-x",
"amount" : -1000
}
]
},
{
"amount" : 4000,
"links" : [
{
"type" : "PaymentOnAccount",
"id" : "PaymentOnAccount-y",
"amount" : -4000
}
]
}
]
}
```



```json title="February"
{
"id": "001",
"totalAmount": 5000,
"date" : "1901-02-01",
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "Invoice-x",
"amount" : -1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "Invoice-y",
"amount" : -1000
}
]
},
{
"amount" : 3000,
"links" : [
{
"type" : "PaymentOnAccount",
"id" : "PaymentOnAccount-y",
"amount" : -3000
}
]
}
]
}
```



```json title="Two credit notes and some cash pay two invoices with no allocations specified"
{
"totalAmount": 500,
"lines": [
{
"amount": 500,
"links": [{
"type": "Invoice",
"id": "a",
"amount": -1000
}, {
"type": "Invoice",
"id": "b",
"amount": -1000
}, {
"type": "CreditNote",
"id": "y",
"amount": 750
},{
"type": "CreditNote",
"id": "z",
"amount": 750
}
]
}
]
}
``` | | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreditnote.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreditnote.md index 98ee6af76..029963342 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreditnote.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcreditnote.md @@ -18,8 +18,8 @@ It contains details of: | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | -| `additional_tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | +| `additional_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Additional tax amount applied to credit note. | | +| `additional_tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate of any additional tax applied to the credit note. | | | `allocated_on_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `credit_note_number` | *Optional[str]* | :heavy_minus_sign: | Friendly reference for the credit note. | | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | @@ -28,17 +28,17 @@ It contains details of: | `discount_percentage` | *Decimal* | :heavy_check_mark: | Percentage rate (from 0 to 100) of discounts applied to the credit note. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the credit note, unique to the company in the accounting platform. | | | `issue_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `line_items` | list[[CreditNoteLineItem](../../models/shared/creditnotelineitem.md)] | :heavy_minus_sign: | N/A | | +| `line_items` | List[[CreditNoteLineItem](../../models/shared/creditnotelineitem.md)] | :heavy_minus_sign: | N/A | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `note` | *Optional[str]* | :heavy_minus_sign: | Any additional information about the credit note. Where possible, Codat links to a data field in the accounting platform that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting platform to the customer. | | -| `payment_allocations` | list[[PaymentAllocationsitems](../../models/shared/paymentallocationsitems.md)] | :heavy_minus_sign: | An array of payment allocations. | | +| `payment_allocations` | List[[PaymentAllocationsitems](../../models/shared/paymentallocationsitems.md)] | :heavy_minus_sign: | An array of payment allocations. | | | `remaining_credit` | *Decimal* | :heavy_check_mark: | Unused balance of totalAmount originally raised. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [CreditNoteStatus](../../models/shared/creditnotestatus.md) | :heavy_check_mark: | N/A | | +| `status` | [CreditNoteStatus](../../models/shared/creditnotestatus.md) | :heavy_check_mark: | Current state of the credit note. | | | `sub_total` | *Decimal* | :heavy_check_mark: | Value of the credit note, including discounts and excluding tax. | | | `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | | `total_amount` | *Decimal* | :heavy_check_mark: | Total amount of credit that has been applied to the customer's accounts receivable | | | `total_discount` | *Decimal* | :heavy_check_mark: | Any discounts applied to the credit note amount. | | | `total_tax_amount` | *Decimal* | :heavy_check_mark: | Any tax applied to the credit note amount. | | -| `withholding_tax` | list[[WithholdingTaxitems](../../models/shared/withholdingtaxitems.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `withholding_tax` | List[[WithholdingTaxitems](../../models/shared/withholdingtaxitems.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcustomer.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcustomer.md index e8dbf81a6..23f7b525a 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcustomer.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingcustomer.md @@ -14,9 +14,9 @@ Customers' data links to accounts receivable [invoices](https://docs.codat.io/ac | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | list[[Items1](../../models/shared/items1.md)] | :heavy_minus_sign: | An array of Addresses. | | +| `addresses` | List[[Items1](../../models/shared/items1.md)] | :heavy_minus_sign: | An array of Addresses. | | | `contact_name` | *Optional[str]* | :heavy_minus_sign: | Name of the main contact for the identified customer. | | -| `contacts` | list[[Contact](../../models/shared/contact.md)] | :heavy_minus_sign: | An array of Contacts. | | +| `contacts` | List[[Contact](../../models/shared/contact.md)] | :heavy_minus_sign: | An array of Contacts. | | | `customer_name` | *Optional[str]* | :heavy_minus_sign: | Name of the customer as recorded in the accounting system, typically the company name. | | | `default_currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | | `email_address` | *Optional[str]* | :heavy_minus_sign: | Email address the customer can be contacted by. | | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingdirectincome.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingdirectincome.md index 467183561..52bde9c58 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingdirectincome.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingdirectincome.md @@ -27,11 +27,11 @@ Direct incomes is a child data type of [account transactions](https://docs.codat | `currency_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \| | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier of the direct income, unique for the company. | | | `issue_date` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `line_items` | list[[DirectIncomeLineItem](../../models/shared/directincomelineitem.md)] | :heavy_check_mark: | An array of line items. | | +| `line_items` | List[[DirectIncomeLineItem](../../models/shared/directincomelineitem.md)] | :heavy_check_mark: | An array of line items. | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `note` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `payment_allocations` | list[[PaymentAllocationsitems](../../models/shared/paymentallocationsitems.md)] | :heavy_check_mark: | N/A | | +| `note` | *Optional[str]* | :heavy_minus_sign: | An optional note on the direct income that can be used to assign the direct income with a reference ID in your application. | | +| `payment_allocations` | List[[PaymentAllocationsitems](../../models/shared/paymentallocationsitems.md)] | :heavy_check_mark: | N/A | | | `reference` | *Optional[str]* | :heavy_minus_sign: | User-friendly reference for the direct income. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `sub_total` | *Decimal* | :heavy_check_mark: | The total amount of the direct incomes, excluding any taxes. | | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingdirectincomecontactref.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingdirectincomecontactref.md index 7bb20703f..e229bfc3c 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingdirectincomecontactref.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingdirectincomecontactref.md @@ -5,7 +5,7 @@ A customer or supplier associated with the direct income. ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `id` | *str* | :heavy_check_mark: | Unique identifier for a customer or supplier. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoice.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoice.md index 3532eeee5..5655edfa3 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoice.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoice.md @@ -35,8 +35,8 @@ In Codat, an invoice contains details of: | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | -| `additional_tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | +| `additional_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Additional tax amount applied to invoice. | | +| `additional_tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate of any additional tax applied to the invoice. | | | `amount_due` | *Decimal* | :heavy_check_mark: | Amount outstanding on the invoice. | | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | | `currency_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \| | | @@ -46,13 +46,13 @@ In Codat, an invoice contains details of: | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the invoice, unique to the company in the accounting platform. | | | `invoice_number` | *Optional[str]* | :heavy_minus_sign: | Friendly reference for the invoice. If available, this appears in the file name of invoice attachments. | | | `issue_date` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `line_items` | list[[InvoiceLineItem](../../models/shared/invoicelineitem.md)] | :heavy_minus_sign: | An array of line items. | | +| `line_items` | List[[InvoiceLineItem](../../models/shared/invoicelineitem.md)] | :heavy_minus_sign: | An array of line items. | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `note` | *Optional[str]* | :heavy_minus_sign: | Any additional information about the invoice. Where possible, Codat links to a data field in the accounting platform that is publicly available. This means that the contents of the note field are included when an invoice is emailed from the accounting platform to the customer. | | | `paid_on_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `payment_allocations` | list[[AccountingInvoicePaymentAllocation](../../models/shared/accountinginvoicepaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | -| `sales_order_refs` | list[[AccountingInvoiceSalesOrderReference](../../models/shared/accountinginvoicesalesorderreference.md)] | :heavy_minus_sign: | List of references to related Sales orders. | | +| `payment_allocations` | List[[AccountingInvoicePaymentAllocation](../../models/shared/accountinginvoicepaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | +| `sales_order_refs` | List[[AccountingInvoiceSalesOrderReference](../../models/shared/accountinginvoicesalesorderreference.md)] | :heavy_minus_sign: | List of references to related Sales orders. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `status` | [InvoiceStatus](../../models/shared/invoicestatus.md) | :heavy_check_mark: | Current state of the invoice:

- `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email.
- `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it (amountDue == totalAmount).
- `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount (0 < amountDue < totalAmount).
- `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid (amountDue == 0).
- `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. | | | `sub_total` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the invoice excluding any taxes. | | @@ -60,4 +60,4 @@ In Codat, an invoice contains details of: | `total_amount` | *Decimal* | :heavy_check_mark: | Amount of the invoice, inclusive of tax. | | | `total_discount` | *Optional[Decimal]* | :heavy_minus_sign: | Numerical value of discounts applied to the invoice. | | | `total_tax_amount` | *Decimal* | :heavy_check_mark: | Amount of tax on the invoice. | | -| `withholding_tax` | list[[AccountingInvoiceWithholdingTax](../../models/shared/accountinginvoicewithholdingtax.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `withholding_tax` | List[[AccountingInvoiceWithholdingTax](../../models/shared/accountinginvoicewithholdingtax.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoicesalesorderreference.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoicesalesorderreference.md index 369098fac..44f8a6394 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoicesalesorderreference.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoicesalesorderreference.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier to a record in `dataType`. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoicewithholdingtax.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoicewithholdingtax.md index b4afbbd61..686390d90 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoicewithholdingtax.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountinginvoicewithholdingtax.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `amount` | *Decimal* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `amount` | *Decimal* | :heavy_check_mark: | Amount of tax withheld. | +| `name` | *str* | :heavy_check_mark: | Name assigned to withheld tax. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingjournalentry.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingjournalentry.md index f866be1f8..6cdb7990a 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingjournalentry.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingjournalentry.md @@ -31,7 +31,7 @@ In Codat a journal entry contains details of: | `created_on` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `description` | *Optional[str]* | :heavy_minus_sign: | Optional description of the journal entry. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the journal entry for the company in the accounting platform. | | -| `journal_lines` | list[[JournalLine](../../models/shared/journalline.md)] | :heavy_minus_sign: | An array of journal lines. | | +| `journal_lines` | List[[JournalLine](../../models/shared/journalline.md)] | :heavy_minus_sign: | An array of journal lines. | | | `journal_ref` | [Optional[AccountingJournalEntryJournalReference]](../../models/shared/accountingjournalentryjournalreference.md) | :heavy_minus_sign: | Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals). | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingpayment.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingpayment.md index 3a5925662..64efdc9fc 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingpayment.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/accountingpayment.md @@ -690,11 +690,11 @@ In this example, a payment on account is used to pay the same invoice in January | `customer_ref` | [Optional[AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | | | `date_` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the payment, unique to the company in the accounting platform. | | -| `lines` | list[[PaymentLine](../../models/shared/paymentline.md)] | :heavy_minus_sign: | An array of payment lines. | | +| `lines` | List[[PaymentLine](../../models/shared/paymentline.md)] | :heavy_minus_sign: | An array of payment lines. | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `note` | *Optional[str]* | :heavy_minus_sign: | Any additional information associated with the payment. | | -| `payment_method_ref` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `payment_method_ref` | [Optional[PaymentMethodRef]](../../models/shared/paymentmethodref.md) | :heavy_minus_sign: | The payment method the record is linked to in the accounting or commerce platform. | | | `reference` | *Optional[str]* | :heavy_minus_sign: | Friendly reference for the payment. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/billedtotype.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/billedtotype.md index 091864dae..e121bedee 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/billedtotype.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/billedtotype.md @@ -1,5 +1,7 @@ # BilledToType +Defines if the bill or bill credit note is billed/rebilled to a project. + ## Values diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecompanyinfo.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecompanyinfo.md index b9cd61958..e6e19a0a5 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecompanyinfo.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecompanyinfo.md @@ -11,16 +11,16 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `account_balances` | list[[AccountBalance](../../models/shared/accountbalance.md)] | :heavy_minus_sign: | The available and current cash balances for the company's accounts | | -| `addresses` | list[[Items](../../models/shared/items.md)] | :heavy_minus_sign: | Addresses associated with the company | | +| `account_balances` | List[[AccountBalance](../../models/shared/accountbalance.md)] | :heavy_minus_sign: | The available and current cash balances for the company's accounts | | +| `addresses` | List[[Items](../../models/shared/items.md)] | :heavy_minus_sign: | Addresses associated with the company | | | `base_currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | | `commerce_platform_ref` | *Optional[str]* | :heavy_minus_sign: | Identifier or reference for the company in the commerce platform | | | `company_legal_name` | *Optional[str]* | :heavy_minus_sign: | The full legal name of the company | Codat Limited | | `company_name` | *Optional[str]* | :heavy_minus_sign: | The name of the company | Codat | | `created_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `phone_numbers` | list[[PhoneNumbersitems](../../models/shared/phonenumbersitems.md)] | :heavy_minus_sign: | Phone numbers associated with the company | | +| `phone_numbers` | List[[PhoneNumbersitems](../../models/shared/phonenumbersitems.md)] | :heavy_minus_sign: | Phone numbers associated with the company | | | `registration_number` | *Optional[str]* | :heavy_minus_sign: | The registration number of the company | 10480375 | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `source_urls` | dict[str, *str*] | :heavy_minus_sign: | URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system | | -| `web_links` | list[[WebLinksitems](../../models/shared/weblinksitems.md)] | :heavy_minus_sign: | Weblinks associated with the company | | \ No newline at end of file +| `source_urls` | Dict[str, *str*] | :heavy_minus_sign: | URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system | [object Object] | +| `web_links` | List[[WebLinksitems](../../models/shared/weblinksitems.md)] | :heavy_minus_sign: | Weblinks associated with the company | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecustomer.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecustomer.md index da40992a7..3439090ba 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecustomer.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecustomer.md @@ -9,7 +9,7 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | list[[CommerceCustomerAddress](../../models/shared/commercecustomeraddress.md)] | :heavy_minus_sign: | Addresses of the customer | | +| `addresses` | List[[CommerceCustomerAddress](../../models/shared/commercecustomeraddress.md)] | :heavy_minus_sign: | Addresses of the customer | | | `created_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `customer_name` | *Optional[str]* | :heavy_minus_sign: | Name of the customer | Fred Smith | | `default_currency` | *Optional[str]* | :heavy_minus_sign: | N/A | GBP | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecustomers.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecustomers.md index a6d130796..fa7a58dda 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecustomers.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercecustomers.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceCustomer](../../models/shared/commercecustomer.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceCustomer](../../models/shared/commercecustomer.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercelocations.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercelocations.md index e008e0bef..43dfaa980 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercelocations.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercelocations.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceLocation](../../models/shared/commercelocation.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceLocation](../../models/shared/commercelocation.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceorder.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceorder.md index 5259fab36..56ba06aed 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceorder.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceorder.md @@ -18,14 +18,14 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | | `location_ref` | [Optional[LocationRef]](../../models/shared/locationref.md) | :heavy_minus_sign: | Reference to the geographic location where the order was placed. | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `order_line_items` | list[[OrderLineItem](../../models/shared/orderlineitem.md)] | :heavy_minus_sign: | N/A | | +| `order_line_items` | List[[OrderLineItem](../../models/shared/orderlineitem.md)] | :heavy_minus_sign: | N/A | | | `order_number` | *Optional[str]* | :heavy_minus_sign: | Friendly reference for the order in the commerce or point of sale platform. | | -| `payments` | list[[PaymentRef](../../models/shared/paymentref.md)] | :heavy_minus_sign: | N/A | | -| `service_charges` | list[[ServiceCharge](../../models/shared/servicecharge.md)] | :heavy_minus_sign: | N/A | | +| `payments` | List[[PaymentRef](../../models/shared/paymentref.md)] | :heavy_minus_sign: | N/A | | +| `service_charges` | List[[ServiceCharge](../../models/shared/servicecharge.md)] | :heavy_minus_sign: | N/A | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `supplemental_data` | [Optional[CommerceOrderSupplementalData]](../../models/shared/commerceordersupplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the order, including tax, net of any discounts and refunds. | | -| `total_discount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of discount applied to the order. | | -| `total_gratuity` | *Optional[Decimal]* | :heavy_minus_sign: | Extra amount added to a bill. | | -| `total_refund` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount refunded issued by a merchant on an order (always a negative value). | | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the order, including discounts, refunds, and tax, but excluding gratuities. | | +| `total_discount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of any discounts applied to the order, excluding tax. This is typically positive (for discounts which decrease the amount of the order), but can also be negative (for discounts which increase the amount of the order). | | +| `total_gratuity` | *Optional[Decimal]* | :heavy_minus_sign: | Extra amount added to the order. | | +| `total_refund` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of any refunds issued on the order, including discounts and tax, but excluding gratuities. This is always negative. | | | `total_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of tax applied to the order. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceorders.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceorders.md index 767f3ef02..965bcd7c0 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceorders.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceorders.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceOrder](../../models/shared/commerceorder.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceOrder](../../models/shared/commerceorder.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceordersupplementaldata.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceordersupplementaldata.md deleted file mode 100755 index b3927c0c0..000000000 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceordersupplementaldata.md +++ /dev/null @@ -1,12 +0,0 @@ -# CommerceOrderSupplementalData - -Supplemental data is additional data you can include in our standard data types. - -It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. - - -## Fields - -| Field | Type | Required | Description | -| --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `content` | dict[str, dict[str, *Any*]] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepayment.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepayment.md index a669fe08a..0150c9949 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepayment.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepayment.md @@ -19,7 +19,8 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | `due_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `payment_method_ref` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `payment_method_ref` | [Optional[PaymentMethodRef]](../../models/shared/paymentmethodref.md) | :heavy_minus_sign: | The payment method the record is linked to in the accounting or commerce platform. | | | `payment_provider` | *Optional[str]* | :heavy_minus_sign: | Service provider of the payment, if applicable. | Amazon Pay | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[PaymentStatus]](../../models/shared/paymentstatus.md) | :heavy_minus_sign: | Status of the payment. | | \ No newline at end of file +| `status` | [Optional[PaymentStatus]](../../models/shared/paymentstatus.md) | :heavy_minus_sign: | Status of the payment. | | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepaymentmethod.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepaymentmethod.md index 917fe0d84..a486924c7 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepaymentmethod.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepaymentmethod.md @@ -7,10 +7,10 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `name` | *Optional[str]* | :heavy_minus_sign: | The name of the PaymentMethod | Alipay | -| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[PaymentMethodStatus]](../../models/shared/paymentmethodstatus.md) | :heavy_minus_sign: | Status of the Payment Method | Active | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | +| `name` | *Optional[str]* | :heavy_minus_sign: | The name of the PaymentMethod | Alipay | +| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | +| `status` | [Optional[CommercePaymentMethodStatus]](../../models/shared/commercepaymentmethodstatus.md) | :heavy_minus_sign: | Status of the Payment Method. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepaymentmethods.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepaymentmethods.md index 636c5d30e..d9ed0537a 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepaymentmethods.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepaymentmethods.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommercePaymentMethod](../../models/shared/commercepaymentmethod.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommercePaymentMethod](../../models/shared/commercepaymentmethod.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepaymentmethodstatus.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepaymentmethodstatus.md new file mode 100755 index 000000000..7ec7c78b1 --- /dev/null +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepaymentmethodstatus.md @@ -0,0 +1,12 @@ +# CommercePaymentMethodStatus + +Status of the Payment Method. + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `UNKNOWN` | Unknown | +| `ACTIVE` | Active | +| `ARCHIVED` | Archived | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepayments.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepayments.md index 3ae2b0a03..1342faa9e 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepayments.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercepayments.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommercePayment](../../models/shared/commercepayment.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommercePayment](../../models/shared/commercepayment.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceproduct.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceproduct.md index a61e6153b..c5475c1b9 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceproduct.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceproduct.md @@ -8,11 +8,12 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `categorization` | *Optional[str]* | :heavy_minus_sign: | Retail category that the product is assigned to | Hardware | -| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the product recorded in the commerce or point of sale platform. | 1tb Western Digital Hard Drive | -| `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `is_gift_card` | *Optional[bool]* | :heavy_minus_sign: | Whether the product represents a gift card or voucher that
can be redeemed in the commerce or POS platform
| | -| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product in the commerce or POS system | Hard Drive | -| `variants` | list[[ProductVariant](../../models/shared/productvariant.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `categorization` | *Optional[str]* | :heavy_minus_sign: | Retail category that the product is assigned to e.g. `Hardware`. | Hardware | +| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the product recorded in the commerce or point of sale platform. | 1tb Western Digital Hard Drive | +| `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `is_gift_card` | *Optional[bool]* | :heavy_minus_sign: | Whether the product represents a gift card or voucher that
can be redeemed in the commerce or POS platform.
| | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product in the commerce or POS system | Hard Drive | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `variants` | List[[ProductVariant](../../models/shared/productvariant.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceproducts.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceproducts.md index 665f0f9f2..8ef137024 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceproducts.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commerceproducts.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceProduct](../../models/shared/commerceproduct.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceProduct](../../models/shared/commerceproduct.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercetransaction.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercetransaction.md index 10d4ad5c0..f93909601 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercetransaction.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercetransaction.md @@ -23,6 +23,7 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | `source_created_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `sub_type` | *Optional[str]* | :heavy_minus_sign: | Non-standardised transaction type data from the commerce platform | CardPayment | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | The total transaction amount | 194.12 | | `transaction_source_ref` | [Optional[TransactionSourceRef]](../../models/shared/transactionsourceref.md) | :heavy_minus_sign: | Link to the source event which triggered this transaction | | | `type` | [Optional[TransactionType]](../../models/shared/transactiontype.md) | :heavy_minus_sign: | The type of the platform transaction:
- `Unknown`
- `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account.
- `Payment` — Credit and debit card payments.
- `PaymentFee` — Payment provider's fee on each card payment.
- `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller.
- `Payout` — Transfer of funds from the seller's merchant account to their bank account.
- `Refund` — Refunds to a customer's credit or debit card.
- `Transfer` — Secure transfer of funds to the seller's bank account. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercetransactions.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercetransactions.md index 8e1fd267e..2f0ecba32 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercetransactions.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/commercetransactions.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceTransaction](../../models/shared/commercetransaction.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceTransaction](../../models/shared/commercetransaction.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/companies.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/companies.md index c4c6e0399..eeaacf9de 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/companies.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/companies.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[Company](../../models/shared/company.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[Company](../../models/shared/company.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/company.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/company.md index b2cbd9e67..a28e455f2 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/company.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/company.md @@ -12,11 +12,11 @@ When you create a company, you can specify a `name` and we will automatically ge | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `created` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `created_by_user_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `data_connections` | list[[Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | | +| `created_by_user_name` | *Optional[str]* | :heavy_minus_sign: | Name of user that created the company in Codat. | | +| `data_connections` | List[[Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | | | `description` | *Optional[str]* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | | `id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `last_sync` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `name` | *str* | :heavy_check_mark: | The name of the company | Codat Ltd. | -| ~~`platform`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | Xero | +| ~~`platform`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

`platformKeys` name used when creating the company. | Xero | | `redirect` | *str* | :heavy_check_mark: | The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/configaccount.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/configaccount.md index b902d5ae3..ce5b5e9d3 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/configaccount.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/configaccount.md @@ -7,7 +7,7 @@ G/L account object for configuration. | Field | Type | Required | Description | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `account_options` | list[[AccountOption](../../models/shared/accountoption.md)] | :heavy_minus_sign: | Object containing account options. | +| `account_options` | List[[AccountOption](../../models/shared/accountoption.md)] | :heavy_minus_sign: | Object containing account options. | | `description_text` | *Optional[str]* | :heavy_minus_sign: | Descriprtive text for sales configuration section. | | `label_text` | *Optional[str]* | :heavy_minus_sign: | Label text for sales configuration section. | | `required` | *Optional[bool]* | :heavy_minus_sign: | Required section to be configured for sync. | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/connection.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/connection.md index 69b6f0fbe..de139f308 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/connection.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/connection.md @@ -17,15 +17,15 @@ Before you can use a data connection to pull or push data, the company must gran | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additional_properties` | *Optional[Any]* | :heavy_minus_sign: | N/A | | -| `connection_info` | dict[str, *str*] | :heavy_minus_sign: | N/A | | +| `connection_info` | Dict[str, *str*] | :heavy_minus_sign: | N/A | | | `created` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `data_connection_errors` | list[[DataConnectionError](../../models/shared/dataconnectionerror.md)] | :heavy_minus_sign: | N/A | | +| `data_connection_errors` | List[[DataConnectionError](../../models/shared/dataconnectionerror.md)] | :heavy_minus_sign: | N/A | | | `id` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `integration_id` | *str* | :heavy_check_mark: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | | `integration_key` | *str* | :heavy_check_mark: | A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. | | | `last_sync` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `link_url` | *str* | :heavy_check_mark: | N/A | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start | -| `platform_name` | *str* | :heavy_check_mark: | N/A | | +| `link_url` | *str* | :heavy_check_mark: | The link URL your customers can use to authorize access to their business application. | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start | +| `platform_name` | *str* | :heavy_check_mark: | Name of integration connected to company. | | | `source_id` | *str* | :heavy_check_mark: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 | | `source_type` | [ConnectionSourceType](../../models/shared/connectionsourcetype.md) | :heavy_check_mark: | The type of platform of the connection. | Accounting | | `status` | [DataConnectionStatus](../../models/shared/dataconnectionstatus.md) | :heavy_check_mark: | The current authorization status of the data connection. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/connections.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/connections.md index d9a1a748e..87ee809ab 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/connections.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/connections.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/contact.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/contact.md index f8b774813..14807f306 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/contact.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/contact.md @@ -9,5 +9,5 @@ | `email` | *Optional[str]* | :heavy_minus_sign: | Email of a contact for a customer. | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `name` | *Optional[str]* | :heavy_minus_sign: | Name of a contact for a customer. | | -| `phone` | list[[PhoneNumbersitems](../../models/shared/phonenumbersitems.md)] | :heavy_minus_sign: | An array of Phone numbers. | | +| `phone` | List[[PhoneNumbersitems](../../models/shared/phonenumbersitems.md)] | :heavy_minus_sign: | An array of Phone numbers. | | | `status` | [CustomerStatus](../../models/shared/customerstatus.md) | :heavy_check_mark: | Status of customer. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitem.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitem.md index 8bd4594d9..5442fa50f 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitem.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitem.md @@ -9,7 +9,7 @@ | `description` | *Optional[str]* | :heavy_minus_sign: | Friendly name of each line item. For example, the goods or service for which credit has been issued. | | `discount_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Value of any discounts applied. | | `discount_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate of any discount applied to the line item. | -| `is_direct_income` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `is_direct_income` | *Optional[bool]* | :heavy_minus_sign: | The credit note is a direct income if `True`. | | `item_ref` | [Optional[ItemRef]](../../models/shared/itemref.md) | :heavy_minus_sign: | Reference to the product, service type, or inventory item to which the direct cost is linked. | | `quantity` | *Decimal* | :heavy_check_mark: | Number of units of the goods or service for which credit has been issued. | | `sub_total` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of credit associated with the line item, including discounts but excluding tax. | @@ -17,5 +17,5 @@ | `tax_rate_ref` | [Optional[TaxRateRef]](../../models/shared/taxrateref.md) | :heavy_minus_sign: | Reference to the tax rate to which the line item is linked. | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the line item, including discounts and tax. | | `tracking` | [Optional[CreditNoteLineItemTracking]](../../models/shared/creditnotelineitemtracking.md) | :heavy_minus_sign: | Categories, and a project and customer, against which the item is tracked. | -| ~~`tracking_category_refs`~~ | list[[TrackingCategoryRefsitems](../../models/shared/trackingcategoryrefsitems.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Reference to the tracking categories to which the line item is linked. | +| ~~`tracking_category_refs`~~ | List[[TrackingCategoryRefsitems](../../models/shared/trackingcategoryrefsitems.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Reference to the tracking categories to which the line item is linked. | | `unit_amount` | *Decimal* | :heavy_check_mark: | Unit price of the goods or service. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitemtracking.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitemtracking.md index 29ec847a4..3481cd714 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitemtracking.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitemtracking.md @@ -7,9 +7,9 @@ Categories, and a project and customer, against which the item is tracked. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `category_refs` | list[[TrackingCategoryRefsitems](../../models/shared/trackingcategoryrefsitems.md)] | :heavy_check_mark: | N/A | +| `category_refs` | List[[TrackingCategoryRefsitems](../../models/shared/trackingcategoryrefsitems.md)] | :heavy_check_mark: | N/A | | `customer_ref` | [Optional[AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | -| `is_billed_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | N/A | -| `is_rebilled_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | N/A | +| `is_billed_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | Defines if the bill or bill credit note is billed/rebilled to a project. | +| `is_rebilled_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | Defines if the bill or bill credit note is billed/rebilled to a project. | | `project_ref` | [Optional[CreditNoteLineItemTrackingProjectReference]](../../models/shared/creditnotelineitemtrackingprojectreference.md) | :heavy_minus_sign: | N/A | | `record_ref` | [Optional[RecordRef]](../../models/shared/recordref.md) | :heavy_minus_sign: | Links the current record to the underlying record or data type that created it.

For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitemtrackingprojectreference.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitemtrackingprojectreference.md index 0872721bc..f5f299cd5 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitemtrackingprojectreference.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotelineitemtrackingprojectreference.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | Unique identifier to the project reference. | +| `name` | *Optional[str]* | :heavy_minus_sign: | The project's name. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotestatus.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotestatus.md index 5ae9874f2..bf285b397 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotestatus.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/creditnotestatus.md @@ -1,5 +1,7 @@ # CreditNoteStatus +Current state of the credit note. + ## Values diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/customer.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/customer.md index ff10c1e80..240be12d8 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/customer.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/customer.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `customer_options` | list[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | List of customer options from the list of customer records on the accounting software. | +| `customer_options` | List[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | List of customer options from the list of customer records on the accounting software. | | `selected_customer_id` | *Optional[str]* | :heavy_minus_sign: | Selected customer id from the list of customer records on the accounting software. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/dataconnectionerror.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/dataconnectionerror.md index 6c85722e1..7dd2be969 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/dataconnectionerror.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/dataconnectionerror.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A brief message about the error. | | | `errored_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status_code` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status_text` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `status_code` | *Optional[str]* | :heavy_minus_sign: | The HTTP status code returned by the error. | | +| `status_text` | *Optional[str]* | :heavy_minus_sign: | A non-numeric status code/text. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/dataset.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/dataset.md index 44424109b..b97b4a4cb 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/dataset.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/dataset.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `connection_id` | *str* | :heavy_check_mark: | N/A | | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `dataset_logs_url` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `is_completed` | *bool* | :heavy_check_mark: | N/A | | -| `is_errored` | *bool* | :heavy_check_mark: | N/A | | -| `progress` | *int* | :heavy_check_mark: | N/A | | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `data_type` | [Optional[DatasetDataTypes]](../../models/shared/datasetdatatypes.md) | :heavy_minus_sign: | Available Data types | invoices | +| `dataset_logs_url` | *Optional[str]* | :heavy_minus_sign: | URI to the dataset's logs. | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A brief message about the error. | | +| `id` | *str* | :heavy_check_mark: | Identifier for the dataset. | | +| `is_completed` | *bool* | :heavy_check_mark: | `True` if the dataset completed successfully. | | +| `is_errored` | *bool* | :heavy_check_mark: | `True` if the dataset entered an error state. | | +| `progress` | *int* | :heavy_check_mark: | An integer signifying the progress of the dataset. | | | `requested` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [DatasetStatus](../../models/shared/datasetstatus.md) | :heavy_check_mark: | N/A | | -| `validation_information_url` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `status` | [DatasetStatus](../../models/shared/datasetstatus.md) | :heavy_check_mark: | The current status of the dataset. | | +| `validation_information_url` | *Optional[str]* | :heavy_minus_sign: | URI to the dataset's validation information. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/datatypefeaturedatatypes.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/datasetdatatypes.md similarity index 99% rename from previous-versions/sync-for-commerce-version-1/docs/models/shared/datatypefeaturedatatypes.md rename to previous-versions/sync-for-commerce-version-1/docs/models/shared/datasetdatatypes.md index 7fccfb6fa..a952b8027 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/datatypefeaturedatatypes.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/datasetdatatypes.md @@ -1,4 +1,4 @@ -# DataTypeFeatureDataTypes +# DatasetDataTypes Available Data types diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/datasetstatus.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/datasetstatus.md index 994974fd3..42a224341 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/datasetstatus.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/datasetstatus.md @@ -1,5 +1,7 @@ # DatasetStatus +The current status of the dataset. + ## Values diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/datastatus.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/datastatus.md index 389c2cf54..f2a678cda 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/datastatus.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/datastatus.md @@ -7,8 +7,8 @@ Describes the state of data in the Codat cache for a company and data type | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `current_status` | *str* | :heavy_check_mark: | N/A | | -| `data_type` | *str* | :heavy_check_mark: | N/A | | +| `current_status` | *str* | :heavy_check_mark: | The current status of the dataset in Codat's cache. | | +| `data_type` | [DataType](../../models/shared/datatype.md) | :heavy_check_mark: | Available Data types | invoices | | `last_successful_sync` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `latest_successful_sync_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 8220fc90-55b6-47bc-9417-48ac6ea93101 | -| `latest_sync_id` | *Optional[str]* | :heavy_minus_sign: | N/A | ad474a37-2003-478e-baee-9af9f1ec2fe3 | \ No newline at end of file +| `latest_successful_sync_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the most recent successful sync of data type. | 8220fc90-55b6-47bc-9417-48ac6ea93101 | +| `latest_sync_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for most recent sync of data type. | ad474a37-2003-478e-baee-9af9f1ec2fe3 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/datatypefeature.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/datatypefeature.md index aefc53b2d..c3e4364d9 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/datatypefeature.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/datatypefeature.md @@ -5,7 +5,7 @@ Describes support for a given datatype and associated operations ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `data_type` | [Optional[DataTypeFeatureDataTypes]](../../models/shared/datatypefeaturedatatypes.md) | :heavy_minus_sign: | Available Data types | invoices | -| `supported_features` | list[[SupportedFeature](../../models/shared/supportedfeature.md)] | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `supported_features` | List[[SupportedFeature](../../models/shared/supportedfeature.md)] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/directincomelineitem.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/directincomelineitem.md index 03d8c165d..b51cbb942 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/directincomelineitem.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/directincomelineitem.md @@ -15,5 +15,5 @@ | `tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | The amount of tax for the line.
Note: If the platform does not provide this information, the quantity will be mapped as 0.00. | | `tax_rate_ref` | [Optional[DirectIncomeLineItemTaxRateReference]](../../models/shared/directincomelineitemtaxratereference.md) | :heavy_minus_sign: | Reference to the tax rate to which the line item is linked. | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | The total amount of the line, including tax. | -| `tracking_category_refs` | list[[DirectIncomeLineItemTrackingCategoryRefs](../../models/shared/directincomelineitemtrackingcategoryrefs.md)] | :heavy_minus_sign: | An array of categories against which this direct cost is tracked. | +| `tracking_category_refs` | List[[DirectIncomeLineItemTrackingCategoryRefs](../../models/shared/directincomelineitemtrackingcategoryrefs.md)] | :heavy_minus_sign: | An array of categories against which this direct cost is tracked. | | `unit_amount` | *Decimal* | :heavy_check_mark: | The price of each unit of goods or services.
Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/directincomelineitemtrackingcategoryrefs.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/directincomelineitemtrackingcategoryrefs.md index 11608ff3b..79743a25d 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/directincomelineitemtrackingcategoryrefs.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/directincomelineitemtrackingcategoryrefs.md @@ -7,7 +7,7 @@ References a category against which the item is tracked. ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | Unique identifier to the tracking category. | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of tracking category. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/errormessage.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/errormessage.md index 4f34c9a64..2d1289c0d 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/errormessage.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/errormessage.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `error` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `service` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `status_code` | *Optional[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. | +| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. | +| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. | +| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. | +| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. | +| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/featurestate.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/featurestate.md index f0635a179..64b943064 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/featurestate.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/featurestate.md @@ -1,5 +1,7 @@ # FeatureState +The current release state of the feature. + ## Values diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/featuretype.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/featuretype.md index 42a91f688..b2aa31be0 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/featuretype.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/featuretype.md @@ -1,5 +1,7 @@ # FeatureType +The type of feature. + ## Values diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/fees.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/fees.md index f567b3925..e12dfe22a 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/fees.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/fees.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `accounts` | dict[str, [ConfigAccount](../../models/shared/configaccount.md)] | :heavy_minus_sign: | N/A | +| `accounts` | Dict[str, [ConfigAccount](../../models/shared/configaccount.md)] | :heavy_minus_sign: | N/A | | `fees_supplier` | [Optional[FeesSupplier]](../../models/shared/feessupplier.md) | :heavy_minus_sign: | N/A | | `sync_fees` | *Optional[bool]* | :heavy_minus_sign: | Boolean indicator to enable syncing fees. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/feessupplier.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/feessupplier.md index 0f50697ad..fe7ad6ebe 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/feessupplier.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/feessupplier.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `selected_supplier_id` | *Optional[str]* | :heavy_minus_sign: | Selected supplier id from the list of supplier records on the accounting software. | -| `supplier_options` | list[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | List of supplier options from the list of supplier records on the accounting software. | \ No newline at end of file +| `supplier_options` | List[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | List of supplier options from the list of supplier records on the accounting software. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/groupingperiod.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/groupingperiod.md index 5eedfc300..f6be1a8de 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/groupingperiod.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/groupingperiod.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `grouping_period_options` | list[*str*] | :heavy_minus_sign: | Array of grouping period options. | +| `grouping_period_options` | List[*str*] | :heavy_minus_sign: | Array of grouping period options. | | `selected_grouping_period` | *Optional[str]* | :heavy_minus_sign: | Grouping period i.e. Daily sales. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/halref.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/halref.md index fef2ab2fc..94c6476ff 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/halref.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/halref.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `href` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `href` | *Optional[str]* | :heavy_minus_sign: | Uri hypertext reference. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/integration.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/integration.md index a4e810096..1489a675a 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/integration.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/integration.md @@ -5,16 +5,16 @@ An integration that Codat supports ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data_provided_by` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `datatype_features` | list[[DataTypeFeature](../../models/shared/datatypefeature.md)] | :heavy_minus_sign: | N/A | | -| `enabled` | *bool* | :heavy_check_mark: | Whether this integration is enabled for your customers to use | | -| `integration_id` | *Optional[str]* | :heavy_minus_sign: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | -| `is_beta` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `is_offline_connector` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/accounting-platform-keys), [banking](https://docs.codat.io/integrations/banking/banking-platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/commerce-platform-keys) platform keys. | gbol | -| `logo_url` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | Xero | -| `source_id` | *Optional[str]* | :heavy_minus_sign: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 | -| `source_type` | [Optional[SourceType]](../../models/shared/sourcetype.md) | :heavy_minus_sign: | The type of platform of the connection. | Accounting | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `data_provided_by` | *Optional[str]* | :heavy_minus_sign: | The name of the data provider. | | +| `datatype_features` | List[[DataTypeFeature](../../models/shared/datatypefeature.md)] | :heavy_minus_sign: | N/A | | +| `enabled` | *bool* | :heavy_check_mark: | Whether this integration is enabled for your customers to use. | | +| `integration_id` | *Optional[str]* | :heavy_minus_sign: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | +| `is_beta` | *Optional[bool]* | :heavy_minus_sign: | `True` if the integration is currently in beta release. | | +| `is_offline_connector` | *Optional[bool]* | :heavy_minus_sign: | `True` if the integration is to an application installed and run locally on an SMBs computer. | | +| `key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | +| `logo_url` | *str* | :heavy_check_mark: | Static url for integration's logo. | | +| `name` | *str* | :heavy_check_mark: | Name of integration. | Xero | +| `source_id` | *Optional[str]* | :heavy_minus_sign: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 | +| `source_type` | [Optional[SourceType]](../../models/shared/sourcetype.md) | :heavy_minus_sign: | The type of platform of the connection. | Accounting | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/integrations.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/integrations.md index 31ab0315a..b2521c5da 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/integrations.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/integrations.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[Integration](../../models/shared/integration.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[Integration](../../models/shared/integration.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelevelselection.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelevelselection.md index 6e850ef18..42f35c36c 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelevelselection.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelevelselection.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `group_by_options` | list[*str*] | :heavy_minus_sign: | Options for grouping sales. | -| `selected_group_by_options` | list[*str*] | :heavy_minus_sign: | Selected array of grouping options. | \ No newline at end of file +| `group_by_options` | List[*str*] | :heavy_minus_sign: | Options for grouping sales. | +| `selected_group_by_options` | List[*str*] | :heavy_minus_sign: | Selected array of grouping options. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelineitem.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelineitem.md index 80efdf3b0..e03ddcc8a 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelineitem.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelineitem.md @@ -9,7 +9,7 @@ | `description` | *Optional[str]* | :heavy_minus_sign: | Friendly name of the goods or services provided. | | `discount_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Numerical value of any discounts applied. | | `discount_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any discounts applied to the unit amount. | -| `is_direct_income` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `is_direct_income` | *Optional[bool]* | :heavy_minus_sign: | The invoice is a direct income if `True`. | | `item_ref` | [Optional[ItemRef]](../../models/shared/itemref.md) | :heavy_minus_sign: | Reference to the product, service type, or inventory item to which the direct cost is linked. | | `quantity` | *Decimal* | :heavy_check_mark: | Number of units of goods or services provided. | | `sub_total` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of the line, inclusive of discounts but exclusive of tax. | @@ -17,5 +17,5 @@ | `tax_rate_ref` | [Optional[TaxRateRef]](../../models/shared/taxrateref.md) | :heavy_minus_sign: | Reference to the tax rate to which the line item is linked. | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the line, including tax. When pushing invoices to Xero, the total amount is exclusive of tax to allow automatic calculations if a tax rate or tax amount is not specified. | | `tracking` | [Optional[Tracking]](../../models/shared/tracking.md) | :heavy_minus_sign: | Categories, and a project and customer, against which the item is tracked. | -| ~~`tracking_category_refs`~~ | list[[TrackingCategoryRefsitems](../../models/shared/trackingcategoryrefsitems.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Reference to the tracking categories to which the line item is linked. | +| ~~`tracking_category_refs`~~ | List[[TrackingCategoryRefsitems](../../models/shared/trackingcategoryrefsitems.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Reference to the tracking categories to which the line item is linked. | | `unit_amount` | *Decimal* | :heavy_check_mark: | Price of each unit of goods or services. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelinelevelselection.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelinelevelselection.md index 72068c4d2..537e53ef5 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelinelevelselection.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicelinelevelselection.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `group_by_options` | list[*str*] | :heavy_minus_sign: | Options for grouping on invoice lines. | -| `selected_group_by_options` | list[*str*] | :heavy_minus_sign: | Invoice line level selection. | \ No newline at end of file +| `group_by_options` | List[*str*] | :heavy_minus_sign: | Options for grouping on invoice lines. | +| `selected_group_by_options` | List[*str*] | :heavy_minus_sign: | Invoice line level selection. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicestatus1.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicestatus1.md index 308d9c0bd..0b57ee588 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicestatus1.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/invoicestatus1.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `invoice_status_options` | list[*str*] | :heavy_minus_sign: | Options for invoice statuses. | | +| `invoice_status_options` | List[*str*] | :heavy_minus_sign: | Options for invoice statuses. | | | `selected_invoice_status` | *Optional[str]* | :heavy_minus_sign: | Selected option for invoice status for invoice to be synced. | Submitted | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/journallinetracking.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/journallinetracking.md index 29f3d72ca..91cc6cd30 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/journallinetracking.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/journallinetracking.md @@ -7,4 +7,4 @@ List of record refs associated with the tracking information for the line (eg to | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `record_refs` | list[[RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `record_refs` | List[[RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/localization.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/localization.md index 7d8c83780..1122d35ba 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/localization.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/localization.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `required` | *Optional[bool]* | :heavy_minus_sign: | `True` if required. | | `text` | *Optional[str]* | :heavy_minus_sign: | Value of the property. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/newpayments.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/newpayments.md index f3de857c2..b1fd0b3d3 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/newpayments.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/newpayments.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `accounts` | dict[str, [ConfigAccount](../../models/shared/configaccount.md)] | :heavy_minus_sign: | N/A | +| `accounts` | Dict[str, [ConfigAccount](../../models/shared/configaccount.md)] | :heavy_minus_sign: | N/A | | `sync_payments` | *Optional[bool]* | :heavy_minus_sign: | Boolean indicator for syncing payments. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/newtaxrates.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/newtaxrates.md index 829a5bc9d..4e9c2fa31 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/newtaxrates.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/newtaxrates.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `accounting_tax_rate_options` | list[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | Array of accounting tax rate options. | -| `commerce_tax_rate_options` | list[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | Array of tax component options. | -| `default_zero_tax_rate_options` | list[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | Default zero tax rate selected for sync. | +| `accounting_tax_rate_options` | List[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | Array of accounting tax rate options. | +| `commerce_tax_rate_options` | List[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | Array of tax component options. | +| `default_zero_tax_rate_options` | List[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | Default zero tax rate selected for sync. | | `selected_default_zero_tax_rate_id` | *Optional[str]* | :heavy_minus_sign: | Default tax rate selected for sync. | -| `tax_rate_mappings` | list[[TaxRateMapping](../../models/shared/taxratemapping.md)] | :heavy_minus_sign: | Array of tax component to rate mapppings. | \ No newline at end of file +| `tax_rate_mappings` | List[[TaxRateMapping](../../models/shared/taxratemapping.md)] | :heavy_minus_sign: | Array of tax component to rate mapppings. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/orderdiscountallocation.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/orderdiscountallocation.md index 3bfdab4d5..84a454e20 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/orderdiscountallocation.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/orderdiscountallocation.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the discount in the commerce or point of sale platform. | Promotional Discount | -| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of discount applied. | 15.25 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the discount in the commerce or point of sale platform. | Promotional Discount | +| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of discount applied, excluding tax. This is typically positive (for discounts which decrease the amount of the order line), but can also be negative (for discounts which increase the amount of the order line). | 15.25 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/orderlineitem.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/orderlineitem.md index b2e9765d9..fa38fb9c9 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/orderlineitem.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/orderlineitem.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `discount_allocations` | list[[OrderDiscountAllocation](../../models/shared/orderdiscountallocation.md)] | :heavy_minus_sign: | N/A | | +| `discount_allocations` | List[[OrderDiscountAllocation](../../models/shared/orderdiscountallocation.md)] | :heavy_minus_sign: | N/A | | | `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | | `product_ref` | [Optional[ProductRef]](../../models/shared/productref.md) | :heavy_minus_sign: | Reference that links the line item to the correct product details. | | | `product_variant_ref` | [Optional[ProductVariantRef]](../../models/shared/productvariantref.md) | :heavy_minus_sign: | Reference that links the line item to the specific version of product that has been ordered. | | -| `quantity` | *Optional[Decimal]* | :heavy_minus_sign: | Number of units of the product sold.
For refunds, quantity is a negative value.
| | -| `tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any sale tax applied to the unit amount. | 0 | -| `taxes` | list[[Taxesitems](../../models/shared/taxesitems.md)] | :heavy_minus_sign: | Taxes breakdown as applied to order lines. | | -| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total price of the line item, including discounts, tax and minus any refunds. | | -| `total_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of tax applied to the line item. | | -| `unit_price` | *Optional[Decimal]* | :heavy_minus_sign: | Price per unit of goods or service. | | \ No newline at end of file +| `quantity` | *Optional[Decimal]* | :heavy_minus_sign: | Number of units of the product sold.
For refunds, quantity is negative.
| | +| `tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any sales tax applied to the unit price. | 0 | +| `taxes` | List[[Taxesitems](../../models/shared/taxesitems.md)] | :heavy_minus_sign: | Taxes breakdown as applied to order lines. | | +| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the line item, including discounts and tax. | | +| `total_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of tax applied to the line item, factoring in any discounts. | | +| `unit_price` | *Optional[Decimal]* | :heavy_minus_sign: | Price per unit of goods or services, excluding discounts and tax. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/paymentline.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/paymentline.md index af0fe8ddf..e59a9cb01 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/paymentline.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/paymentline.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allocated_on_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `amount` | *Decimal* | :heavy_check_mark: | Amount in the payment currency. | | -| `links` | list[[PaymentLineLink](../../models/shared/paymentlinelink.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `links` | List[[PaymentLineLink](../../models/shared/paymentlinelink.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/paymentmethodref.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/paymentmethodref.md new file mode 100755 index 000000000..9f8fd8995 --- /dev/null +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/paymentmethodref.md @@ -0,0 +1,11 @@ +# PaymentMethodRef + +The payment method the record is linked to in the accounting or commerce platform. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the location being referenced. | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the location being referenced. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/paymentmethodstatus.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/paymentmethodstatus.md deleted file mode 100755 index a34ab7a84..000000000 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/paymentmethodstatus.md +++ /dev/null @@ -1,12 +0,0 @@ -# PaymentMethodStatus - -Status of the Payment Method - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `ACTIVE` | Active | -| `ARCHIVED` | Archived | -| `UNKNOWN` | Unknown | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/payments.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/payments.md index 818a0adf6..af8f464c5 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/payments.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/payments.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `accounts` | dict[str, [ConfigAccount](../../models/shared/configaccount.md)] | :heavy_minus_sign: | N/A | +| `accounts` | Dict[str, [ConfigAccount](../../models/shared/configaccount.md)] | :heavy_minus_sign: | N/A | | `sync_payments` | *Optional[bool]* | :heavy_minus_sign: | Boolean indicator for syncing sales. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/phonenumbersitems.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/phonenumbersitems.md index 34da443db..0390ea0b2 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/phonenumbersitems.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/phonenumbersitems.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `number` | *str* | :heavy_check_mark: | A phone number. | +44 25691 154789 | +| `number` | *Optional[str]* | :heavy_check_mark: | A phone number. | +44 25691 154789 | | `type` | [PhoneNumberType](../../models/shared/phonenumbertype.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productinventory.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productinventory.md index 0bfa223b2..a551e7026 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productinventory.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productinventory.md @@ -7,5 +7,5 @@ Information about the total inventory as well as the locations inventory is in. | Field | Type | Required | Description | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `locations` | list[[ProductInventoryLocation](../../models/shared/productinventorylocation.md)] | :heavy_minus_sign: | N/A | -| `total_quantity` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `locations` | List[[ProductInventoryLocation](../../models/shared/productinventorylocation.md)] | :heavy_minus_sign: | N/A | +| `total_quantity` | *Optional[Decimal]* | :heavy_minus_sign: | The total quantity of stock remaining across locations. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productinventorylocation.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productinventorylocation.md index f7bb3d716..3ebe8cefa 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productinventorylocation.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productinventorylocation.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | `location_ref` | [Optional[LocationRef]](../../models/shared/locationref.md) | :heavy_minus_sign: | Reference to the geographic location where the order was placed. | -| `quantity` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `quantity` | *Optional[Decimal]* | :heavy_minus_sign: | The quantity of stock remaining at location. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productprice.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productprice.md index e92fe544d..c7143ea68 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productprice.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productprice.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | -| `unit_price` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `unit_price` | *Optional[Decimal]* | :heavy_minus_sign: | The product variant's unit price. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productref.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productref.md index 442e20373..69c038149 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productref.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productref.md @@ -5,7 +5,7 @@ Reference that links the line item to the correct product details. ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identitifer of the product being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product being referenced. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the product being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product being referenced. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariant.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariant.md index cc1e04314..70b360a62 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariant.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariant.md @@ -15,10 +15,10 @@ Represents a variation of a product available for sale, for example an item of c | `is_tax_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether sales taxes are enabled for this product variant. | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product recorded in the commerce or point of sale platform. | Red Coat | -| `prices` | list[[ProductPrice](../../models/shared/productprice.md)] | :heavy_minus_sign: | Prices for the product variants in different currencies. | | +| `prices` | List[[ProductPrice](../../models/shared/productprice.md)] | :heavy_minus_sign: | Prices for the product variants in different currencies. | | | `shipping_required` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether or not the product requires physical delivery. | | | `sku` | *Optional[str]* | :heavy_minus_sign: | SKU (stock keeping unit) of the variant, as defined by the merchant. | Coat-Red-Lrg | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[ProductVariantStatus]](../../models/shared/productvariantstatus.md) | :heavy_minus_sign: | N/A | | +| `status` | [Optional[ProductVariantStatus]](../../models/shared/productvariantstatus.md) | :heavy_minus_sign: | The status of the product variant. | | | `unit_of_measure` | *Optional[str]* | :heavy_minus_sign: | Unit of measure for the variant, such as `kg` or `meters`. | kg | | `vat_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | VAT rate for the product variant if sales taxes are enabled. | 12.5 | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariantref.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariantref.md index 7eb6aeee5..34c2bb82f 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariantref.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariantref.md @@ -5,7 +5,7 @@ Reference that links the line item to the specific version of product that has b ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identitifer of the product variant being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product variant being referenced. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the product variant being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product variant being referenced. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariantstatus.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariantstatus.md index 3a6aefbda..cac82c987 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariantstatus.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/productvariantstatus.md @@ -1,5 +1,7 @@ # ProductVariantStatus +The status of the product variant. + ## Values diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperation.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperation.md index a4f6d0c4b..07104cbd5 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperation.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperation.md @@ -8,12 +8,14 @@ Information about a queued, in progress or completed pull operation. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 22ece347-e5f6-4896-95e0-35a4c7f17023 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 50830828-7d39-4367-b0eb-5ddb2de5faa5 | -| `data_type` | *str* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | 943accd0-4247-42d8-865b-363c8629e1da | -| `is_completed` | *bool* | :heavy_check_mark: | N/A | | -| `is_errored` | *bool* | :heavy_check_mark: | N/A | | -| `progress` | *int* | :heavy_check_mark: | N/A | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier of the company associated to this pull operation. | 22ece347-e5f6-4896-95e0-35a4c7f17023 | +| `completed` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier of the connection associated to this pull operation. | 50830828-7d39-4367-b0eb-5ddb2de5faa5 | +| `data_type` | [DataType](../../models/shared/datatype.md) | :heavy_check_mark: | Available Data types | invoices | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about a transient or persistent error. | | +| `id` | *str* | :heavy_check_mark: | Unique identifier of the pull operation. | 943accd0-4247-42d8-865b-363c8629e1da | +| `is_completed` | *bool* | :heavy_check_mark: | `True` if the pull operation completed successfully. | | +| `is_errored` | *bool* | :heavy_check_mark: | `True` if the pull operation entered an error state. | | +| `progress` | *int* | :heavy_check_mark: | An integer signifying the progress of the pull operation. | | | `requested` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PullOperationStatus](../../models/shared/pulloperationstatus.md) | :heavy_check_mark: | N/A | Complete | \ No newline at end of file +| `status` | [PullOperationStatus](../../models/shared/pulloperationstatus.md) | :heavy_check_mark: | The current status of the pull operation. | Complete | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperations.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperations.md index afe4f6f90..e15916751 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperations.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperations.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[PullOperation](../../models/shared/pulloperation.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[PullOperation](../../models/shared/pulloperation.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperationstatus.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperationstatus.md index 12b8f9fd5..8f1bae914 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperationstatus.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pulloperationstatus.md @@ -1,5 +1,7 @@ # PullOperationStatus +The current status of the pull operation. + ## Values diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushchangetype.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushchangetype.md index 4818f5d2a..33a957e79 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushchangetype.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushchangetype.md @@ -1,5 +1,7 @@ # PushChangeType +Type of change being applied to record in third party platform. + ## Values diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperation.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperation.md index 8537a2c10..4e0594ecc 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperation.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperation.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationchange.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationchange.md index b57a9c8b9..cf6e86896 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationchange.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationchange.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `attachment_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `attachment_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the attachment created otherwise null. | | `record_ref` | [Optional[PushOperationRef]](../../models/shared/pushoperationref.md) | :heavy_minus_sign: | N/A | -| `type` | [Optional[PushChangeType]](../../models/shared/pushchangetype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [Optional[PushChangeType]](../../models/shared/pushchangetype.md) | :heavy_minus_sign: | Type of change being applied to record in third party platform. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationref.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationref.md index 10503c8ee..df895faa0 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationref.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationref.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a push operation. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperations.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperations.md index 83fd674fe..1f224ca9b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperations.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperations.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[PushOperation](../../models/shared/pushoperation.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[PushOperation](../../models/shared/pushoperation.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationstatus.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationstatus.md index 4125ba6a3..721aaa76b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationstatus.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/pushoperationstatus.md @@ -1,6 +1,6 @@ # PushOperationStatus -The status of the push operation. +The current status of the push operation. ## Values diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/sales.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/sales.md index fab1ec6ce..02dff2046 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/sales.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/sales.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `accounts` | dict[str, [ConfigAccount](../../models/shared/configaccount.md)] | :heavy_minus_sign: | N/A | +| `accounts` | Dict[str, [ConfigAccount](../../models/shared/configaccount.md)] | :heavy_minus_sign: | N/A | | `grouping` | [Optional[Grouping]](../../models/shared/grouping.md) | :heavy_minus_sign: | N/A | | `invoice_status` | [Optional[InvoiceStatus1]](../../models/shared/invoicestatus1.md) | :heavy_minus_sign: | N/A | | `new_tax_rates` | [Optional[NewTaxRates]](../../models/shared/newtaxrates.md) | :heavy_minus_sign: | N/A | | `sales_customer` | [Optional[Customer]](../../models/shared/customer.md) | :heavy_minus_sign: | N/A | | `sync_sales` | *Optional[bool]* | :heavy_minus_sign: | Boolean indicator for syncing sales. | -| `tax_rates` | dict[str, [TaxRateAmount](../../models/shared/taxrateamount.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `tax_rates` | Dict[str, [TaxRateAmount](../../models/shared/taxrateamount.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/servicecharge.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/servicecharge.md index b34fde1ec..c9cecc736 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/servicecharge.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/servicecharge.md @@ -9,6 +9,6 @@ | `quantity` | *Optional[int]* | :heavy_minus_sign: | The number of times the charge is charged. | 1 | | `tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of the service charge that is tax. | 0 | | `tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any tax applied to the service charge. | 0 | -| `taxes` | list[[ServiceChargeTaxComponentAllocation](../../models/shared/servicechargetaxcomponentallocation.md)] | :heavy_minus_sign: | Taxes breakdown as applied to service charges. | | -| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total service charge, including taxes. | 0 | +| `taxes` | List[[ServiceChargeTaxComponentAllocation](../../models/shared/servicechargetaxcomponentallocation.md)] | :heavy_minus_sign: | Taxes breakdown as applied to service charges. | | +| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the service charge, including tax. | 0 | | `type` | [Optional[ServiceChargeType]](../../models/shared/servicechargetype.md) | :heavy_minus_sign: | The type of the service charge. | Overpayment | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/supplementaldata.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/supplementaldata.md index f18fbb90d..f9d04fc2b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/supplementaldata.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/supplementaldata.md @@ -9,4 +9,4 @@ It is referenced as a configured dynamic key value pair that is unique to the ac | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `content` | dict[str, dict[str, *Any*]] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | Dict[str, Dict[str, *Any*]] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/supportedfeature.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/supportedfeature.md index 4b6bf1098..d6cce542e 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/supportedfeature.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/supportedfeature.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `feature_state` | [FeatureState](../../models/shared/featurestate.md) | :heavy_check_mark: | N/A | Release | -| `feature_type` | [FeatureType](../../models/shared/featuretype.md) | :heavy_check_mark: | N/A | Get | \ No newline at end of file +| `feature_state` | [FeatureState](../../models/shared/featurestate.md) | :heavy_check_mark: | The current release state of the feature. | Release | +| `feature_type` | [FeatureType](../../models/shared/featuretype.md) | :heavy_check_mark: | The type of feature. | Get | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/syncsummary.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/syncsummary.md index 5b7069538..a2341527b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/syncsummary.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/syncsummary.md @@ -7,7 +7,7 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `commerce_sync_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the sync in Codat. | 8d0a044e-b683-4fc9-bd0d-bfb2ca5731b7 | | `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | f4637ec9-9fc0-4a02-8df0-c90d6dc86208 | -| `data_connections` | list[[Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | Array of containing objects data connection information for the company. | | +| `data_connections` | List[[Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | Array of containing objects data connection information for the company. | | | `data_pushed` | *Optional[bool]* | :heavy_minus_sign: | Boolean indicator for data being pushed during a sync operation. | true | | `error_message` | *Optional[str]* | :heavy_minus_sign: | Friendly error message for the sync operation. | Customer 3b9bf2ed-a618-4af2-80f2-f2b57fddc748 is not in an Active state. (Archived) | | `sync_date_range_utc` | [Optional[DateRange]](../../models/shared/daterange.md) | :heavy_minus_sign: | N/A | | diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/taxrateamount.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/taxrateamount.md index 429a33381..2f16c9f90 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/taxrateamount.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/taxrateamount.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | `selected_tax_rate_id` | *Optional[str]* | :heavy_minus_sign: | Selected tax rate id from the list of tax rates on the accounting software. | -| `tax_rate_options` | list[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | Array of tax rate options object. | \ No newline at end of file +| `tax_rate_options` | List[[Option](../../models/shared/option.md)] | :heavy_minus_sign: | Array of tax rate options object. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/taxratemapping.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/taxratemapping.md index 930bc1f28..afc0849f1 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/taxratemapping.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/taxratemapping.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `selected_accounting_tax_rate_id` | *Optional[str]* | :heavy_minus_sign: | Selected tax rate id from the list of tax rates on the accounting software. | -| `selected_commerce_tax_rate_ids` | list[*str*] | :heavy_minus_sign: | Selected tax component id from the list of tax components on the commerce software. | \ No newline at end of file +| `selected_commerce_tax_rate_ids` | List[*str*] | :heavy_minus_sign: | Selected tax component id from the list of tax components on the commerce software. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/tracking.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/tracking.md index 35c19793a..1f311fb8c 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/tracking.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/tracking.md @@ -7,9 +7,9 @@ Categories, and a project and customer, against which the item is tracked. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `category_refs` | list[[TrackingCategoryRefsitems](../../models/shared/trackingcategoryrefsitems.md)] | :heavy_check_mark: | N/A | +| `category_refs` | List[[TrackingCategoryRefsitems](../../models/shared/trackingcategoryrefsitems.md)] | :heavy_check_mark: | N/A | | `customer_ref` | [Optional[AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | -| `is_billed_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | N/A | -| `is_rebilled_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | N/A | +| `is_billed_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | Defines if the bill or bill credit note is billed/rebilled to a project. | +| `is_rebilled_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | Defines if the bill or bill credit note is billed/rebilled to a project. | | `project_ref` | [Optional[TrackingProjectReference]](../../models/shared/trackingprojectreference.md) | :heavy_minus_sign: | N/A | | `record_ref` | [Optional[RecordRef]](../../models/shared/recordref.md) | :heavy_minus_sign: | Links the current record to the underlying record or data type that created it.

For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/trackingcategoryrefsitems.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/trackingcategoryrefsitems.md index 09d73345a..fe1cd373b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/trackingcategoryrefsitems.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/trackingcategoryrefsitems.md @@ -7,7 +7,7 @@ References a category against which the item is tracked. ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | Unique identifier to the tracking category. | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of tracking category. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/trackingprojectreference.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/trackingprojectreference.md index 54a9976f2..b0a213821 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/trackingprojectreference.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/trackingprojectreference.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | Unique identifier to the project reference. | +| `name` | *Optional[str]* | :heavy_minus_sign: | The project's name. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/transactionsourceref.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/transactionsourceref.md index f39387a85..5336242fc 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/transactionsourceref.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/transactionsourceref.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | The unique identitifer of the record being referenced | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `type` | [TransactionSourceType](../../models/shared/transactionsourcetype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [TransactionSourceType](../../models/shared/transactionsourcetype.md) | :heavy_check_mark: | The type of source the transaction arose. | | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/transactionsourcetype.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/transactionsourcetype.md index dc353aa07..1c0f09833 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/transactionsourcetype.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/transactionsourcetype.md @@ -1,5 +1,7 @@ # TransactionSourceType +The type of source the transaction arose. + ## Values diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/validation.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/validation.md index 196cb46c2..294281b51 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/validation.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/validation.md @@ -7,5 +7,5 @@ A human-readable object describing validation decisions Codat has made when push | Field | Type | Required | Description | | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `errors` | list[[ValidationItem](../../models/shared/validationitem.md)] | :heavy_minus_sign: | N/A | -| `warnings` | list[[ValidationItem](../../models/shared/validationitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `errors` | List[[ValidationItem](../../models/shared/validationitem.md)] | :heavy_minus_sign: | N/A | +| `warnings` | List[[ValidationItem](../../models/shared/validationitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/validationitem.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/validationitem.md index f3fb8b302..fe913f43e 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/validationitem.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/validationitem.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validator_name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| `item_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a validation item. | +| `message` | *Optional[str]* | :heavy_minus_sign: | A message outlining validation item's issue. | +| `validator_name` | *Optional[str]* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/visibleaccounts.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/visibleaccounts.md index e0c6f9690..a20221e02 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/visibleaccounts.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/visibleaccounts.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `visible_accounts` | list[*str*] | :heavy_minus_sign: | Visible accounts on sync flow. | \ No newline at end of file +| `visible_accounts` | List[*str*] | :heavy_minus_sign: | Visible accounts on sync flow. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/models/shared/withholdingtaxitems.md b/previous-versions/sync-for-commerce-version-1/docs/models/shared/withholdingtaxitems.md index 6a0c34fb3..d85196feb 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/models/shared/withholdingtaxitems.md +++ b/previous-versions/sync-for-commerce-version-1/docs/models/shared/withholdingtaxitems.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `amount` | *Decimal* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `amount` | *Decimal* | :heavy_check_mark: | Amount of tax withheld. | +| `name` | *str* | :heavy_check_mark: | Name assigned to withheld tax. | \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingaccounts/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingaccounts/README.md index 9bd41365e..738abd1ab 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingaccounts/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingaccounts/README.md @@ -1,4 +1,5 @@ -# accounting_accounts +# AccountingAccounts +(*accounting_accounts*) ## Overview @@ -38,40 +39,43 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.CreateAccountingAccountRequest( accounting_account=shared.AccountingAccount( - currency='EUR', + currency='GBP', current_balance=Decimal('0'), description='Invoices the business has issued but has not yet collected payment on.', fully_qualified_category='Asset.Current', fully_qualified_name='Cash On Hand', id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e', - is_bank_account=False, - metadata=shared.AccountingAccountMetadata( - is_deleted=False, - ), + metadata=shared.AccountingAccountMetadata(), modified_date='2022-10-23T00:00:00.000Z', name='Accounts Receivable', nominal_code='610', source_modified_date='2022-10-23T00:00:00.000Z', status=shared.AccountStatus.ACTIVE, + supplemental_data=shared.SupplementalData( + content={ + "Gasoline": { + "Wall": 'Oriental', + }, + }, + ), type=shared.AccountType.ASSET, valid_datatype_links=[ shared.AccountingAccountValidDataTypeLinks( links=[ - 'suscipit', + 'Intranet', ], - property='iure', ), ], ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=297534, ) res = s.accounting_accounts.create_accounting_account(req) if res.accounting_create_account_response is not None: # handle response + pass ``` ### Parameters @@ -111,7 +115,7 @@ s = codatsynccommerce.CodatSyncCommerce( ) req = operations.GetAccountingAccountRequest( - account_id='debitis', + account_id='Officer steer whoa', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -119,6 +123,7 @@ res = s.accounting_accounts.get_accounting_account(req) if res.accounting_account is not None: # handle response + pass ``` ### Parameters @@ -159,13 +164,13 @@ req = operations.ListAccountingAccountsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='ipsa', ) res = s.accounting_accounts.list_accounting_accounts(req) if res.accounting_accounts is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingbankaccounts/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingbankaccounts/README.md index bd78539a7..523c6e476 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingbankaccounts/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingbankaccounts/README.md @@ -1,4 +1,5 @@ -# accounting_bank_accounts +# AccountingBankAccounts +(*accounting_bank_accounts*) ## Overview @@ -33,7 +34,7 @@ s = codatsynccommerce.CodatSyncCommerce( ) req = operations.GetAccountingBankAccountRequest( - account_id='delectus', + account_id='optimal Buckinghamshire', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -42,6 +43,7 @@ res = s.accounting_bank_accounts.get_accounting_bank_account(req) if res.accounting_bank_account is not None: # handle response + pass ``` ### Parameters @@ -84,13 +86,13 @@ req = operations.ListAccountingBankAccountsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='tempora', ) res = s.accounting_bank_accounts.list_accounting_bank_accounts(req) if res.accounting_bank_accounts is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcompanyinfo/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcompanyinfo/README.md index 0392c767a..2ad167dfe 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcompanyinfo/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcompanyinfo/README.md @@ -1,4 +1,5 @@ -# accounting_company_info +# AccountingCompanyInfo +(*accounting_company_info*) ## Overview @@ -33,6 +34,7 @@ res = s.accounting_company_info.get_accounting_company_info(req) if res.accounting_company_dataset is not None: # handle response + pass ``` ### Parameters @@ -72,6 +74,7 @@ res = s.accounting_company_info.refresh(req) if res.dataset is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcreditnotes/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcreditnotes/README.md index 16e3b1128..fef1adfc8 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcreditnotes/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcreditnotes/README.md @@ -1,4 +1,5 @@ -# accounting_credit_notes +# AccountingCreditNotes +(*accounting_credit_notes*) ## Overview @@ -36,131 +37,92 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.CreateAccountingCreditNoteRequest( accounting_credit_note=shared.AccountingCreditNote( - additional_tax_amount=Decimal('3834.41'), - additional_tax_percentage=Decimal('4776.65'), allocated_on_date='2022-10-23T00:00:00.000Z', - credit_note_number='placeat', - currency='USD', - currency_rate=Decimal('4799.77'), + currency='GBP', customer_ref=shared.AccountingCustomerRef( - company_name='excepturi', - id='6ed151a0-5dfc-42dd-b7cc-78ca1ba928fc', + id='', ), - discount_percentage=Decimal('5218.48'), - id='16742cb7-3920-4592-9396-fea7596eb10f', + discount_percentage=Decimal('3961.39'), issue_date='2022-10-23T00:00:00.000Z', line_items=[ shared.CreditNoteLineItem( - account_ref=shared.AccountRef( - id='aa2352c5-9559-407a-bf1a-3a2fa9467739', - name='Beatrice Brown', - ), - description='enim', - discount_amount=Decimal('1381.83'), - discount_percentage=Decimal('7783.46'), - is_direct_income=False, + account_ref=shared.AccountRef(), item_ref=shared.ItemRef( - id='3f5ad019-da1f-4fe7-8f09-7b0074f15471', - name='Bill Thompson', - ), - quantity=Decimal('641.47'), - sub_total=Decimal('2168.22'), - tax_amount=Decimal('6924.72'), - tax_rate_ref=shared.TaxRateRef( - effective_tax_rate=Decimal('5651.89'), - id='9d488e1e-91e4-450a-92ab-d44269802d50', - name='Sonya Marks', + id='', ), - total_amount=Decimal('7351.94'), + quantity=Decimal('1740.95'), + tax_rate_ref=shared.TaxRateRef(), tracking=shared.CreditNoteLineItemTracking( category_refs=[ shared.TrackingCategoryRefsitems( - id='4f63c969-e9a3-4efa-b7df-b14cd66ae395', - name='Toby Pouros', + id='', ), ], customer_ref=shared.AccountingCustomerRef( - company_name='id', - id='88f3a669-9707-44ba-8469-b6e214195989', + id='', ), - is_billed_to=shared.BilledToType.UNKNOWN, - is_rebilled_to=shared.BilledToType.NOT_APPLICABLE, + is_billed_to=shared.BilledToType.PROJECT, + is_rebilled_to=shared.BilledToType.PROJECT, project_ref=shared.CreditNoteLineItemTrackingProjectReference( - id='fa563e25-16fe-44c8-b711-e5b7fd2ed028', - name='Victor Casper', + id='', ), record_ref=shared.RecordRef( - data_type='transfer', - id='c692601f-b576-4b0d-9f0d-30c5fbb25870', + data_type='accountTransaction', ), ), tracking_category_refs=[ shared.TrackingCategoryRefsitems( - id='53202c73-d5fe-49b9-8c28-909b3fe49a8d', - name='Loren Renner', + id='', ), ], - unit_amount=Decimal('5542.42'), + unit_amount=Decimal('6472.07'), ), ], - metadata=shared.Metadata( - is_deleted=False, - ), + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', - note='dolorem', payment_allocations=[ shared.PaymentAllocationsitems( allocation=shared.ItemsAllocation( allocated_on_date='2022-10-23T00:00:00.000Z', - currency='GBP', - currency_rate=Decimal('1861.93'), - total_amount=Decimal('2187.49'), + currency='EUR', ), payment=shared.PaymentAllocationPayment( - account_ref=shared.AccountRef( - id='f9b77f3a-4100-4674-abf6-9280d1ba77a8', - name='Terence Rau', - ), - currency='GBP', - currency_rate=Decimal('4560.15'), - id='ae4203ce-5e6a-495d-8a0d-446ce2af7a73', - note='quisquam', + account_ref=shared.AccountRef(), + currency='USD', paid_on_date='2022-10-23T00:00:00.000Z', - reference='amet', - total_amount=Decimal('7308.56'), ), ), ], - remaining_credit=Decimal('8802.98'), + remaining_credit=Decimal('3693.65'), source_modified_date='2022-10-23T00:00:00.000Z', - status=shared.CreditNoteStatus.DRAFT, - sub_total=Decimal('2133.12'), + status=shared.CreditNoteStatus.VOID, + sub_total=Decimal('1915.04'), supplemental_data=shared.SupplementalData( content={ - "sapiente": { - "totam": 'nihil', + "Metal": { + "policy": 'although', }, }, ), - total_amount=Decimal('256.62'), - total_discount=Decimal('7115.84'), - total_tax_amount=Decimal('2074.7'), + total_amount=Decimal('6437.49'), + total_discount=Decimal('6593.55'), + total_tax_amount=Decimal('3629.12'), withholding_tax=[ shared.WithholdingTaxitems( - amount=Decimal('1536.94'), - name='Kelli Hintz', + amount=Decimal('5655.86'), + name='however', ), ], ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=214880, ) res = s.accounting_credit_notes.create_accounting_credit_note(req) if res.accounting_create_credit_note_response is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcustomers/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcustomers/README.md index 9c5bc9ca7..4bf7caf39 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcustomers/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingcustomers/README.md @@ -1,4 +1,5 @@ -# accounting_customers +# AccountingCustomers +(*accounting_customers*) ## Overview @@ -37,69 +38,46 @@ req = operations.CreateAccountingCustomerRequest( accounting_customer=shared.AccountingCustomer( addresses=[ shared.Items1( - city='East Kylie', - country='Slovakia (Slovak Republic)', - line1='pariatur', - line2='soluta', - postal_code='65211', - region='distinctio', type=shared.AccountingAddressType.DELIVERY, ), ], - contact_name='aliquid', contacts=[ shared.Contact( address=shared.Items1( - city='Kennedyhaven', - country='Christmas Island', - line1='neque', - line2='fugit', - postal_code='41379', - region='voluptatem', - type=shared.AccountingAddressType.DELIVERY, + type=shared.AccountingAddressType.UNKNOWN, ), - email='Nella.Bosco8@hotmail.com', modified_date='2022-10-23T00:00:00.000Z', - name='Dr. Randolph McDermott', phone=[ shared.PhoneNumbersitems( number='+44 25691 154789', - type=shared.PhoneNumberType.LANDLINE, + type=shared.PhoneNumberType.PRIMARY, ), ], - status=shared.CustomerStatus.UNKNOWN, + status=shared.CustomerStatus.ACTIVE, ), ], - customer_name='dolorum', default_currency='GBP', - email_address='quae', - id='08e0adcf-4b92-4187-9fce-953f73ef7fbc', - metadata=shared.Metadata( - is_deleted=False, - ), + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', - phone='1-784-488-1670 x9381', - registration_number='porro', source_modified_date='2022-10-23T00:00:00.000Z', - status=shared.CustomerStatus.ARCHIVED, + status=shared.CustomerStatus.UNKNOWN, supplemental_data=shared.SupplementalData( content={ - "iusto": { - "eligendi": 'ducimus', + "California": { + "systems": 'North', }, }, ), - tax_number='alias', ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=639473, ) res = s.accounting_customers.create_accounting_customer(req) if res.accounting_create_customer_response is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingdirectincomes/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingdirectincomes/README.md index e319c75f9..b89f1fc10 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingdirectincomes/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingdirectincomes/README.md @@ -1,4 +1,5 @@ -# accounting_direct_incomes +# AccountingDirectIncomes +(*accounting_direct_incomes*) ## Overview @@ -37,94 +38,63 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.CreateAccountingDirectIncomeRequest( accounting_direct_income=shared.AccountingDirectIncome( contact_ref=shared.AccountingDirectIncomeContactRef( - data_type='tempora', - id='5626d436-813f-416d-9f5f-ce6c556146c3', + data_type=shared.DataType.INVOICES, + id='', ), - currency='EUR', - currency_rate=Decimal('1324.87'), - id='50fb008c-42e1-441a-ac36-6c8dd6b14429', + currency='GBP', issue_date='2022-10-23T00:00:00.000Z', line_items=[ shared.DirectIncomeLineItem( - account_ref=shared.AccountRef( - id='7474778a-7bd4-466d-a8c1-0ab3cdca4251', - name='William Goodwin', - ), - description='aspernatur', - discount_amount=Decimal('1970.54'), - discount_percentage=Decimal('7791.92'), + account_ref=shared.AccountRef(), item_ref=shared.DirectIncomeLineItemItemReference( - id='7e0bc717-8e47-496f-aa70-c688282aa482', - name='Sue Corkery', - ), - quantity=Decimal('1871.31'), - sub_total=Decimal('1294.12'), - tax_amount=Decimal('9039.84'), - tax_rate_ref=shared.DirectIncomeLineItemTaxRateReference( - effective_tax_rate=Decimal('5789.22'), - id='817ee17c-be61-4e6b-bb95-bc0ab3c20c4f', - name='Joy Labadie', + id='', ), - total_amount=Decimal('8577.23'), + quantity=Decimal('3642.55'), + tax_rate_ref=shared.DirectIncomeLineItemTaxRateReference(), tracking_category_refs=[ shared.DirectIncomeLineItemTrackingCategoryRefs( - id='871f99dd-2efd-4121-aa6f-1e674bdb04f1', - name='Delores Hermiston IV', + id='', ), ], - unit_amount=Decimal('1852.32'), + unit_amount=Decimal('7950.78'), ), ], - metadata=shared.Metadata( - is_deleted=False, - ), + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', - note='ex', payment_allocations=[ shared.PaymentAllocationsitems( allocation=shared.ItemsAllocation( allocated_on_date='2022-10-23T00:00:00.000Z', currency='EUR', - currency_rate=Decimal('6802.7'), - total_amount=Decimal('996.15'), ), payment=shared.PaymentAllocationPayment( - account_ref=shared.AccountRef( - id='9f1d1705-1339-4d08-886a-1840394c2607', - name='Elisa Mosciski', - ), + account_ref=shared.AccountRef(), currency='USD', - currency_rate=Decimal('9903.45'), - id='0642dac7-af51-45cc-813a-a63aae8d6786', - note='labore', paid_on_date='2022-10-23T00:00:00.000Z', - reference='facilis', - total_amount=Decimal('7382.27'), ), ), ], - reference='commodi', source_modified_date='2022-10-23T00:00:00.000Z', - sub_total=Decimal('3605.45'), + sub_total=Decimal('5786.44'), supplemental_data=shared.SupplementalData( content={ - "reiciendis": { - "assumenda": 'nemo', + "Tactics": { + "duh": 'East', }, }, ), - tax_amount=Decimal('9249.67'), - total_amount=Decimal('3975.33'), + tax_amount=Decimal('2940.98'), + total_amount=Decimal('8825.39'), ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=46007, ) res = s.accounting_direct_incomes.create_accounting_direct_income(req) if res.accounting_create_direct_income_response is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountinginvoices/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountinginvoices/README.md index 364c549a7..1e2959b64 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountinginvoices/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountinginvoices/README.md @@ -1,4 +1,5 @@ -# accounting_invoices +# AccountingInvoices +(*accounting_invoices*) ## Overview @@ -36,138 +37,95 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.CreateAccountingInvoiceRequest( accounting_invoice=shared.AccountingInvoice( - additional_tax_amount=Decimal('7386.83'), - additional_tax_percentage=Decimal('2326.27'), - amount_due=Decimal('4490.83'), - currency='USD', - currency_rate=Decimal('9372.85'), + amount_due=Decimal('9907.57'), + currency='EUR', customer_ref=shared.AccountingCustomerRef( - company_name='facere', - id='4f6fbee4-1f33-4317-be35-b60eb1ea4265', + id='', ), - discount_percentage=Decimal('3742.96'), due_date='2022-10-23T00:00:00.000Z', - id='ba3c2874-4ed5-43b8-8f3a-8d8f5c0b2f2f', - invoice_number='facilis', issue_date='2022-10-23T00:00:00.000Z', line_items=[ shared.InvoiceLineItem( - account_ref=shared.AccountRef( - id='b194a276-b269-416f-a1f0-8f4294e3698f', - name='Rhonda Klocko', - ), - description='sit', - discount_amount=Decimal('2484.13'), - discount_percentage=Decimal('8880.44'), - is_direct_income=False, + account_ref=shared.AccountRef(), item_ref=shared.ItemRef( - id='8b445e80-ca55-4efd-a0e4-57e1858b6a89', - name='Rudolph Trantow', - ), - quantity=Decimal('3416.98'), - sub_total=Decimal('6390.28'), - tax_amount=Decimal('6762.43'), - tax_rate_ref=shared.TaxRateRef( - effective_tax_rate=Decimal('5483.61'), - id='e4824d0a-b407-4508-8e51-862065e904f3', - name='Gerald Bradtke', + id='', ), - total_amount=Decimal('6952.7'), + quantity=Decimal('1021.57'), + tax_rate_ref=shared.TaxRateRef(), tracking=shared.Tracking( category_refs=[ shared.TrackingCategoryRefsitems( - id='8abf603a-79f9-4dfe-8ab7-da8a50ce187f', - name='Sam Powlowski IV', + id='', ), ], customer_ref=shared.AccountingCustomerRef( - company_name='amet', - id='d689eee9-526f-48d9-86e8-81ead4f0e101', + id='', ), is_billed_to=shared.BilledToType.UNKNOWN, - is_rebilled_to=shared.BilledToType.UNKNOWN, + is_rebilled_to=shared.BilledToType.PROJECT, project_ref=shared.TrackingProjectReference( - id='63f94e29-e973-4e92-aa57-a15be3e06080', - name='Tricia Denesik', + id='', ), record_ref=shared.RecordRef( - data_type='transfer', - id='3ab8845f-0597-4a60-bf2a-54a31e94764a', + data_type='journalEntry', ), ), tracking_category_refs=[ shared.TrackingCategoryRefsitems( - id='3e865e79-56f9-4251-a5a9-da660ff57bfa', - name='Irving Gleichner', + id='', ), ], - unit_amount=Decimal('8897.94'), + unit_amount=Decimal('7432.38'), ), ], - metadata=shared.Metadata( - is_deleted=False, - ), + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', - note='cumque', paid_on_date='2022-10-23T00:00:00.000Z', payment_allocations=[ shared.AccountingInvoicePaymentAllocation( allocation=shared.AccountingInvoicePaymentAllocationAllocation( allocated_on_date='2022-10-23T00:00:00.000Z', - currency='GBP', - currency_rate=Decimal('3354.98'), - total_amount=Decimal('820.57'), + currency='USD', ), payment=shared.PaymentAllocationPayment( - account_ref=shared.AccountRef( - id='2c103264-8dc2-4f61-9199-ebfd0e9fe6c6', - name='Denise Runolfsdottir', - ), - currency='USD', - currency_rate=Decimal('8987.6'), - id='d0117996-312f-4de0-8771-778ff61d0174', - note='esse', + account_ref=shared.AccountRef(), + currency='EUR', paid_on_date='2022-10-23T00:00:00.000Z', - reference='consectetur', - total_amount=Decimal('3998.12'), ), ), ], sales_order_refs=[ shared.AccountingInvoiceSalesOrderReference( - data_type='ipsa', - id='a15db6a6-6065-49a1-adea-ab5851d6c645', + data_type=shared.DataType.INVOICES, ), ], source_modified_date='2022-10-23T00:00:00.000Z', - status=shared.InvoiceStatus.UNKNOWN, - sub_total=Decimal('5615.77'), + status=shared.InvoiceStatus.PARTIALLY_PAID, supplemental_data=shared.SupplementalData( content={ - "cum": { - "aliquid": 'beatae', + "Beier": { + "boo": 'Regional', }, }, ), - total_amount=Decimal('5308.6'), - total_discount=Decimal('6063.08'), - total_tax_amount=Decimal('852.33'), + total_amount=Decimal('1895.83'), + total_tax_amount=Decimal('7283.9'), withholding_tax=[ shared.AccountingInvoiceWithholdingTax( - amount=Decimal('7032.18'), - name='Trevor Bartell', + amount=Decimal('1357.13'), + name='Gasoline Interactions Cisgender', ), ], ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=103298, ) res = s.accounting_invoices.create_accounting_invoice(req) if res.accounting_create_invoice_response is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingjournalentries/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingjournalentries/README.md index 96b2307c4..0502ff8b9 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingjournalentries/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingjournalentries/README.md @@ -1,4 +1,5 @@ -# accounting_journal_entries +# AccountingJournalEntries +(*accounting_journal_entries*) ## Overview @@ -37,45 +38,33 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.CreateAccountingJournalEntryRequest( accounting_journal_entry=shared.AccountingJournalEntry( created_on='2022-10-23T00:00:00.000Z', - description='pariatur', - id='e008e6f8-c5f3-450d-8cdb-5a3418143010', journal_lines=[ shared.JournalLine( - account_ref=shared.AccountRef( - id='421813d5-208e-4ce7-a253-b668451c6c6e', - name='Helen Heller III', - ), - currency='at', - description='vero', - net_amount=Decimal('6675.93'), + account_ref=shared.AccountRef(), + net_amount=Decimal('9326.53'), tracking=shared.JournalLineTracking( record_refs=[ shared.RecordRef( - data_type='accountTransaction', - id='3fec9578-a645-4842-b3a8-418d162309fb', + data_type='journalEntry', ), ], ), ), ], journal_ref=shared.AccountingJournalEntryJournalReference( - id='0929921a-efb9-4f58-84d8-6e68e4be0560', - name='Sheila Wolff', - ), - metadata=shared.Metadata( - is_deleted=False, + id='', ), + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', posted_on='2022-10-23T00:00:00.000Z', record_ref=shared.AccountingJournalEntryRecordReference( - data_type='invoice', - id='57a59ecf-ef66-4ef1-8aa3-383c2beb4773', + data_type='journalEntry', ), source_modified_date='2022-10-23T00:00:00.000Z', supplemental_data=shared.SupplementalData( content={ - "neque": { - "quo": 'deleniti', + "Minivan": { + "bypassing": 'Investor', }, }, ), @@ -83,13 +72,13 @@ req = operations.CreateAccountingJournalEntryRequest( ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=437814, ) res = s.accounting_journal_entries.create_accounting_journal_entry(req) if res.accounting_create_journal_entry_response is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingpayments/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingpayments/README.md index 9570fa3c0..73e7a54c4 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingpayments/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/accountingpayments/README.md @@ -1,4 +1,5 @@ -# accounting_payments +# AccountingPayments +(*accounting_payments*) ## Overview @@ -36,58 +37,46 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.CreateAccountingPaymentRequest( accounting_payment=shared.AccountingPayment( - account_ref=shared.AccountRef( - id='2f64d1db-1f2c-4431-8661-e96349e1cf9e', - name='Alma Waters', - ), - currency='GBP', - currency_rate=Decimal('2244.67'), + account_ref=shared.AccountRef(), + currency='EUR', customer_ref=shared.AccountingCustomerRef( - company_name='iusto', - id='000ae6b6-bc9b-48f7-99ea-c55a9741d311', + id='', ), date_='2022-10-23T00:00:00.000Z', - id='52965bb8-a720-4261-9435-e139dbc2259b', lines=[ shared.PaymentLine( allocated_on_date='2022-10-23T00:00:00.000Z', - amount=Decimal('6633.18'), + amount=Decimal('9211.94'), links=[ shared.PaymentLineLink( - amount=Decimal('7278.88'), - currency_rate=Decimal('8544.6'), - id='a8c070e1-084c-4b06-b2d1-ad879eeb9665', - type=shared.PaymentLinkType.PAYMENT_ON_ACCOUNT, + type=shared.PaymentLinkType.UNLINKED, ), ], ), ], - metadata=shared.Metadata( - is_deleted=False, - ), + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', - note='corporis', - payment_method_ref='officiis', - reference='voluptatibus', + payment_method_ref=shared.PaymentMethodRef( + id='', + ), source_modified_date='2022-10-23T00:00:00.000Z', supplemental_data=shared.SupplementalData( content={ - "at": { - "alias": 'quia', + "Diesel": { + "property": 'Reduced', }, }, ), - total_amount=Decimal('6941.58'), ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=684126, ) res = s.accounting_payments.create_accounting_payment(req) if res.accounting_create_payment_response is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/codatsynccommerce/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/codatsynccommerce/README.md index 672c06865..a54faa6a7 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/codatsynccommerce/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/codatsynccommerce/README.md @@ -1,5 +1,6 @@ # CodatSyncCommerce SDK + ## Overview Sync for Commerce (v1): The API for Sync for Commerce V1. diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/commercecompanyinfo/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/commercecompanyinfo/README.md index 57a35c66a..ad6e93972 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/commercecompanyinfo/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/commercecompanyinfo/README.md @@ -1,4 +1,5 @@ -# commerce_company_info +# CommerceCompanyInfo +(*commerce_company_info*) ## Overview @@ -35,6 +36,7 @@ res = s.commerce_company_info.get_commerce_company_info(req) if res.commerce_company_info is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/commercecustomers/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/commercecustomers/README.md index d3da822e2..fa8555c40 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/commercecustomers/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/commercecustomers/README.md @@ -1,4 +1,5 @@ -# commerce_customers +# CommerceCustomers +(*commerce_customers*) ## Overview @@ -35,13 +36,14 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.GetCommerceCustomerRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - customer_id='repudiandae', + customer_id='contingency', ) res = s.commerce_customers.get_commerce_customer(req) if res.commerce_customer is not None: # handle response + pass ``` ### Parameters @@ -84,13 +86,13 @@ req = operations.ListCommerceCustomersRequest( order_by='-modifiedDate', page=1, page_size=100, - query='accusantium', ) res = s.commerce_customers.list_commerce_customers(req) if res.commerce_customers is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/commercelocations/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/commercelocations/README.md index 50f37afc0..ef491f56f 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/commercelocations/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/commercelocations/README.md @@ -1,4 +1,5 @@ -# commerce_locations +# CommerceLocations +(*commerce_locations*) ## Overview @@ -35,13 +36,14 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.GetCommerceLocationRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - location_id='expedita', + location_id='iusto Shoes', ) res = s.commerce_locations.get_commerce_location(req) if res.commerce_location is not None: # handle response + pass ``` ### Parameters @@ -87,6 +89,7 @@ res = s.commerce_locations.list_commerce_locations(req) if res.commerce_locations is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/commerceorders/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/commerceorders/README.md index 7377a1cc7..12cc4a319 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/commerceorders/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/commerceorders/README.md @@ -1,4 +1,5 @@ -# commerce_orders +# CommerceOrders +(*commerce_orders*) ## Overview @@ -35,13 +36,14 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.GetCommerceOrderRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - order_id='officiis', + order_id='Borders outside', ) res = s.commerce_orders.get_commerce_order(req) if res.commerce_order is not None: # handle response + pass ``` ### Parameters @@ -84,13 +86,13 @@ req = operations.ListCommerceOrdersRequest( order_by='-modifiedDate', page=1, page_size=100, - query='eos', ) res = s.commerce_orders.list_commerce_orders(req) if res.commerce_orders is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/commercepayments/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/commercepayments/README.md index d36c64bd2..a80a94251 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/commercepayments/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/commercepayments/README.md @@ -1,4 +1,5 @@ -# commerce_payments +# CommercePayments +(*commerce_payments*) ## Overview @@ -37,13 +38,14 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.GetCommercePaymentRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - payment_id='quibusdam', + payment_id='Chief Music', ) res = s.commerce_payments.get_commerce_payment(req) if res.commerce_payment is not None: # handle response + pass ``` ### Parameters @@ -85,13 +87,14 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.GetCommercePaymentMethodRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - payment_method_id='odio', + payment_method_id='Markets', ) res = s.commerce_payments.get_method(req) if res.commerce_payment_method is not None: # handle response + pass ``` ### Parameters @@ -134,13 +137,13 @@ req = operations.ListCommercePaymentsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='praesentium', ) res = s.commerce_payments.list_commerce_payments(req) if res.commerce_payments is not None: # handle response + pass ``` ### Parameters @@ -183,13 +186,13 @@ req = operations.ListCommercePaymentMethodsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='odit', ) res = s.commerce_payments.list_methods(req) if res.commerce_payment_methods is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/commerceproducts/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/commerceproducts/README.md index 2a51b6706..697794ff6 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/commerceproducts/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/commerceproducts/README.md @@ -1,4 +1,5 @@ -# commerce_products +# CommerceProducts +(*commerce_products*) ## Overview @@ -35,13 +36,14 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.GetCommerceProductRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - product_id='explicabo', + product_id='Pierce connect Missouri', ) res = s.commerce_products.get_commerce_product(req) if res.commerce_product is not None: # handle response + pass ``` ### Parameters @@ -84,13 +86,13 @@ req = operations.ListCommerceProductsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='corporis', ) res = s.commerce_products.list_commerce_products(req) if res.commerce_products is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/commercetransactions/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/commercetransactions/README.md index 76cf79cc1..91a7d4a4f 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/commercetransactions/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/commercetransactions/README.md @@ -1,4 +1,5 @@ -# commerce_transactions +# CommerceTransactions +(*commerce_transactions*) ## Overview @@ -35,13 +36,14 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.GetCommerceTransactionRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - transaction_id='error', + transaction_id='West Infrastructure', ) res = s.commerce_transactions.get_commerce_transaction(req) if res.commerce_transaction is not None: # handle response + pass ``` ### Parameters @@ -84,13 +86,13 @@ req = operations.ListCommerceTransactionsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='earum', ) res = s.commerce_transactions.list_commerce_transactions(req) if res.commerce_transactions is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/companies/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/companies/README.md index 82e7e74dc..8c193cb24 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/companies/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/companies/README.md @@ -1,4 +1,5 @@ -# companies +# Companies +(*companies*) ## Overview @@ -35,6 +36,7 @@ res = s.companies.delete_company(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -74,6 +76,7 @@ res = s.companies.get_company(req) if res.company is not None: # handle response + pass ``` ### Parameters @@ -117,6 +120,7 @@ res = s.companies.update_company(req) if res.company is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/companymanagement/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/companymanagement/README.md index 9e5a03483..60dde0c89 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/companymanagement/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/companymanagement/README.md @@ -1,4 +1,5 @@ -# company_management +# CompanyManagement +(*company_management*) ## Overview @@ -6,7 +7,7 @@ Create new and manage existing Sync for Commerce companies. ### Available Operations -* [create_company](#create_company) - Create Sync for Commerce company +* [create_company](#create_company) - Create sync for commerce company * [create_connection](#create_connection) - Create connection * [list_companies](#list_companies) - List companies * [list_connections](#list_connections) - List data connections @@ -37,6 +38,7 @@ res = s.company_management.create_company(req) if res.company is not None: # handle response + pass ``` ### Parameters @@ -69,7 +71,6 @@ s = codatsynccommerce.CodatSyncCommerce( ) req = operations.CreateConnectionRequest( - request_body='adipisci', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -77,6 +78,7 @@ res = s.company_management.create_connection(req) if res.connection is not None: # handle response + pass ``` ### Parameters @@ -112,13 +114,13 @@ req = operations.ListCompaniesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='recusandae', ) res = s.company_management.list_companies(req) if res.companies is not None: # handle response + pass ``` ### Parameters @@ -155,13 +157,13 @@ req = operations.ListConnectionsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='similique', ) res = s.company_management.list_connections(req) if res.connections is not None: # handle response + pass ``` ### Parameters @@ -194,9 +196,7 @@ s = codatsynccommerce.CodatSyncCommerce( ) req = operations.UpdateConnectionRequest( - update_connection=shared.UpdateConnection( - status=shared.DataConnectionStatus.LINKED, - ), + update_connection=shared.UpdateConnection(), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -205,6 +205,7 @@ res = s.company_management.update_connection(req) if res.connection is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/configuration/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/configuration/README.md index 495da0073..c767db18b 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/configuration/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/configuration/README.md @@ -1,4 +1,5 @@ -# configuration +# Configuration +(*configuration*) ## Overview @@ -6,8 +7,8 @@ Expressively configure preferences for any given Sync for Commerce company. ### Available Operations -* [get_configuration](#get_configuration) - Retrieve config preferences set for a company. -* [set_configuration](#set_configuration) - Create or update configuration. +* [get_configuration](#get_configuration) - Retrieve config preferences set for a company +* [set_configuration](#set_configuration) - Create or update configuration ## get_configuration @@ -33,6 +34,7 @@ res = s.configuration.get_configuration(req) if res.configuration is not None: # handle response + pass ``` ### Parameters @@ -72,6 +74,7 @@ res = s.configuration.set_configuration(req) if res.configuration is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/connections/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/connections/README.md index a6d66542d..a4c3421f5 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/connections/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/connections/README.md @@ -1,4 +1,5 @@ -# connections +# Connections +(*connections*) ## Overview @@ -36,6 +37,7 @@ res = s.connections.delete_connection(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -76,6 +78,7 @@ res = s.connections.get_connection(req) if res.connection is not None: # handle response + pass ``` ### Parameters @@ -108,9 +111,7 @@ s = codatsynccommerce.CodatSyncCommerce( ) req = operations.UnlinkConnectionRequest( - update_connection=shared.UpdateConnection( - status=shared.DataConnectionStatus.UNLINKED, - ), + update_connection=shared.UpdateConnection(), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -119,6 +120,7 @@ res = s.connections.unlink(req) if res.connection is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/integrations/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/integrations/README.md index 438b4dc63..7ca13fa19 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/integrations/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/integrations/README.md @@ -1,4 +1,5 @@ -# integrations +# Integrations +(*integrations*) ## Overview @@ -7,7 +8,7 @@ View useful information about codat's integrations. ### Available Operations * [get_integration_branding](#get_integration_branding) - Get branding for an integration -* [list_integrations](#list_integrations) - List information on Codat's supported integrations +* [list_integrations](#list_integrations) - List integrations ## get_integration_branding @@ -26,13 +27,14 @@ s = codatsynccommerce.CodatSyncCommerce( ) req = operations.GetIntegrationBrandingRequest( - platform_key='quis', + platform_key='gbol', ) res = s.integrations.get_integration_branding(req) if res.branding is not None: # handle response + pass ``` ### Parameters @@ -68,13 +70,13 @@ req = operations.ListIntegrationsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='beatae', ) res = s.integrations.list_integrations(req) if res.integrations is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/pushdata/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/pushdata/README.md index e245f6ff2..f3e4f7698 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/pushdata/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/pushdata/README.md @@ -1,4 +1,5 @@ -# push_data +# PushData +(*push_data*) ## Overview @@ -27,13 +28,14 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.GetPushOperationRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - push_operation_key='97f92443-da7c-4e52-b895-c537c6454efb', + push_operation_key='59acd79e-29d3-4138-91d3-91d4641bf7ed', ) res = s.push_data.get_operation(req) if res.push_operation is not None: # handle response + pass ``` ### Parameters @@ -70,13 +72,13 @@ req = operations.GetCompanyPushHistoryRequest( order_by='-modifiedDate', page=1, page_size=100, - query='aperiam', ) res = s.push_data.list_operations(req) if res.push_operations is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/refreshdata/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/refreshdata/README.md index 36c3e3f8b..87d02e8b3 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/refreshdata/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/refreshdata/README.md @@ -1,4 +1,5 @@ -# refresh_data +# RefreshData +(*refresh_data*) ## Overview @@ -40,6 +41,7 @@ res = s.refresh_data.all(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -75,7 +77,6 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.RefreshDataTypeRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - connection_id='b34896c3-ca5a-4cfb-a2fd-570757792917', data_type=shared.DataType.INVOICES, ) @@ -83,6 +84,7 @@ res = s.refresh_data.by_data_type(req) if res.pull_operation is not None: # handle response + pass ``` ### Parameters @@ -122,6 +124,7 @@ res = s.refresh_data.get_company_data_status(req) if res.data_status_response is not None: # handle response + pass ``` ### Parameters @@ -155,13 +158,14 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.GetPullOperationRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - dataset_id='eaed9f0f-e77b-4bc9-a58f-ab8b4b99ab18', + dataset_id='7911a54a-c808-4f4b-b87e-b195f52b4da5', ) res = s.refresh_data.get_pull_operation(req) if res.pull_operation is not None: # handle response + pass ``` ### Parameters @@ -198,13 +202,13 @@ req = operations.ListPullOperationsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='voluptate', ) res = s.refresh_data.list_pull_operations(req) if res.pull_operations is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/sync/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/sync/README.md index 1c4fd3d81..baf09764c 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/sync/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/sync/README.md @@ -1,4 +1,5 @@ -# sync +# Sync +(*sync*) ## Overview @@ -34,6 +35,7 @@ res = s.sync.get_sync_status(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -77,6 +79,7 @@ res = s.sync.request_sync(req) if res.sync_summary is not None: # handle response + pass ``` ### Parameters @@ -122,6 +125,7 @@ res = s.sync.request_sync_for_date_range(req) if res.sync_summary is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/docs/sdks/syncflowpreferences/README.md b/previous-versions/sync-for-commerce-version-1/docs/sdks/syncflowpreferences/README.md index fd8876590..7faaf3d35 100755 --- a/previous-versions/sync-for-commerce-version-1/docs/sdks/syncflowpreferences/README.md +++ b/previous-versions/sync-for-commerce-version-1/docs/sdks/syncflowpreferences/README.md @@ -1,4 +1,5 @@ -# sync_flow_preferences +# SyncFlowPreferences +(*sync_flow_preferences*) ## Overview @@ -6,11 +7,11 @@ Configure preferences for any given Sync for Commerce company using sync flow. ### Available Operations -* [get_config_text_sync_flow](#get_config_text_sync_flow) - Retrieve preferences for text fields on Sync Flow +* [get_config_text_sync_flow](#get_config_text_sync_flow) - Retrieve preferences for text fields on sync flow * [get_sync_flow_url](#get_sync_flow_url) - Retrieve sync flow url * [get_visible_accounts](#get_visible_accounts) - List visible accounts * [update_config_text_sync_flow](#update_config_text_sync_flow) - Update preferences for text fields on sync flow -* [update_visible_accounts_sync_flow](#update_visible_accounts_sync_flow) - Update the visible accounts on Sync Flow +* [update_visible_accounts_sync_flow](#update_visible_accounts_sync_flow) - Update the visible accounts on sync flow ## get_config_text_sync_flow @@ -33,6 +34,7 @@ res = s.sync_flow_preferences.get_config_text_sync_flow() if res.localization_info is not None: # handle response + pass ``` ### Parameters @@ -64,15 +66,15 @@ s = codatsynccommerce.CodatSyncCommerce( ) req = operations.GetSyncFlowURLRequest( - accounting_key='optio', - commerce_key='ex', - merchant_identifier='quaerat', + accounting_key='Manager', + commerce_key='payment', ) res = s.sync_flow_preferences.get_sync_flow_url(req) if res.sync_flow_url is not None: # handle response + pass ``` ### Parameters @@ -105,14 +107,15 @@ s = codatsynccommerce.CodatSyncCommerce( ) req = operations.GetVisibleAccountsRequest( - client_id='6ecb5734-09e3-4eb1-a5a2-b12eb07f116d', - platform_key='b99545fc-95fa-4889-b0e1-89dbb30fcb33', + client_id='86fe9741-738d-4f2c-8e96-9c3f84156e91', + platform_key='gbol', ) res = s.sync_flow_preferences.get_visible_accounts(req) if res.visible_accounts is not None: # handle response + pass ``` ### Parameters @@ -145,23 +148,21 @@ s = codatsynccommerce.CodatSyncCommerce( ) req = { - "saepe": shared.Localization( - required=False, - text='deserunt', - ), + "West": shared.Localization(), } res = s.sync_flow_preferences.update_config_text_sync_flow(req) if res.localization_info is not None: # handle response + pass ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `request` | [dict[str, shared.Localization]](../../models//.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [Dict[str, shared.Localization]](../../models//.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | @@ -189,16 +190,17 @@ s = codatsynccommerce.CodatSyncCommerce( req = operations.UpdateVisibleAccountsSyncFlowRequest( visible_accounts=shared.VisibleAccounts( visible_accounts=[ - 'doloremque', + 'Coordinator', ], ), - platform_key='55b197cd-44e2-4f52-982d-3513bb6f48b6', + platform_key='gbol', ) res = s.sync_flow_preferences.update_visible_accounts_sync_flow(req) if res.visible_accounts is not None: # handle response + pass ``` ### Parameters diff --git a/previous-versions/sync-for-commerce-version-1/files.gen b/previous-versions/sync-for-commerce-version-1/files.gen index 94034b3d7..87b49ce26 100755 --- a/previous-versions/sync-for-commerce-version-1/files.gen +++ b/previous-versions/sync-for-commerce-version-1/files.gen @@ -100,6 +100,7 @@ src/codatsynccommerce/models/shared/pushoperationstatus.py src/codatsynccommerce/models/shared/datatype.py src/codatsynccommerce/models/shared/accountingaccount.py src/codatsynccommerce/models/shared/accounttype.py +src/codatsynccommerce/models/shared/supplementaldata.py src/codatsynccommerce/models/shared/accountstatus.py src/codatsynccommerce/models/shared/pushoperationchange.py src/codatsynccommerce/models/shared/pushchangetype.py @@ -114,10 +115,10 @@ src/codatsynccommerce/models/shared/accountingcompanydataset.py src/codatsynccommerce/models/shared/phonenumbertype.py src/codatsynccommerce/models/shared/accountingaddresstype.py src/codatsynccommerce/models/shared/dataset.py +src/codatsynccommerce/models/shared/datasetstatus.py src/codatsynccommerce/models/shared/accountingcreatecreditnoteresponse.py src/codatsynccommerce/models/shared/accountingcreditnote.py src/codatsynccommerce/models/shared/withholdingtaxitems.py -src/codatsynccommerce/models/shared/supplementaldata.py src/codatsynccommerce/models/shared/creditnotestatus.py src/codatsynccommerce/models/shared/paymentallocationsitems.py src/codatsynccommerce/models/shared/paymentallocationpayment.py @@ -148,6 +149,7 @@ src/codatsynccommerce/models/shared/accountingjournalentry.py src/codatsynccommerce/models/shared/journalline.py src/codatsynccommerce/models/shared/accountingcreatepaymentresponse.py src/codatsynccommerce/models/shared/accountingpayment.py +src/codatsynccommerce/models/shared/paymentmethodref.py src/codatsynccommerce/models/shared/paymentline.py src/codatsynccommerce/models/shared/paymentlinelink.py src/codatsynccommerce/models/shared/paymentlinktype.py @@ -176,7 +178,6 @@ src/codatsynccommerce/models/shared/commercecustomerref.py src/codatsynccommerce/models/shared/commerceorders.py src/codatsynccommerce/models/shared/commercepayment.py src/codatsynccommerce/models/shared/commercepaymentmethod.py -src/codatsynccommerce/models/shared/paymentmethodstatus.py src/codatsynccommerce/models/shared/commercepayments.py src/codatsynccommerce/models/shared/commercepaymentmethods.py src/codatsynccommerce/models/shared/commerceproduct.py @@ -245,33 +246,6 @@ src/codatsynccommerce/models/shared/visibleaccounts.py src/codatsynccommerce/models/shared/security.py src/codatsynccommerce/models/shared/__init__.py src/codatsynccommerce/models/errors/__init__.py -docs/sdks/codatsynccommerce/README.md -docs/models/utils/retryconfig.md -docs/sdks/accountingaccounts/README.md -docs/sdks/accountingbankaccounts/README.md -docs/sdks/accountingcompanyinfo/README.md -docs/sdks/accountingcreditnotes/README.md -docs/sdks/accountingcustomers/README.md -docs/sdks/accountingdirectincomes/README.md -docs/sdks/accountinginvoices/README.md -docs/sdks/accountingjournalentries/README.md -docs/sdks/accountingpayments/README.md -docs/sdks/commercecompanyinfo/README.md -docs/sdks/commercecustomers/README.md -docs/sdks/commercelocations/README.md -docs/sdks/commerceorders/README.md -docs/sdks/commercepayments/README.md -docs/sdks/commerceproducts/README.md -docs/sdks/commercetransactions/README.md -docs/sdks/companies/README.md -docs/sdks/companymanagement/README.md -docs/sdks/configuration/README.md -docs/sdks/connections/README.md -docs/sdks/integrations/README.md -docs/sdks/pushdata/README.md -docs/sdks/refreshdata/README.md -docs/sdks/sync/README.md -docs/sdks/syncflowpreferences/README.md USAGE.md docs/models/operations/createaccountingaccountrequest.md docs/models/operations/createaccountingaccountresponse.md @@ -396,6 +370,7 @@ docs/models/shared/accountingaccountmetadata.md docs/models/shared/accountingaccountvaliddatatypelinks.md docs/models/shared/accountingaccount.md docs/models/shared/accounttype.md +docs/models/shared/supplementaldata.md docs/models/shared/accountstatus.md docs/models/shared/pushoperationchange.md docs/models/shared/pushchangetype.md @@ -414,12 +389,12 @@ docs/models/shared/accountingcompanydatasetweblink.md docs/models/shared/accountingcompanydataset.md docs/models/shared/phonenumbertype.md docs/models/shared/accountingaddresstype.md -docs/models/shared/datasetstatus.md +docs/models/shared/datasetdatatypes.md docs/models/shared/dataset.md +docs/models/shared/datasetstatus.md docs/models/shared/accountingcreatecreditnoteresponse.md docs/models/shared/accountingcreditnote.md docs/models/shared/withholdingtaxitems.md -docs/models/shared/supplementaldata.md docs/models/shared/creditnotestatus.md docs/models/shared/itemsallocation.md docs/models/shared/paymentallocationsitems.md @@ -465,6 +440,7 @@ docs/models/shared/journallinetracking.md docs/models/shared/journalline.md docs/models/shared/accountingcreatepaymentresponse.md docs/models/shared/accountingpayment.md +docs/models/shared/paymentmethodref.md docs/models/shared/paymentline.md docs/models/shared/paymentlinelink.md docs/models/shared/paymentlinktype.md @@ -479,7 +455,6 @@ docs/models/shared/commercecustomer.md docs/models/shared/commercecustomers.md docs/models/shared/commercelocation.md docs/models/shared/commercelocations.md -docs/models/shared/commerceordersupplementaldata.md docs/models/shared/commerceorder.md docs/models/shared/servicechargetaxcomponentallocationtaxcomponentref.md docs/models/shared/servicechargetaxcomponentallocation.md @@ -498,8 +473,8 @@ docs/models/shared/locationref.md docs/models/shared/commercecustomerref.md docs/models/shared/commerceorders.md docs/models/shared/commercepayment.md +docs/models/shared/commercepaymentmethodstatus.md docs/models/shared/commercepaymentmethod.md -docs/models/shared/paymentmethodstatus.md docs/models/shared/commercepayments.md docs/models/shared/commercepaymentmethods.md docs/models/shared/commerceproduct.md @@ -550,7 +525,6 @@ docs/models/shared/brandingbutton.md docs/models/shared/integrations.md docs/models/shared/integration.md docs/models/shared/sourcetype.md -docs/models/shared/datatypefeaturedatatypes.md docs/models/shared/datatypefeature.md docs/models/shared/supportedfeature.md docs/models/shared/featuretype.md @@ -570,4 +544,31 @@ docs/models/shared/localization.md docs/models/shared/syncflowurl.md docs/models/shared/visibleaccounts.md docs/models/shared/security.md +docs/sdks/codatsynccommerce/README.md +docs/models/utils/retryconfig.md +docs/sdks/accountingaccounts/README.md +docs/sdks/accountingbankaccounts/README.md +docs/sdks/accountingcompanyinfo/README.md +docs/sdks/accountingcreditnotes/README.md +docs/sdks/accountingcustomers/README.md +docs/sdks/accountingdirectincomes/README.md +docs/sdks/accountinginvoices/README.md +docs/sdks/accountingjournalentries/README.md +docs/sdks/accountingpayments/README.md +docs/sdks/commercecompanyinfo/README.md +docs/sdks/commercecustomers/README.md +docs/sdks/commercelocations/README.md +docs/sdks/commerceorders/README.md +docs/sdks/commercepayments/README.md +docs/sdks/commerceproducts/README.md +docs/sdks/commercetransactions/README.md +docs/sdks/companies/README.md +docs/sdks/companymanagement/README.md +docs/sdks/configuration/README.md +docs/sdks/connections/README.md +docs/sdks/integrations/README.md +docs/sdks/pushdata/README.md +docs/sdks/refreshdata/README.md +docs/sdks/sync/README.md +docs/sdks/syncflowpreferences/README.md .gitattributes \ No newline at end of file diff --git a/previous-versions/sync-for-commerce-version-1/gen.yaml b/previous-versions/sync-for-commerce-version-1/gen.yaml index eda38bd72..2fccdbde3 100644 --- a/previous-versions/sync-for-commerce-version-1/gen.yaml +++ b/previous-versions/sync-for-commerce-version-1/gen.yaml @@ -1,26 +1,26 @@ configVersion: 1.0.0 management: - docChecksum: a05e447da71b345cb5e1ad7bd7264f43 - docVersion: '1.1' - speakeasyVersion: 1.82.5 - generationVersion: 2.108.3 + docChecksum: 9938cd355530f05f03544bec6a6ce2e5 + docVersion: "1.1" + speakeasyVersion: 1.100.2 + generationVersion: 2.159.2 generation: sdkClassName: CodatSyncCommerce singleTagPerOp: false telemetryEnabled: true features: python: - core: 2.85.4 + core: 3.0.2 deprecations: 2.81.1 examples: 2.81.2 - globalSecurity: 2.81.1 + globalSecurity: 2.82.0 globalServerURLs: 2.82.0 nameOverrides: 2.81.1 retries: 2.82.0 python: - version: 0.1.0 + version: 0.2.0 author: Codat - description: Push merchants' data from your ecommerce or point-of-sale (POS) platform - into your merchants' accounting platform. + description: Push merchants' data from your ecommerce or point-of-sale (POS) platform into your merchants' accounting platform. + flattenGlobalSecurity: false maxMethodParams: 0 packageName: codat-sync-for-commerce-version-1 diff --git a/previous-versions/sync-for-commerce-version-1/pylintrc b/previous-versions/sync-for-commerce-version-1/pylintrc index ab6495dd6..1ed32214e 100755 --- a/previous-versions/sync-for-commerce-version-1/pylintrc +++ b/previous-versions/sync-for-commerce-version-1/pylintrc @@ -88,7 +88,7 @@ persistent=yes # Minimum Python version to use for version dependent checks. Will default to # the version used to run pylint. -py-version=3.9 +py-version=3.8 # Discover python modules and packages in the file system subtree. recursive=no @@ -116,12 +116,12 @@ argument-naming-style=snake_case #argument-rgx= # Naming style matching correct attribute names. -attr-naming-style=snake_case +#attr-naming-style=snake_case # Regular expression matching correct attribute names. Overrides attr-naming- # style. If left empty, attribute names will be checked with the set naming # style. -#attr-rgx= +attr-rgx=[^\W\d][^\W]*|__.*__$ # Bad variable names which should always be refused, separated by a comma. bad-names= diff --git a/previous-versions/sync-for-commerce-version-1/setup.py b/previous-versions/sync-for-commerce-version-1/setup.py index dfbbc2854..9cc0245d6 100755 --- a/previous-versions/sync-for-commerce-version-1/setup.py +++ b/previous-versions/sync-for-commerce-version-1/setup.py @@ -10,33 +10,31 @@ setuptools.setup( name="codat-sync-for-commerce-version-1", - version="0.1.0", + version="0.2.0", author="Codat", description="Push merchants' data from your ecommerce or point-of-sale (POS) platform into your merchants' accounting platform.", long_description=long_description, long_description_content_type="text/markdown", packages=setuptools.find_packages(where="src"), install_requires=[ - "certifi>=2022.12.7", - "charset-normalizer>=2.1.1", - "dataclasses-json>=0.5.12", - "idna>=3.3", + "certifi>=2023.7.22", + "charset-normalizer>=3.2.0", + "dataclasses-json>=0.6.1", + "idna>=3.4", "jsonpath-python>=1.0.6 ", - "marshmallow>=3.17.1", - "marshmallow-enum>=1.5.1", - "mypy-extensions>=0.4.3", - "packaging>=21.3", - "pyparsing>=3.0.9", + "marshmallow>=3.19.0", + "mypy-extensions>=1.0.0", + "packaging>=23.1", "python-dateutil>=2.8.2", - "requests>=2.28.1", + "requests>=2.31.0", "six>=1.16.0", - "typing-inspect>=0.8.0", - "typing_extensions>=4.3.0", - "urllib3>=1.26.12", + "typing-inspect>=0.9.0", + "typing_extensions>=4.7.1", + "urllib3>=2.0.4", ], extras_require={ "dev":["pylint==2.16.2"] }, package_dir={'': 'src'}, - python_requires='>=3.9' + python_requires='>=3.8' ) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_accounts.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_accounts.py index 6ea0a94b3..ce608b355 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_accounts.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_accounts.py @@ -29,12 +29,12 @@ def create_accounting_account(self, request: operations.CreateAccountingAccountR url = utils.generate_url(operations.CreateAccountingAccountRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/accounts', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_account", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_account", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateAccountingAccountRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -48,7 +48,7 @@ def create_accounting_account(self, request: operations.CreateAccountingAccountR def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -89,7 +89,7 @@ def get_accounting_account(self, request: operations.GetAccountingAccountRequest url = utils.generate_url(operations.GetAccountingAccountRequest, base_url, '/companies/{companyId}/data/accounts/{accountId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -103,7 +103,7 @@ def get_accounting_account(self, request: operations.GetAccountingAccountRequest def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -143,7 +143,7 @@ def list_accounting_accounts(self, request: operations.ListAccountingAccountsReq headers = {} query_params = utils.get_query_params(operations.ListAccountingAccountsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -157,7 +157,7 @@ def list_accounting_accounts(self, request: operations.ListAccountingAccountsReq def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_bank_accounts.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_bank_accounts.py index adff4b35e..0bb1fa91e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_bank_accounts.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_bank_accounts.py @@ -28,7 +28,7 @@ def get_accounting_bank_account(self, request: operations.GetAccountingBankAccou url = utils.generate_url(operations.GetAccountingBankAccountRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -42,7 +42,7 @@ def get_accounting_bank_account(self, request: operations.GetAccountingBankAccou def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -82,7 +82,7 @@ def list_accounting_bank_accounts(self, request: operations.ListAccountingBankAc headers = {} query_params = utils.get_query_params(operations.ListAccountingBankAccountsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -96,7 +96,7 @@ def list_accounting_bank_accounts(self, request: operations.ListAccountingBankAc def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_company_info.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_company_info.py index a2c27d525..41130ea0d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_company_info.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_company_info.py @@ -22,7 +22,7 @@ def get_accounting_company_info(self, request: operations.GetAccountingCompanyIn url = utils.generate_url(operations.GetAccountingCompanyInfoRequest, base_url, '/companies/{companyId}/data/info', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def get_accounting_company_info(self, request: operations.GetAccountingCompanyIn def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -71,7 +71,7 @@ def refresh(self, request: operations.RefreshCompanyInfoRequest, retries: Option url = utils.generate_url(operations.RefreshCompanyInfoRequest, base_url, '/companies/{companyId}/data/info', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -85,7 +85,7 @@ def refresh(self, request: operations.RefreshCompanyInfoRequest, retries: Option def do_request(): return client.request('POST', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_credit_notes.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_credit_notes.py index 9eee8d800..d1cde69a2 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_credit_notes.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_credit_notes.py @@ -29,12 +29,12 @@ def create_accounting_credit_note(self, request: operations.CreateAccountingCred url = utils.generate_url(operations.CreateAccountingCreditNoteRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/creditNotes', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_credit_note", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_credit_note", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateAccountingCreditNoteRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -48,7 +48,7 @@ def create_accounting_credit_note(self, request: operations.CreateAccountingCred def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_customers.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_customers.py index d934ec483..d5176c6cc 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_customers.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_customers.py @@ -29,12 +29,12 @@ def create_accounting_customer(self, request: operations.CreateAccountingCustome url = utils.generate_url(operations.CreateAccountingCustomerRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/customers', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_customer", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_customer", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateAccountingCustomerRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -48,7 +48,7 @@ def create_accounting_customer(self, request: operations.CreateAccountingCustome def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_direct_incomes.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_direct_incomes.py index 4959d92e9..18e8d1f45 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_direct_incomes.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_direct_incomes.py @@ -29,12 +29,12 @@ def create_accounting_direct_income(self, request: operations.CreateAccountingDi url = utils.generate_url(operations.CreateAccountingDirectIncomeRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/directIncomes', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_direct_income", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_direct_income", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateAccountingDirectIncomeRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -48,7 +48,7 @@ def create_accounting_direct_income(self, request: operations.CreateAccountingDi def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_invoices.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_invoices.py index 7b9e8a63b..58a4aa473 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_invoices.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_invoices.py @@ -29,12 +29,12 @@ def create_accounting_invoice(self, request: operations.CreateAccountingInvoiceR url = utils.generate_url(operations.CreateAccountingInvoiceRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/invoices', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_invoice", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_invoice", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateAccountingInvoiceRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -48,7 +48,7 @@ def create_accounting_invoice(self, request: operations.CreateAccountingInvoiceR def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_journal_entries.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_journal_entries.py index 0b1cd8340..c13e836c0 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_journal_entries.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_journal_entries.py @@ -29,12 +29,12 @@ def create_accounting_journal_entry(self, request: operations.CreateAccountingJo url = utils.generate_url(operations.CreateAccountingJournalEntryRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/journalEntries', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_journal_entry", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_journal_entry", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateAccountingJournalEntryRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -48,7 +48,7 @@ def create_accounting_journal_entry(self, request: operations.CreateAccountingJo def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_payments.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_payments.py index 53acc71a9..4c530ae9a 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_payments.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/accounting_payments.py @@ -29,12 +29,12 @@ def create_accounting_payment(self, request: operations.CreateAccountingPaymentR url = utils.generate_url(operations.CreateAccountingPaymentRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/payments', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_payment", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_payment", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateAccountingPaymentRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -48,7 +48,7 @@ def create_accounting_payment(self, request: operations.CreateAccountingPaymentR def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_company_info.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_company_info.py index df15c779c..06c05c54c 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_company_info.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_company_info.py @@ -24,7 +24,7 @@ def get_commerce_company_info(self, request: operations.GetCommerceCompanyInfoRe url = utils.generate_url(operations.GetCommerceCompanyInfoRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-info', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -38,7 +38,7 @@ def get_commerce_company_info(self, request: operations.GetCommerceCompanyInfoRe def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_customers.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_customers.py index e0904c575..3959d263b 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_customers.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_customers.py @@ -28,7 +28,7 @@ def get_commerce_customer(self, request: operations.GetCommerceCustomerRequest, url = utils.generate_url(operations.GetCommerceCustomerRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-customers/{customerId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -42,7 +42,7 @@ def get_commerce_customer(self, request: operations.GetCommerceCustomerRequest, def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -82,7 +82,7 @@ def list_commerce_customers(self, request: operations.ListCommerceCustomersReque headers = {} query_params = utils.get_query_params(operations.ListCommerceCustomersRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -96,7 +96,7 @@ def list_commerce_customers(self, request: operations.ListCommerceCustomersReque def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_locations.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_locations.py index b6219ed3f..09191bc1c 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_locations.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_locations.py @@ -28,7 +28,7 @@ def get_commerce_location(self, request: operations.GetCommerceLocationRequest, url = utils.generate_url(operations.GetCommerceLocationRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -42,7 +42,7 @@ def get_commerce_location(self, request: operations.GetCommerceLocationRequest, def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -81,7 +81,7 @@ def list_commerce_locations(self, request: operations.ListCommerceLocationsReque url = utils.generate_url(operations.ListCommerceLocationsRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-locations', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list_commerce_locations(self, request: operations.ListCommerceLocationsReque def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_orders.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_orders.py index e6e67cf09..4d35fe02f 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_orders.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_orders.py @@ -28,7 +28,7 @@ def get_commerce_order(self, request: operations.GetCommerceOrderRequest, retrie url = utils.generate_url(operations.GetCommerceOrderRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -42,7 +42,7 @@ def get_commerce_order(self, request: operations.GetCommerceOrderRequest, retrie def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -82,7 +82,7 @@ def list_commerce_orders(self, request: operations.ListCommerceOrdersRequest, re headers = {} query_params = utils.get_query_params(operations.ListCommerceOrdersRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -96,7 +96,7 @@ def list_commerce_orders(self, request: operations.ListCommerceOrdersRequest, re def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_payments.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_payments.py index f866b7598..c6f0ea8f9 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_payments.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_payments.py @@ -28,7 +28,7 @@ def get_commerce_payment(self, request: operations.GetCommercePaymentRequest, re url = utils.generate_url(operations.GetCommercePaymentRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-payments/{paymentId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -42,7 +42,7 @@ def get_commerce_payment(self, request: operations.GetCommercePaymentRequest, re def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -83,7 +83,7 @@ def get_method(self, request: operations.GetCommercePaymentMethodRequest, retrie url = utils.generate_url(operations.GetCommercePaymentMethodRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods/{paymentMethodId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -97,7 +97,7 @@ def get_method(self, request: operations.GetCommercePaymentMethodRequest, retrie def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -137,7 +137,7 @@ def list_commerce_payments(self, request: operations.ListCommercePaymentsRequest headers = {} query_params = utils.get_query_params(operations.ListCommercePaymentsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -151,7 +151,7 @@ def list_commerce_payments(self, request: operations.ListCommercePaymentsRequest def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -191,7 +191,7 @@ def list_methods(self, request: operations.ListCommercePaymentMethodsRequest, re headers = {} query_params = utils.get_query_params(operations.ListCommercePaymentMethodsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -205,7 +205,7 @@ def list_methods(self, request: operations.ListCommercePaymentMethodsRequest, re def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_products.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_products.py index bb3c6cb26..66b4aa19a 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_products.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_products.py @@ -28,7 +28,7 @@ def get_commerce_product(self, request: operations.GetCommerceProductRequest, re url = utils.generate_url(operations.GetCommerceProductRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-products/{productId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -42,7 +42,7 @@ def get_commerce_product(self, request: operations.GetCommerceProductRequest, re def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -82,7 +82,7 @@ def list_commerce_products(self, request: operations.ListCommerceProductsRequest headers = {} query_params = utils.get_query_params(operations.ListCommerceProductsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -96,7 +96,7 @@ def list_commerce_products(self, request: operations.ListCommerceProductsRequest def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_transactions.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_transactions.py index b2a58f706..04bc5acb9 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_transactions.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/commerce_transactions.py @@ -28,7 +28,7 @@ def get_commerce_transaction(self, request: operations.GetCommerceTransactionReq url = utils.generate_url(operations.GetCommerceTransactionRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-transactions/{transactionId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -42,7 +42,7 @@ def get_commerce_transaction(self, request: operations.GetCommerceTransactionReq def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -82,7 +82,7 @@ def list_commerce_transactions(self, request: operations.ListCommerceTransaction headers = {} query_params = utils.get_query_params(operations.ListCommerceTransactionsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -96,7 +96,7 @@ def list_commerce_transactions(self, request: operations.ListCommerceTransaction def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/companies.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/companies.py index 0f41c3f96..4a63e9d93 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/companies.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/companies.py @@ -22,7 +22,7 @@ def delete_company(self, request: operations.DeleteCompanyRequest, retries: Opti url = utils.generate_url(operations.DeleteCompanyRequest, base_url, '/companies/{companyId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def delete_company(self, request: operations.DeleteCompanyRequest, retries: Opti def do_request(): return client.request('DELETE', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -67,7 +67,7 @@ def get_company(self, request: operations.GetCompanyRequest, retries: Optional[u url = utils.generate_url(operations.GetCompanyRequest, base_url, '/companies/{companyId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -81,7 +81,7 @@ def get_company(self, request: operations.GetCompanyRequest, retries: Optional[u def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -115,11 +115,11 @@ def update_company(self, request: operations.UpdateCompanyRequest, retries: Opti url = utils.generate_url(operations.UpdateCompanyRequest, base_url, '/companies/{companyId}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "create_company", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "create_company", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -133,7 +133,7 @@ def update_company(self, request: operations.UpdateCompanyRequest, retries: Opti def do_request(): return client.request('PUT', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/company_management.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/company_management.py index 06dbef852..45dd316b4 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/company_management.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/company_management.py @@ -14,18 +14,18 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def create_company(self, request: shared.CreateCompany, retries: Optional[utils.RetryConfig] = None) -> operations.CreateCompanyResponse: - r"""Create Sync for Commerce company + r"""Create sync for commerce company Creates a Codat company with a commerce partner data connection. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = base_url + '/meta/companies/sync' headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -39,7 +39,7 @@ def create_company(self, request: shared.CreateCompany, retries: Optional[utils. def do_request(): return client.request('POST', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -67,11 +67,11 @@ def create_connection(self, request: operations.CreateConnectionRequest, retries url = utils.generate_url(operations.CreateConnectionRequest, base_url, '/meta/companies/{companyId}/connections', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'string') + req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -85,7 +85,7 @@ def create_connection(self, request: operations.CreateConnectionRequest, retries def do_request(): return client.request('POST', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -115,7 +115,7 @@ def list_companies(self, request: operations.ListCompaniesRequest, retries: Opti headers = {} query_params = utils.get_query_params(operations.ListCompaniesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -129,7 +129,7 @@ def list_companies(self, request: operations.ListCompaniesRequest, retries: Opti def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -159,7 +159,7 @@ def list_connections(self, request: operations.ListConnectionsRequest, retries: headers = {} query_params = utils.get_query_params(operations.ListConnectionsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -173,7 +173,7 @@ def list_connections(self, request: operations.ListConnectionsRequest, retries: def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -201,11 +201,11 @@ def update_connection(self, request: operations.UpdateConnectionRequest, retries url = utils.generate_url(operations.UpdateConnectionRequest, base_url, '/meta/companies/{companyId}/connections/{connectionId}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "update_connection", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "update_connection", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -219,7 +219,7 @@ def update_connection(self, request: operations.UpdateConnectionRequest, retries def do_request(): return client.request('PATCH', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/configuration.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/configuration.py index e7ea29acd..a6c9063f8 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/configuration.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/configuration.py @@ -14,7 +14,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def get_configuration(self, request: operations.GetConfigurationRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetConfigurationResponse: - r"""Retrieve config preferences set for a company. + r"""Retrieve config preferences set for a company Retrieve current config preferences. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) @@ -22,7 +22,7 @@ def get_configuration(self, request: operations.GetConfigurationRequest, retries url = utils.generate_url(operations.GetConfigurationRequest, base_url, '/config/companies/{companyId}/sync/commerce', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def get_configuration(self, request: operations.GetConfigurationRequest, retries def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -57,7 +57,7 @@ def do_request(): def set_configuration(self, request: operations.SetConfigurationRequest, retries: Optional[utils.RetryConfig] = None) -> operations.SetConfigurationResponse: - r"""Create or update configuration. + r"""Create or update configuration Make changes to configuration preferences. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) @@ -65,7 +65,7 @@ def set_configuration(self, request: operations.SetConfigurationRequest, retries url = utils.generate_url(operations.SetConfigurationRequest, base_url, '/config/companies/{companyId}/sync/commerce', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -79,7 +79,7 @@ def set_configuration(self, request: operations.SetConfigurationRequest, retries def do_request(): return client.request('POST', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/connections.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/connections.py index 8799a6247..6bfbe88ca 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/connections.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/connections.py @@ -23,7 +23,7 @@ def delete_connection(self, request: operations.DeleteConnectionRequest, retries url = utils.generate_url(operations.DeleteConnectionRequest, base_url, '/companies/{companyId}/connections/{connectionId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -37,7 +37,7 @@ def delete_connection(self, request: operations.DeleteConnectionRequest, retries def do_request(): return client.request('DELETE', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -68,7 +68,7 @@ def get_connection(self, request: operations.GetConnectionRequest, retries: Opti url = utils.generate_url(operations.GetConnectionRequest, base_url, '/companies/{companyId}/connections/{connectionId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -82,7 +82,7 @@ def get_connection(self, request: operations.GetConnectionRequest, retries: Opti def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -116,11 +116,11 @@ def unlink(self, request: operations.UnlinkConnectionRequest, retries: Optional[ url = utils.generate_url(operations.UnlinkConnectionRequest, base_url, '/companies/{companyId}/connections/{connectionId}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "update_connection", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "update_connection", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -134,7 +134,7 @@ def unlink(self, request: operations.UnlinkConnectionRequest, retries: Optional[ def do_request(): return client.request('PATCH', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/integrations.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/integrations.py index 20826be6f..996243e5e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/integrations.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/integrations.py @@ -22,7 +22,7 @@ def get_integration_branding(self, request: operations.GetIntegrationBrandingReq url = utils.generate_url(operations.GetIntegrationBrandingRequest, base_url, '/config/integrations/{platformKey}/branding', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def get_integration_branding(self, request: operations.GetIntegrationBrandingReq def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -57,7 +57,7 @@ def do_request(): def list_integrations(self, request: operations.ListIntegrationsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListIntegrationsResponse: - r"""List information on Codat's supported integrations + r"""List integrations Retrieve a list of available integrations support by datatype and state of release. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) @@ -66,7 +66,7 @@ def list_integrations(self, request: operations.ListIntegrationsRequest, retries headers = {} query_params = utils.get_query_params(operations.ListIntegrationsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -80,7 +80,7 @@ def list_integrations(self, request: operations.ListIntegrationsRequest, retries def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/__init__.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/__init__.py index 889f8adcf..36628d6cc 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/__init__.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/__init__.py @@ -1,2 +1,3 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" +# __init__.py diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_account.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_account.py index 1878a3a73..db8798605 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_account.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_account.py @@ -9,26 +9,30 @@ from typing import Optional - @dataclasses.dataclass class CreateAccountingAccountRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_account: Optional[shared_accountingaccount.AccountingAccount] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateAccountingAccountResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_account_response: Optional[shared_accountingcreateaccountresponse.AccountingCreateAccountResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_credit_note.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_credit_note.py index 396f658c4..a1e878acc 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_credit_note.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_credit_note.py @@ -9,26 +9,30 @@ from typing import Optional - @dataclasses.dataclass class CreateAccountingCreditNoteRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_credit_note: Optional[shared_accountingcreditnote.AccountingCreditNote] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateAccountingCreditNoteResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_credit_note_response: Optional[shared_accountingcreatecreditnoteresponse.AccountingCreateCreditNoteResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_customer.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_customer.py index fe5d02536..72b6fa289 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_customer.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_customer.py @@ -9,26 +9,30 @@ from typing import Optional - @dataclasses.dataclass class CreateAccountingCustomerRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_customer: Optional[shared_accountingcustomer.AccountingCustomer] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateAccountingCustomerResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_customer_response: Optional[shared_accountingcreatecustomerresponse.AccountingCreateCustomerResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_direct_income.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_direct_income.py index 25afed332..11ce84445 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_direct_income.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_direct_income.py @@ -9,26 +9,30 @@ from typing import Optional - @dataclasses.dataclass class CreateAccountingDirectIncomeRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_direct_income: Optional[shared_accountingdirectincome.AccountingDirectIncome] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateAccountingDirectIncomeResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_direct_income_response: Optional[shared_accountingcreatedirectincomeresponse.AccountingCreateDirectIncomeResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_invoice.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_invoice.py index 9972cacea..acf9b4010 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_invoice.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_invoice.py @@ -9,26 +9,30 @@ from typing import Optional - @dataclasses.dataclass class CreateAccountingInvoiceRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_invoice: Optional[shared_accountinginvoice.AccountingInvoice] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateAccountingInvoiceResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_invoice_response: Optional[shared_accountingcreateinvoiceresponse.AccountingCreateInvoiceResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_journal_entry.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_journal_entry.py index 769a6a213..0b7a1d903 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_journal_entry.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_journal_entry.py @@ -9,26 +9,30 @@ from typing import Optional - @dataclasses.dataclass class CreateAccountingJournalEntryRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_journal_entry: Optional[shared_accountingjournalentry.AccountingJournalEntry] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateAccountingJournalEntryResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_journal_entry_response: Optional[shared_accountingcreatejournalentryresponse.AccountingCreateJournalEntryResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_payment.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_payment.py index afe0ca5dd..7c4afe6c5 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_payment.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_accounting_payment.py @@ -9,26 +9,30 @@ from typing import Optional - @dataclasses.dataclass class CreateAccountingPaymentRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_payment: Optional[shared_accountingpayment.AccountingPayment] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateAccountingPaymentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_payment_response: Optional[shared_accountingcreatepaymentresponse.AccountingCreatePaymentResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_company.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_company.py index 5a191625e..7016946c3 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_company.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_company.py @@ -7,13 +7,15 @@ from typing import Optional - @dataclasses.dataclass class CreateCompanyResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" company: Optional[shared_company.Company] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_connection.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_connection.py index c7e6455c3..6532a1ca5 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_connection.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/create_connection.py @@ -7,22 +7,24 @@ from typing import Optional - @dataclasses.dataclass class CreateConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" request_body: Optional[str] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class CreateConnectionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" connection: Optional[shared_connection.Connection] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/delete_company.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/delete_company.py index b5e6a5b86..0c7da43c5 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/delete_company.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/delete_company.py @@ -7,21 +7,23 @@ from typing import Optional - @dataclasses.dataclass class DeleteCompanyRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class DeleteCompanyResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/delete_connection.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/delete_connection.py index e12219d11..568a81d83 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/delete_connection.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/delete_connection.py @@ -7,22 +7,25 @@ from typing import Optional - @dataclasses.dataclass class DeleteConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class DeleteConnectionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_account.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_account.py index 38abdf83b..f543647c4 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_account.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_account.py @@ -8,25 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingAccountRequest: account_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an account""" + r"""Unique identifier for an account.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetAccountingAccountResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_account: Optional[shared_accountingaccount.AccountingAccount] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_bank_account.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_bank_account.py index 8e5897e35..04785a72d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_bank_account.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_bank_account.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingBankAccountRequest: account_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an account""" + r"""Unique identifier for an account.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetAccountingBankAccountResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_bank_account: Optional[shared_accountingbankaccount.AccountingBankAccount] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_company_info.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_company_info.py index a28fd86ed..cd2d53504 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_company_info.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_accounting_company_info.py @@ -8,23 +8,25 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingCompanyInfoRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetAccountingCompanyInfoResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_company_dataset: Optional[shared_accountingcompanydataset.AccountingCompanyDataset] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_company_info.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_company_info.py index 4bcb5b75a..864d40ed9 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_company_info.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_company_info.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceCompanyInfoRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetCommerceCompanyInfoResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_company_info: Optional[shared_commercecompanyinfo.CommerceCompanyInfo] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_customer.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_customer.py index faa4cc635..5f3d50556 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_customer.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_customer.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceCustomerRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" customer_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'customerId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a customer.""" - @dataclasses.dataclass class GetCommerceCustomerResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_customer: Optional[shared_commercecustomer.CommerceCustomer] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_location.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_location.py index 382aa086a..15d4a0a8e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_location.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_location.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceLocationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" location_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'locationId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a location.""" - @dataclasses.dataclass class GetCommerceLocationResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_location: Optional[shared_commercelocation.CommerceLocation] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_order.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_order.py index b58784b06..993262aee 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_order.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_order.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceOrderRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'orderId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for an order.""" - @dataclasses.dataclass class GetCommerceOrderResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_order: Optional[shared_commerceorder.CommerceOrder] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_payment.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_payment.py index c836d5764..a8f17ec7c 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_payment.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_payment.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommercePaymentRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" payment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'paymentId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a payment.""" - @dataclasses.dataclass class GetCommercePaymentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_payment: Optional[shared_commercepayment.CommercePayment] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_payment_method.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_payment_method.py index 4250ed82d..e828c47a7 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_payment_method.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_payment_method.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommercePaymentMethodRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" payment_method_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'paymentMethodId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a payment method.""" - @dataclasses.dataclass class GetCommercePaymentMethodResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_payment_method: Optional[shared_commercepaymentmethod.CommercePaymentMethod] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_product.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_product.py index de206e6fe..81309281e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_product.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_product.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceProductRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" product_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'productId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a product.""" - @dataclasses.dataclass class GetCommerceProductResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_product: Optional[shared_commerceproduct.CommerceProduct] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_transaction.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_transaction.py index 320015ccc..eda45f6fb 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_transaction.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_commerce_transaction.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceTransactionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" transaction_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'transactionId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a transaction.""" - @dataclasses.dataclass class GetCommerceTransactionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_transaction: Optional[shared_commercetransaction.CommerceTransaction] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company.py index b9881123d..9660394e9 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company.py @@ -8,23 +8,25 @@ from typing import Optional - @dataclasses.dataclass class GetCompanyRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetCompanyResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" company: Optional[shared_company.Company] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company_data_status.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company_data_status.py index 1e8906d6d..449940dd2 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company_data_status.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company_data_status.py @@ -5,26 +5,28 @@ import requests as requests_http from ..shared import datastatus as shared_datastatus from ..shared import errormessage as shared_errormessage -from typing import Optional - +from typing import Dict, Optional @dataclasses.dataclass class GetCompanyDataStatusRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetCompanyDataStatusResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - data_status_response: Optional[dict[str, shared_datastatus.DataStatus]] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + data_status_response: Optional[Dict[str, shared_datastatus.DataStatus]] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company_push_history.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company_push_history.py index 1e95cad79..1278b6f11 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company_push_history.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_company_push_history.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class GetCompanyPushHistoryRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class GetCompanyPushHistoryRequest: - @dataclasses.dataclass class GetCompanyPushHistoryResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" push_operations: Optional[shared_pushoperations.PushOperations] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_config_text_sync_flow.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_config_text_sync_flow.py index adea3f32d..a5bc3500d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_config_text_sync_flow.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_config_text_sync_flow.py @@ -4,16 +4,18 @@ import dataclasses import requests as requests_http from ..shared import localization as shared_localization -from typing import Optional - +from typing import Dict, Optional @dataclasses.dataclass class GetConfigTextSyncFlowResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - localization_info: Optional[dict[str, shared_localization.Localization]] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + localization_info: Optional[Dict[str, shared_localization.Localization]] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_configuration.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_configuration.py index 338c6f809..597c121a4 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_configuration.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_configuration.py @@ -7,21 +7,23 @@ from typing import Optional - @dataclasses.dataclass class GetConfigurationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetConfigurationResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" configuration: Optional[shared_configuration.Configuration] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_connection.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_connection.py index af6188ccb..c21ca84ed 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_connection.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_connection.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetConnectionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" connection: Optional[shared_connection.Connection] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_integration_branding.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_integration_branding.py index 9f64ea9b3..16f849742 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_integration_branding.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_integration_branding.py @@ -7,22 +7,23 @@ from typing import Optional - @dataclasses.dataclass class GetIntegrationBrandingRequest: platform_key: str = dataclasses.field(metadata={'path_param': { 'field_name': 'platformKey', 'style': 'simple', 'explode': False }}) - r"""PlatformKey""" + r"""A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys.""" - @dataclasses.dataclass class GetIntegrationBrandingResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" branding: Optional[shared_branding.Branding] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_pull_operation.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_pull_operation.py index b671bb1eb..09ba964b9 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_pull_operation.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_pull_operation.py @@ -8,25 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetPullOperationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" dataset_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'datasetId', 'style': 'simple', 'explode': False }}) - r"""Unique ID of a dataset or pull operation.""" + r"""Unique identifier for the dataset that completed its sync.""" - @dataclasses.dataclass class GetPullOperationResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" pull_operation: Optional[shared_pulloperation.PullOperation] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_push_operation.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_push_operation.py index eee46eb05..3b11bb84d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_push_operation.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_push_operation.py @@ -8,25 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetPushOperationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" push_operation_key: str = dataclasses.field(metadata={'path_param': { 'field_name': 'pushOperationKey', 'style': 'simple', 'explode': False }}) r"""Push operation key.""" - @dataclasses.dataclass class GetPushOperationResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" push_operation: Optional[shared_pushoperation.PushOperation] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_sync_flow_url.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_sync_flow_url.py index d1908b072..38caf612e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_sync_flow_url.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_sync_flow_url.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class GetSyncFlowURLRequest: accounting_key: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountingKey', 'style': 'simple', 'explode': False }}) @@ -20,12 +19,14 @@ class GetSyncFlowURLRequest: - @dataclasses.dataclass class GetSyncFlowURLResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" sync_flow_url: Optional[shared_syncflowurl.SyncFlowURL] = dataclasses.field(default=None) r"""Success""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_sync_status.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_sync_status.py index ee6e48d51..81ded5787 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_sync_status.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_sync_status.py @@ -6,19 +6,21 @@ from typing import Optional - @dataclasses.dataclass class GetSyncStatusRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetSyncStatusResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_visible_accounts.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_visible_accounts.py index a3c54d8da..0cfa6b50c 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_visible_accounts.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/get_visible_accounts.py @@ -7,21 +7,24 @@ from typing import Optional - @dataclasses.dataclass class GetVisibleAccountsRequest: client_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'clientId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for your client in Codat.""" platform_key: str = dataclasses.field(metadata={'path_param': { 'field_name': 'platformKey', 'style': 'simple', 'explode': False }}) + r"""A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys.""" - @dataclasses.dataclass class GetVisibleAccountsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" visible_accounts: Optional[shared_visibleaccounts.VisibleAccounts] = dataclasses.field(default=None) r"""Success""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_accounting_accounts.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_accounting_accounts.py index 54834b4a5..fa1a96656 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_accounting_accounts.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_accounting_accounts.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingAccountsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingAccountsRequest: - @dataclasses.dataclass class ListAccountingAccountsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_accounts: Optional[shared_accountingaccounts.AccountingAccounts] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_accounting_bank_accounts.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_accounting_bank_accounts.py index 2768560b1..dd9640bd3 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_accounting_bank_accounts.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_accounting_bank_accounts.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingBankAccountsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListAccountingBankAccountsRequest: - @dataclasses.dataclass class ListAccountingBankAccountsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_bank_accounts: Optional[shared_accountingbankaccounts.AccountingBankAccounts] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_customers.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_customers.py index 99000572a..37b669f04 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_customers.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_customers.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceCustomersRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommerceCustomersRequest: - @dataclasses.dataclass class ListCommerceCustomersResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_customers: Optional[shared_commercecustomers.CommerceCustomers] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_locations.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_locations.py index deee0ac17..1afe3f90e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_locations.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_locations.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceLocationsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class ListCommerceLocationsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_locations: Optional[shared_commercelocations.CommerceLocations] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_orders.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_orders.py index acca262ce..8bf158f4e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_orders.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_orders.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceOrdersRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommerceOrdersRequest: - @dataclasses.dataclass class ListCommerceOrdersResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_orders: Optional[shared_commerceorders.CommerceOrders] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_payment_methods.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_payment_methods.py index 8775988fd..cbd25a49c 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_payment_methods.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_payment_methods.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommercePaymentMethodsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommercePaymentMethodsRequest: - @dataclasses.dataclass class ListCommercePaymentMethodsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_payment_methods: Optional[shared_commercepaymentmethods.CommercePaymentMethods] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_payments.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_payments.py index b3c3f068f..b8761efb2 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_payments.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_payments.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommercePaymentsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommercePaymentsRequest: - @dataclasses.dataclass class ListCommercePaymentsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_payments: Optional[shared_commercepayments.CommercePayments] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_products.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_products.py index 728b192db..68e5d0c7d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_products.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_products.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceProductsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommerceProductsRequest: - @dataclasses.dataclass class ListCommerceProductsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_products: Optional[shared_commerceproducts.CommerceProducts] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_transactions.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_transactions.py index 74c26b936..1fe8bf4bf 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_transactions.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_commerce_transactions.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceTransactionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommerceTransactionsRequest: - @dataclasses.dataclass class ListCommerceTransactionsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_transactions: Optional[shared_commercetransactions.CommerceTransactions] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_companies.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_companies.py index ada0623d9..571f534e0 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_companies.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_companies.py @@ -7,14 +7,13 @@ from typing import Optional - @dataclasses.dataclass class ListCompaniesRequest: order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -22,13 +21,15 @@ class ListCompaniesRequest: - @dataclasses.dataclass class ListCompaniesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" companies: Optional[shared_companies.Companies] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_connections.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_connections.py index 76dc50a2b..45b6b779f 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_connections.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_connections.py @@ -7,15 +7,15 @@ from typing import Optional - @dataclasses.dataclass class ListConnectionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -23,13 +23,15 @@ class ListConnectionsRequest: - @dataclasses.dataclass class ListConnectionsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" connections: Optional[shared_connections.Connections] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_integrations.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_integrations.py index 1e6ab4afc..e156feccc 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_integrations.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_integrations.py @@ -7,14 +7,13 @@ from typing import Optional - @dataclasses.dataclass class ListIntegrationsRequest: order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -22,13 +21,15 @@ class ListIntegrationsRequest: - @dataclasses.dataclass class ListIntegrationsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" integrations: Optional[shared_integrations.Integrations] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_pull_operations.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_pull_operations.py index 25f30893d..609e02e50 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_pull_operations.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/list_pull_operations.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListPullOperationsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListPullOperationsRequest: - @dataclasses.dataclass class ListPullOperationsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" pull_operations: Optional[shared_pulloperations.PullOperations] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_company_data.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_company_data.py index 0bf007c5b..1fbb658e0 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_company_data.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_company_data.py @@ -7,21 +7,23 @@ from typing import Optional - @dataclasses.dataclass class RefreshCompanyDataRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class RefreshCompanyDataResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_company_info.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_company_info.py index 88ad86852..afdd1c658 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_company_info.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_company_info.py @@ -8,23 +8,25 @@ from typing import Optional - @dataclasses.dataclass class RefreshCompanyInfoRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class RefreshCompanyInfoResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" dataset: Optional[shared_dataset.Dataset] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_data_type.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_data_type.py index 23151273d..ad5ef640d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_data_type.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/refresh_data_type.py @@ -9,10 +9,10 @@ from typing import Optional - @dataclasses.dataclass class RefreshDataTypeRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" data_type: shared_datatype.DataType = dataclasses.field(metadata={'path_param': { 'field_name': 'dataType', 'style': 'simple', 'explode': False }}) r"""The key of a Codat data type""" connection_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'connectionId', 'style': 'form', 'explode': True }}) @@ -21,15 +21,17 @@ class RefreshDataTypeRequest: - @dataclasses.dataclass class RefreshDataTypeResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" pull_operation: Optional[shared_pulloperation.PullOperation] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/request_sync.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/request_sync.py index 3cd8402b5..fe2ab7173 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/request_sync.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/request_sync.py @@ -8,21 +8,23 @@ from typing import Optional - @dataclasses.dataclass class RequestSyncRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" sync_to_latest_args: Optional[shared_synctolatestargs.SyncToLatestArgs] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class RequestSyncResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" sync_summary: Optional[shared_syncsummary.SyncSummary] = dataclasses.field(default=None) r"""Success""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/request_sync_for_date_range.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/request_sync_for_date_range.py index dcbb5a72f..59c06b8b5 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/request_sync_for_date_range.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/request_sync_for_date_range.py @@ -8,21 +8,23 @@ from typing import Optional - @dataclasses.dataclass class RequestSyncForDateRangeRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" sync_range: Optional[shared_syncrange.SyncRange] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class RequestSyncForDateRangeResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" sync_summary: Optional[shared_syncsummary.SyncSummary] = dataclasses.field(default=None) r"""Success""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/set_configuration.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/set_configuration.py index 6d11b7f82..247802399 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/set_configuration.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/set_configuration.py @@ -7,21 +7,23 @@ from typing import Optional - @dataclasses.dataclass class SetConfigurationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class SetConfigurationResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" configuration: Optional[shared_configuration.Configuration] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/unlink_connection.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/unlink_connection.py index b121016cd..ee452af0b 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/unlink_connection.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/unlink_connection.py @@ -9,25 +9,28 @@ from typing import Optional - @dataclasses.dataclass class UnlinkConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" update_connection: Optional[shared_updateconnection.UpdateConnection] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class UnlinkConnectionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" connection: Optional[shared_connection.Connection] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_company.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_company.py index 3e458ff08..01e237127 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_company.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_company.py @@ -9,24 +9,26 @@ from typing import Optional - @dataclasses.dataclass class UpdateCompanyRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" create_company: Optional[shared_createcompany.CreateCompany] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class UpdateCompanyResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" company: Optional[shared_company.Company] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_config_text_sync_flow.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_config_text_sync_flow.py index 2618249cd..e8dd0cedc 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_config_text_sync_flow.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_config_text_sync_flow.py @@ -4,16 +4,18 @@ import dataclasses import requests as requests_http from ..shared import localization as shared_localization -from typing import Optional - +from typing import Dict, Optional @dataclasses.dataclass class UpdateConfigTextSyncFlowResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - localization_info: Optional[dict[str, shared_localization.Localization]] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + localization_info: Optional[Dict[str, shared_localization.Localization]] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_connection.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_connection.py index 5e63fb95a..6eb5306ed 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_connection.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_connection.py @@ -8,23 +8,26 @@ from typing import Optional - @dataclasses.dataclass class UpdateConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" update_connection: Optional[shared_updateconnection.UpdateConnection] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class UpdateConnectionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" connection: Optional[shared_connection.Connection] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_visible_accounts_sync_flow.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_visible_accounts_sync_flow.py index 6430732b0..72776b2f8 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_visible_accounts_sync_flow.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/operations/update_visible_accounts_sync_flow.py @@ -7,21 +7,23 @@ from typing import Optional - @dataclasses.dataclass class UpdateVisibleAccountsSyncFlowRequest: platform_key: str = dataclasses.field(metadata={'path_param': { 'field_name': 'platformKey', 'style': 'simple', 'explode': False }}) + r"""A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys.""" visible_accounts: Optional[shared_visibleaccounts.VisibleAccounts] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class UpdateVisibleAccountsSyncFlowResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" visible_accounts: Optional[shared_visibleaccounts.VisibleAccounts] = dataclasses.field(default=None) r"""Success""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/__init__.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/__init__.py index 6f0fabc73..076353c72 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/__init__.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/__init__.py @@ -62,6 +62,7 @@ from .dataconnectionerror import * from .dataconnectionstatus import * from .dataset import * +from .datasetstatus import * from .datastatus import * from .datatype import * from .datatypefeature import * @@ -102,7 +103,7 @@ from .paymentline import * from .paymentlinelink import * from .paymentlinktype import * -from .paymentmethodstatus import * +from .paymentmethodref import * from .paymentref import * from .payments import * from .paymentstatus import * @@ -152,4 +153,4 @@ from .weblinksitems import * from .withholdingtaxitems import * -__all__ = ["AccountBalance","AccountOption","AccountRef","AccountStatus","AccountType","AccountingAccount","AccountingAccountMetadata","AccountingAccountValidDataTypeLinks","AccountingAccounts","AccountingAddressType","AccountingBankAccount","AccountingBankAccountBankAccountType","AccountingBankAccounts","AccountingCompanyDataset","AccountingCompanyDatasetAccountingAddress","AccountingCompanyDatasetPhone","AccountingCompanyDatasetWeblink","AccountingCompanyDatasetWeblinkType","AccountingCreateAccountResponse","AccountingCreateCreditNoteResponse","AccountingCreateCustomerResponse","AccountingCreateDirectIncomeResponse","AccountingCreateInvoiceResponse","AccountingCreateJournalEntryResponse","AccountingCreatePaymentResponse","AccountingCreditNote","AccountingCustomer","AccountingCustomerRef","AccountingDirectIncome","AccountingDirectIncomeContactRef","AccountingInvoice","AccountingInvoicePaymentAllocation","AccountingInvoicePaymentAllocationAllocation","AccountingInvoiceSalesOrderReference","AccountingInvoiceWithholdingTax","AccountingJournalEntry","AccountingJournalEntryJournalReference","AccountingJournalEntryRecordReference","AccountingPayment","BilledToType","Branding","BrandingButton","BrandingImage","BrandingLogo","CommerceAddressType","CommerceCompanyInfo","CommerceCustomer","CommerceCustomerAddress","CommerceCustomerRef","CommerceCustomers","CommerceLocation","CommerceLocations","CommerceOrder","CommerceOrderSupplementalData","CommerceOrders","CommercePayment","CommercePaymentMethod","CommercePaymentMethods","CommercePayments","CommerceProduct","CommerceProducts","CommerceTransaction","CommerceTransactions","Companies","Company","ConfigAccount","Configuration","Connection","ConnectionSourceType","Connections","Contact","CreateCompany","CreditNoteLineItem","CreditNoteLineItemTracking","CreditNoteLineItemTrackingProjectReference","CreditNoteStatus","Customer","CustomerStatus","DataConnectionError","DataConnectionStatus","DataStatus","DataType","DataTypeFeature","DataTypeFeatureDataTypes","Dataset","DatasetStatus","DateRange","DirectIncomeLineItem","DirectIncomeLineItemItemReference","DirectIncomeLineItemTaxRateReference","DirectIncomeLineItemTrackingCategoryRefs","ErrorMessage","FeatureState","FeatureType","Fees","FeesSupplier","Grouping","GroupingLevels","GroupingPeriod","HalRef","ImageReference","Integration","Integrations","InvoiceLevelSelection","InvoiceLineItem","InvoiceLineLevelSelection","InvoiceStatus","InvoiceStatus1","ItemRef","Items","Items1","ItemsAllocation","ItemsTaxComponentRef","ItemsType","JournalLine","JournalLineTracking","Links","Localization","LocationRef","Metadata","NewPayments","NewTaxRates","Option","OrderDiscountAllocation","OrderLineItem","PaymentAllocationPayment","PaymentAllocationsitems","PaymentLine","PaymentLineLink","PaymentLinkType","PaymentMethodStatus","PaymentRef","PaymentStatus","PaymentType","Payments","PhoneNumberType","PhoneNumbersitems","ProductInventory","ProductInventoryLocation","ProductPrice","ProductRef","ProductVariant","ProductVariantRef","ProductVariantStatus","PullOperation","PullOperationStatus","PullOperations","PushChangeType","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperations","RecordRef","Sales","Security","ServiceCharge","ServiceChargeTaxComponentAllocation","ServiceChargeTaxComponentAllocationTaxComponentRef","ServiceChargeType","SourceType","SupplementalData","SupportedFeature","SyncFlowURL","SyncRange","SyncRangeDateRange","SyncSummary","SyncToLatestArgs","TaxRateAmount","TaxRateMapping","TaxRateRef","Taxesitems","Tracking","TrackingCategoryRefsitems","TrackingProjectReference","TransactionSourceRef","TransactionSourceType","TransactionType","UpdateConnection","Validation","ValidationItem","VisibleAccounts","WebLinksitems","WithholdingTaxitems"] +__all__ = ["AccountBalance","AccountOption","AccountRef","AccountStatus","AccountType","AccountingAccount","AccountingAccountMetadata","AccountingAccountValidDataTypeLinks","AccountingAccounts","AccountingAddressType","AccountingBankAccount","AccountingBankAccountBankAccountType","AccountingBankAccounts","AccountingCompanyDataset","AccountingCompanyDatasetAccountingAddress","AccountingCompanyDatasetPhone","AccountingCompanyDatasetWeblink","AccountingCompanyDatasetWeblinkType","AccountingCreateAccountResponse","AccountingCreateCreditNoteResponse","AccountingCreateCustomerResponse","AccountingCreateDirectIncomeResponse","AccountingCreateInvoiceResponse","AccountingCreateJournalEntryResponse","AccountingCreatePaymentResponse","AccountingCreditNote","AccountingCustomer","AccountingCustomerRef","AccountingDirectIncome","AccountingDirectIncomeContactRef","AccountingInvoice","AccountingInvoicePaymentAllocation","AccountingInvoicePaymentAllocationAllocation","AccountingInvoiceSalesOrderReference","AccountingInvoiceWithholdingTax","AccountingJournalEntry","AccountingJournalEntryJournalReference","AccountingJournalEntryRecordReference","AccountingPayment","BilledToType","Branding","BrandingButton","BrandingImage","BrandingLogo","CommerceAddressType","CommerceCompanyInfo","CommerceCustomer","CommerceCustomerAddress","CommerceCustomerRef","CommerceCustomers","CommerceLocation","CommerceLocations","CommerceOrder","CommerceOrders","CommercePayment","CommercePaymentMethod","CommercePaymentMethodStatus","CommercePaymentMethods","CommercePayments","CommerceProduct","CommerceProducts","CommerceTransaction","CommerceTransactions","Companies","Company","ConfigAccount","Configuration","Connection","ConnectionSourceType","Connections","Contact","CreateCompany","CreditNoteLineItem","CreditNoteLineItemTracking","CreditNoteLineItemTrackingProjectReference","CreditNoteStatus","Customer","CustomerStatus","DataConnectionError","DataConnectionStatus","DataStatus","DataType","DataTypeFeature","Dataset","DatasetDataTypes","DatasetStatus","DateRange","DirectIncomeLineItem","DirectIncomeLineItemItemReference","DirectIncomeLineItemTaxRateReference","DirectIncomeLineItemTrackingCategoryRefs","ErrorMessage","FeatureState","FeatureType","Fees","FeesSupplier","Grouping","GroupingLevels","GroupingPeriod","HalRef","ImageReference","Integration","Integrations","InvoiceLevelSelection","InvoiceLineItem","InvoiceLineLevelSelection","InvoiceStatus","InvoiceStatus1","ItemRef","Items","Items1","ItemsAllocation","ItemsTaxComponentRef","ItemsType","JournalLine","JournalLineTracking","Links","Localization","LocationRef","Metadata","NewPayments","NewTaxRates","Option","OrderDiscountAllocation","OrderLineItem","PaymentAllocationPayment","PaymentAllocationsitems","PaymentLine","PaymentLineLink","PaymentLinkType","PaymentMethodRef","PaymentRef","PaymentStatus","PaymentType","Payments","PhoneNumberType","PhoneNumbersitems","ProductInventory","ProductInventoryLocation","ProductPrice","ProductRef","ProductVariant","ProductVariantRef","ProductVariantStatus","PullOperation","PullOperationStatus","PullOperations","PushChangeType","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperations","RecordRef","Sales","Security","ServiceCharge","ServiceChargeTaxComponentAllocation","ServiceChargeTaxComponentAllocationTaxComponentRef","ServiceChargeType","SourceType","SupplementalData","SupportedFeature","SyncFlowURL","SyncRange","SyncRangeDateRange","SyncSummary","SyncToLatestArgs","TaxRateAmount","TaxRateMapping","TaxRateRef","Taxesitems","Tracking","TrackingCategoryRefsitems","TrackingProjectReference","TransactionSourceRef","TransactionSourceType","TransactionType","UpdateConnection","Validation","ValidationItem","VisibleAccounts","WebLinksitems","WithholdingTaxitems"] diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountbalance.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountbalance.py index a79c8db2d..43f8231c6 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountbalance.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountbalance.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountBalance: available: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('available'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingaccount.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingaccount.py index 660c90927..86501de1a 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingaccount.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingaccount.py @@ -4,24 +4,23 @@ import dataclasses from ..shared import accountstatus as shared_accountstatus from ..shared import accounttype as shared_accounttype +from ..shared import supplementaldata as shared_supplementaldata from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAccountMetadata: - is_deleted: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDeleted'), 'exclude': lambda f: f is None }}) + is_deleted: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDeleted') }}) r"""Indicates whether the record has been deleted in the third-party system this record originated from.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAccountValidDataTypeLinks: r"""When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data. @@ -65,16 +64,15 @@ class AccountingAccountValidDataTypeLinks: If you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap. """ - links: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('links'), 'exclude': lambda f: f is None }}) + links: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('links') }}) r"""Supported `dataTypes` that the record can be linked to.""" - property: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('property'), 'exclude': lambda f: f is None }}) + property: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('property') }}) r"""The property from the account that can be linked.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAccount: r"""> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**. @@ -115,16 +113,16 @@ class AccountingAccount: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - current_balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currentBalance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + current_balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currentBalance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Current balance in the account.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Description for the account.""" - fully_qualified_category: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fullyQualifiedCategory'), 'exclude': lambda f: f is None }}) + fully_qualified_category: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fullyQualifiedCategory') }}) r"""Full category of the account. For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation. """ - fully_qualified_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fullyQualifiedName'), 'exclude': lambda f: f is None }}) + fully_qualified_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fullyQualifiedName') }}) r"""Full name of the account, for example: - `Cash On Hand` - `Rents Held In Trust` @@ -136,16 +134,21 @@ class AccountingAccount: r"""Confirms whether the account is a bank account or not.""" metadata: Optional[AccountingAccountMetadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of the account.""" - nominal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('nominalCode'), 'exclude': lambda f: f is None }}) + nominal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('nominalCode') }}) r"""Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_accountstatus.AccountStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Status of the account""" + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ type: Optional[shared_accounttype.AccountType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) r"""Type of account""" - valid_datatype_links: Optional[list[AccountingAccountValidDataTypeLinks]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validDatatypeLinks'), 'exclude': lambda f: f is None }}) + valid_datatype_links: Optional[List[AccountingAccountValidDataTypeLinks]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validDatatypeLinks') }}) r"""The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/accounting-api#/schemas/ValidDataTypeLinks).""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingaccounts.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingaccounts.py index 183463b07..80af87e4d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingaccounts.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingaccounts.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAccounts: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingaccount.AccountingAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingaccount.AccountingAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingbankaccount.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingbankaccount.py index fccda4966..8f48bac70 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingbankaccount.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingbankaccount.py @@ -3,6 +3,7 @@ from __future__ import annotations import dataclasses from ..shared import metadata as shared_metadata +from ..shared import supplementaldata as shared_supplementaldata from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -20,7 +21,6 @@ class AccountingBankAccountBankAccountType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBankAccount: r"""> **Accessing Bank Accounts through Banking API** @@ -40,9 +40,9 @@ class AccountingBankAccount: * The currency and balance of the account. * The sort code and account number. """ - account_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountName'), 'exclude': lambda f: f is None }}) + account_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountName') }}) r"""Name of the bank account in the accounting platform.""" - account_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountNumber'), 'exclude': lambda f: f is None }}) + account_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountNumber') }}) r"""Account number for the bank account. Xero integrations @@ -56,9 +56,9 @@ class AccountingBankAccount: For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. For Debit accounts, positive balances are assets, and positive transactions **increase** assets. """ - available_balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('availableBalance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + available_balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('availableBalance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example.""" - balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Balance of the bank account.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -69,27 +69,32 @@ class AccountingBankAccount: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - i_ban: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('iBan'), 'exclude': lambda f: f is None }}) + i_ban: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('iBan') }}) r"""International bank account number of the account. Often used when making or receiving international payments.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the account, unique for the company in the accounting platform.""" - institution: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('institution'), 'exclude': lambda f: f is None }}) + institution: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('institution') }}) r"""The institution of the bank account.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - nominal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('nominalCode'), 'exclude': lambda f: f is None }}) + nominal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('nominalCode') }}) r"""Code used to identify each nominal account for a business.""" - overdraft_limit: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('overdraftLimit'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + overdraft_limit: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('overdraftLimit'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Pre-arranged overdraft limit of the account. The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. """ - sort_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortCode'), 'exclude': lambda f: f is None }}) + sort_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortCode') }}) r"""Sort code for the bank account. Xero integrations The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. """ source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingbankaccounts.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingbankaccounts.py index abda5727d..4c6c858ca 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingbankaccounts.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingbankaccounts.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBankAccounts: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingbankaccount.AccountingBankAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingbankaccount.AccountingBankAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcompanydataset.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcompanydataset.py index 15401c40f..458ef158d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcompanydataset.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcompanydataset.py @@ -4,39 +4,38 @@ import dataclasses from ..shared import accountingaddresstype as shared_accountingaddresstype from ..shared import phonenumbertype as shared_phonenumbertype +from ..shared import supplementaldata as shared_supplementaldata from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum -from typing import Optional +from typing import Dict, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCompanyDatasetAccountingAddress: type: shared_accountingaddresstype.AccountingAddressType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""The type of the address""" - city: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('city'), 'exclude': lambda f: f is None }}) + city: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('city') }}) r"""City of the customer address.""" - country: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('country'), 'exclude': lambda f: f is None }}) + country: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('country') }}) r"""Country of the customer address.""" - line1: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line1'), 'exclude': lambda f: f is None }}) + line1: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line1') }}) r"""Line 1 of the customer address.""" - line2: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line2'), 'exclude': lambda f: f is None }}) + line2: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line2') }}) r"""Line 2 of the customer address.""" - postal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('postalCode'), 'exclude': lambda f: f is None }}) + postal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('postalCode') }}) r"""Postal code or zip code.""" - region: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region'), 'exclude': lambda f: f is None }}) + region: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region') }}) r"""Region of the customer address.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCompanyDatasetPhone: - number: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('number') }}) + number: Optional[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('number') }}) r"""A phone number.""" type: shared_phonenumbertype.PhoneNumberType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""The type of phone number""" @@ -51,7 +50,6 @@ class AccountingCompanyDatasetWeblinkType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCompanyDatasetWeblink: r"""Weblink associated with the company.""" @@ -64,7 +62,6 @@ class AccountingCompanyDatasetWeblink: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCompanyDataset: r"""> View the coverage for company info in the Data coverage explorer. @@ -75,15 +72,15 @@ class AccountingCompanyDataset: > > Company information is standard information that is held in the accounting platform about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources. """ - accounting_platform_ref: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountingPlatformRef'), 'exclude': lambda f: f is None }}) + accounting_platform_ref: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountingPlatformRef') }}) r"""Identifier or reference for the company in the accounting platform.""" - addresses: Optional[list[AccountingCompanyDatasetAccountingAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) + addresses: Optional[List[AccountingCompanyDatasetAccountingAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses') }}) r"""An array of Addresses.""" - base_currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('baseCurrency'), 'exclude': lambda f: f is None }}) + base_currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('baseCurrency') }}) r"""Currency set in the accounting platform of the linked company. Used by the currency rate.""" - company_legal_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyLegalName'), 'exclude': lambda f: f is None }}) + company_legal_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyLegalName') }}) r"""Registered legal name of the linked company.""" - company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName'), 'exclude': lambda f: f is None }}) + company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName') }}) r"""Name of the linked company.""" created_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('createdDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -148,18 +145,23 @@ class AccountingCompanyDataset: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - phone_numbers: Optional[list[AccountingCompanyDatasetPhone]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phoneNumbers'), 'exclude': lambda f: f is None }}) + phone_numbers: Optional[List[AccountingCompanyDatasetPhone]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phoneNumbers') }}) r"""An array of phone numbers.""" - registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber'), 'exclude': lambda f: f is None }}) + registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber') }}) r"""Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House.""" - source_urls: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceUrls'), 'exclude': lambda f: f is None }}) + source_urls: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceUrls') }}) r"""URL addresses for the accounting source. For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). """ - tax_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxNumber'), 'exclude': lambda f: f is None }}) + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ + tax_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxNumber') }}) r"""Company tax number.""" - web_links: Optional[list[AccountingCompanyDatasetWeblink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('webLinks'), 'exclude': lambda f: f is None }}) + web_links: Optional[List[AccountingCompanyDatasetWeblink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('webLinks') }}) r"""An array of weblinks.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreateaccountresponse.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreateaccountresponse.py index 79afea883..b0caea3c4 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreateaccountresponse.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreateaccountresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateAccountResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -44,9 +43,10 @@ class AccountingCreateAccountResponse: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The status of the push operation.""" + r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -69,7 +69,7 @@ class AccountingCreateAccountResponse: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - data: Optional[shared_accountingaccount.AccountingAccount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_accountingaccount.AccountingAccount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) r"""> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**. View the coverage for accounts in the Data coverage explorer. @@ -101,10 +101,15 @@ class AccountingCreateAccountResponse: """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatecreditnoteresponse.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatecreditnoteresponse.py index c02136610..75547d7ee 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatecreditnoteresponse.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatecreditnoteresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateCreditNoteResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -44,9 +43,10 @@ class AccountingCreateCreditNoteResponse: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The status of the push operation.""" + r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -69,7 +69,7 @@ class AccountingCreateCreditNoteResponse: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - data: Optional[shared_accountingcreditnote.AccountingCreditNote] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_accountingcreditnote.AccountingCreditNote] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) r"""> View the coverage for credit notes in the Data coverage explorer. ## Overview @@ -85,10 +85,15 @@ class AccountingCreateCreditNoteResponse: """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatecustomerresponse.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatecustomerresponse.py index bb60d89aa..acc4622fd 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatecustomerresponse.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatecustomerresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateCustomerResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -44,9 +43,10 @@ class AccountingCreateCustomerResponse: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The status of the push operation.""" + r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -69,7 +69,7 @@ class AccountingCreateCustomerResponse: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - data: Optional[shared_accountingcustomer.AccountingCustomer] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_accountingcustomer.AccountingCustomer] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) r"""> View the coverage for customers in the Data coverage explorer. ## Overview @@ -80,10 +80,15 @@ class AccountingCreateCustomerResponse: """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatedirectincomeresponse.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatedirectincomeresponse.py index f4bbe62a0..af5907417 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatedirectincomeresponse.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatedirectincomeresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateDirectIncomeResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -44,9 +43,10 @@ class AccountingCreateDirectIncomeResponse: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The status of the push operation.""" + r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -69,7 +69,7 @@ class AccountingCreateDirectIncomeResponse: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - data: Optional[shared_accountingdirectincome.AccountingDirectIncome] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_accountingdirectincome.AccountingDirectIncome] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) r"""> **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting platforms. > View the coverage for direct incomes in the Data coverage explorer. @@ -88,10 +88,15 @@ class AccountingCreateDirectIncomeResponse: """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreateinvoiceresponse.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreateinvoiceresponse.py index bdeedc3f9..4b53ae16f 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreateinvoiceresponse.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreateinvoiceresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateInvoiceResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -44,9 +43,10 @@ class AccountingCreateInvoiceResponse: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The status of the push operation.""" + r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -69,7 +69,7 @@ class AccountingCreateInvoiceResponse: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - data: Optional[shared_accountinginvoice.AccountingInvoice] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_accountinginvoice.AccountingInvoice] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) r"""> **Invoices or bills?** > > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice. @@ -102,10 +102,15 @@ class AccountingCreateInvoiceResponse: """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatejournalentryresponse.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatejournalentryresponse.py index 5cfde1bce..207b6e4e6 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatejournalentryresponse.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatejournalentryresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateJournalEntryResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -44,9 +43,10 @@ class AccountingCreateJournalEntryResponse: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The status of the push operation.""" + r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -69,7 +69,7 @@ class AccountingCreateJournalEntryResponse: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - data: Optional[shared_accountingjournalentry.AccountingJournalEntry] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_accountingjournalentry.AccountingJournalEntry] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) r"""> **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type > View the coverage for journal entries in the Data coverage explorer. @@ -95,10 +95,15 @@ class AccountingCreateJournalEntryResponse: """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatepaymentresponse.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatepaymentresponse.py index 37591d19c..cf23daf74 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatepaymentresponse.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreatepaymentresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreatePaymentResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -44,9 +43,10 @@ class AccountingCreatePaymentResponse: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The status of the push operation.""" + r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -69,7 +69,7 @@ class AccountingCreatePaymentResponse: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - data: Optional[shared_accountingpayment.AccountingPayment] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_accountingpayment.AccountingPayment] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) r"""> **Payments or bill payments?** > > In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/accounting-api#/schemas/Bill) and credit notes against bills. @@ -751,10 +751,15 @@ class AccountingCreatePaymentResponse: """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreditnote.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreditnote.py index 62252dd22..681d3863f 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreditnote.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcreditnote.py @@ -12,11 +12,10 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreditNote: r"""> View the coverage for credit notes in the Data coverage explorer. @@ -37,6 +36,7 @@ class AccountingCreditNote: remaining_credit: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('remainingCredit'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Unused balance of totalAmount originally raised.""" status: shared_creditnotestatus.CreditNoteStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + r"""Current state of the credit note.""" sub_total: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Value of the credit note, including discounts and excluding tax.""" total_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -46,7 +46,9 @@ class AccountingCreditNote: total_tax_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalTaxAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Any tax applied to the credit note amount.""" additional_tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('additionalTaxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""Additional tax amount applied to credit note.""" additional_tax_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('additionalTaxPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""Percentage rate of any additional tax applied to the credit note.""" allocated_on_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allocatedOnDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -68,7 +70,7 @@ class AccountingCreditNote: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - credit_note_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('creditNoteNumber'), 'exclude': lambda f: f is None }}) + credit_note_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('creditNoteNumber') }}) r"""Friendly reference for the credit note.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -79,7 +81,7 @@ class AccountingCreditNote: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -130,12 +132,12 @@ class AccountingCreditNote: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - line_items: Optional[list[shared_creditnotelineitem.CreditNoteLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems'), 'exclude': lambda f: f is None }}) + line_items: Optional[List[shared_creditnotelineitem.CreditNoteLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Any additional information about the credit note. Where possible, Codat links to a data field in the accounting platform that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting platform to the customer.""" - payment_allocations: Optional[list[shared_paymentallocationsitems.PaymentAllocationsitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations'), 'exclude': lambda f: f is None }}) + payment_allocations: Optional[List[shared_paymentallocationsitems.PaymentAllocationsitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) r"""An array of payment allocations.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) @@ -143,6 +145,6 @@ class AccountingCreditNote: It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ - withholding_tax: Optional[list[shared_withholdingtaxitems.WithholdingTaxitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax'), 'exclude': lambda f: f is None }}) + withholding_tax: Optional[List[shared_withholdingtaxitems.WithholdingTaxitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax') }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcustomer.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcustomer.py index 88ac1807a..1f2ba12ef 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcustomer.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcustomer.py @@ -9,11 +9,10 @@ from ..shared import supplementaldata as shared_supplementaldata from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCustomer: r"""> View the coverage for customers in the Data coverage explorer. @@ -26,13 +25,13 @@ class AccountingCustomer: """ status: shared_customerstatus.CustomerStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""Status of customer.""" - addresses: Optional[list[shared_items1.Items1]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) + addresses: Optional[List[shared_items1.Items1]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses') }}) r"""An array of Addresses.""" - contact_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactName'), 'exclude': lambda f: f is None }}) + contact_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactName') }}) r"""Name of the main contact for the identified customer.""" - contacts: Optional[list[shared_contact.Contact]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contacts'), 'exclude': lambda f: f is None }}) + contacts: Optional[List[shared_contact.Contact]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contacts') }}) r"""An array of Contacts.""" - customer_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerName'), 'exclude': lambda f: f is None }}) + customer_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerName') }}) r"""Name of the customer as recorded in the accounting system, typically the company name.""" default_currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('defaultCurrency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -43,15 +42,15 @@ class AccountingCustomer: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - email_address: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('emailAddress'), 'exclude': lambda f: f is None }}) + email_address: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('emailAddress') }}) r"""Email address the customer can be contacted by.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the customer, unique to the company in the accounting platform.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - phone: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone'), 'exclude': lambda f: f is None }}) + phone: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone') }}) r"""Phone number the customer can be contacted by.""" - registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber'), 'exclude': lambda f: f is None }}) + registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber') }}) r"""Company number. In the UK, this is typically the Companies House company registration number.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) @@ -59,7 +58,7 @@ class AccountingCustomer: It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ - tax_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxNumber'), 'exclude': lambda f: f is None }}) + tax_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxNumber') }}) r"""Company tax number.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcustomerref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcustomerref.py index 769b13bae..1a9ec170f 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcustomerref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingcustomerref.py @@ -8,12 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCustomerRef: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""`id` from the Customers data type""" - company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName'), 'exclude': lambda f: f is None }}) + company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName') }}) r"""`customerName` from the Customer data type""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingdirectincome.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingdirectincome.py index ed1a3c47d..ae2954875 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingdirectincome.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingdirectincome.py @@ -2,6 +2,7 @@ from __future__ import annotations import dataclasses +from ..shared import datatype as shared_datatype from ..shared import directincomelineitem as shared_directincomelineitem from ..shared import metadata as shared_metadata from ..shared import paymentallocationsitems as shared_paymentallocationsitems @@ -9,22 +10,22 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingDirectIncomeContactRef: r"""A customer or supplier associated with the direct income.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - data_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a customer or supplier.""" + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingDirectIncome: r"""> **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting platforms. @@ -73,9 +74,9 @@ class AccountingDirectIncome: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - line_items: list[shared_directincomelineitem.DirectIncomeLineItem] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) + line_items: List[shared_directincomelineitem.DirectIncomeLineItem] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) r"""An array of line items.""" - payment_allocations: list[shared_paymentallocationsitems.PaymentAllocationsitems] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) + payment_allocations: List[shared_paymentallocationsitems.PaymentAllocationsitems] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) sub_total: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""The total amount of the direct incomes, excluding any taxes.""" tax_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -84,7 +85,7 @@ class AccountingDirectIncome: r"""The amount of the direct incomes, inclusive of tax.""" contact_ref: Optional[AccountingDirectIncomeContactRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactRef'), 'exclude': lambda f: f is None }}) r"""A customer or supplier associated with the direct income.""" - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -115,8 +116,9 @@ class AccountingDirectIncome: r"""Identifier of the direct income, unique for the company.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) - reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) + r"""An optional note on the direct income that can be used to assign the direct income with a reference ID in your application.""" + reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference') }}) r"""User-friendly reference for the direct income.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountinginvoice.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountinginvoice.py index 284f2aef9..107abc332 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountinginvoice.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountinginvoice.py @@ -3,6 +3,7 @@ from __future__ import annotations import dataclasses from ..shared import accountingcustomerref as shared_accountingcustomerref +from ..shared import datatype as shared_datatype from ..shared import invoicelineitem as shared_invoicelineitem from ..shared import invoicestatus as shared_invoicestatus from ..shared import metadata as shared_metadata @@ -11,11 +12,10 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingInvoicePaymentAllocationAllocation: allocated_on_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allocatedOnDate'), 'exclude': lambda f: f is None }}) @@ -48,7 +48,7 @@ class AccountingInvoicePaymentAllocationAllocation: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -82,7 +82,6 @@ class AccountingInvoicePaymentAllocationAllocation: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingInvoicePaymentAllocation: allocation: AccountingInvoicePaymentAllocationAllocation = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allocation') }}) @@ -92,27 +91,28 @@ class AccountingInvoicePaymentAllocation: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingInvoiceSalesOrderReference: - data_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + r"""Unique identifier to a record in `dataType`.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingInvoiceWithholdingTax: amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) + r"""Amount of tax withheld.""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""Name assigned to withheld tax.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingInvoice: r"""> **Invoices or bills?** @@ -182,7 +182,9 @@ class AccountingInvoice: total_tax_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalTaxAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Amount of tax on the invoice.""" additional_tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('additionalTaxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""Additional tax amount applied to invoice.""" additional_tax_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('additionalTaxPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""Percentage rate of any additional tax applied to the invoice.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -192,7 +194,7 @@ class AccountingInvoice: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -220,7 +222,7 @@ class AccountingInvoice: | **RUB** | ₽20 | 0.015 | $0.30 | """ customer_ref: Optional[shared_accountingcustomerref.AccountingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) - discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Percentage rate (from 0 to 100) of discounts applied to the invoice. For example: A 5% discount will return a value of `5`, not `0.05`.""" due_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dueDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -245,13 +247,13 @@ class AccountingInvoice: """ id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the invoice, unique to the company in the accounting platform.""" - invoice_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoiceNumber'), 'exclude': lambda f: f is None }}) + invoice_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoiceNumber') }}) r"""Friendly reference for the invoice. If available, this appears in the file name of invoice attachments.""" - line_items: Optional[list[shared_invoicelineitem.InvoiceLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems'), 'exclude': lambda f: f is None }}) + line_items: Optional[List[shared_invoicelineitem.InvoiceLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) r"""An array of line items.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Any additional information about the invoice. Where possible, Codat links to a data field in the accounting platform that is publicly available. This means that the contents of the note field are included when an invoice is emailed from the accounting platform to the customer.""" paid_on_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paidOnDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -274,20 +276,20 @@ class AccountingInvoice: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - payment_allocations: Optional[list[AccountingInvoicePaymentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations'), 'exclude': lambda f: f is None }}) + payment_allocations: Optional[List[AccountingInvoicePaymentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) r"""An array of payment allocations.""" - sales_order_refs: Optional[list[AccountingInvoiceSalesOrderReference]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('salesOrderRefs'), 'exclude': lambda f: f is None }}) + sales_order_refs: Optional[List[AccountingInvoiceSalesOrderReference]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('salesOrderRefs') }}) r"""List of references to related Sales orders.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) - sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Total amount of the invoice excluding any taxes.""" supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) r"""Supplemental data is additional data you can include in our standard data types. It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ - total_discount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalDiscount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + total_discount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalDiscount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Numerical value of discounts applied to the invoice.""" - withholding_tax: Optional[list[AccountingInvoiceWithholdingTax]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax'), 'exclude': lambda f: f is None }}) + withholding_tax: Optional[List[AccountingInvoiceWithholdingTax]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax') }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingjournalentry.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingjournalentry.py index 8485bbf58..18e551df3 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingjournalentry.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingjournalentry.py @@ -7,24 +7,22 @@ from ..shared import supplementaldata as shared_supplementaldata from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingJournalEntryJournalReference: r"""Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals).""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""GUID of the underlying journal.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of journal""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingJournalEntryRecordReference: r"""Links the current record to the underlying record or data type that created it. @@ -40,7 +38,6 @@ class AccountingJournalEntryRecordReference: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingJournalEntry: r"""> **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type @@ -87,11 +84,11 @@ class AccountingJournalEntry: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Optional description of the journal entry.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Unique identifier of the journal entry for the company in the accounting platform.""" - journal_lines: Optional[list[shared_journalline.JournalLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('journalLines'), 'exclude': lambda f: f is None }}) + journal_lines: Optional[List[shared_journalline.JournalLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('journalLines') }}) r"""An array of journal lines.""" journal_ref: Optional[AccountingJournalEntryJournalReference] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('journalRef'), 'exclude': lambda f: f is None }}) r"""Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals).""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingpayment.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingpayment.py index 6d42f8111..f7327df9f 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingpayment.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountingpayment.py @@ -6,15 +6,15 @@ from ..shared import accountref as shared_accountref from ..shared import metadata as shared_metadata from ..shared import paymentline as shared_paymentline +from ..shared import paymentmethodref as shared_paymentmethodref from ..shared import supplementaldata as shared_supplementaldata from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Any, Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingPayment: r"""> **Payments or bill payments?** @@ -728,7 +728,7 @@ class AccountingPayment: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -758,14 +758,15 @@ class AccountingPayment: customer_ref: Optional[shared_accountingcustomerref.AccountingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the payment, unique to the company in the accounting platform.""" - lines: Optional[list[shared_paymentline.PaymentLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines'), 'exclude': lambda f: f is None }}) + lines: Optional[List[shared_paymentline.PaymentLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines') }}) r"""An array of payment lines.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Any additional information associated with the payment.""" - payment_method_ref: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentMethodRef'), 'exclude': lambda f: f is None }}) - reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference'), 'exclude': lambda f: f is None }}) + payment_method_ref: Optional[shared_paymentmethodref.PaymentMethodRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentMethodRef'), 'exclude': lambda f: f is None }}) + r"""The payment method the record is linked to in the accounting or commerce platform.""" + reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference') }}) r"""Friendly reference for the payment.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountoption.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountoption.py index 4dbe34cef..e708c59cb 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountoption.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountoption.py @@ -8,16 +8,15 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountOption: - classification: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classification'), 'exclude': lambda f: f is None }}) + classification: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classification') }}) r"""Classification of the type of G/L account.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the account, unique for the company.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of the account.""" - nominal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('nominalCode'), 'exclude': lambda f: f is None }}) + nominal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('nominalCode') }}) r"""Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountref.py index 9e0359b36..67e6ed7d4 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/accountref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountRef: r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/billedtotype.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/billedtotype.py index 540981bf1..a9b9974a6 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/billedtotype.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/billedtotype.py @@ -4,6 +4,7 @@ from enum import Enum class BilledToType(str, Enum): + r"""Defines if the bill or bill credit note is billed/rebilled to a project.""" UNKNOWN = 'Unknown' NOT_APPLICABLE = 'NotApplicable' PROJECT = 'Project' diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/branding.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/branding.py index 0231d9446..af0befba5 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/branding.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/branding.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Branding: button: Optional[shared_brandingbutton.BrandingButton] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('button'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandingbutton.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandingbutton.py index d3b60c62c..720f8ed1d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandingbutton.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandingbutton.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BrandingButton: r"""Button branding references.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandingimage.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandingimage.py index 4c8493f55..3f34e4432 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandingimage.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandingimage.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BrandingImage: image: Optional[shared_imagereference.ImageReference] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('image'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandinglogo.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandinglogo.py index 515ed229b..19e1a4473 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandinglogo.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/brandinglogo.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BrandingLogo: r"""Logo branding references.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecompanyinfo.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecompanyinfo.py index 47f3ca831..4ba0f583a 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecompanyinfo.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecompanyinfo.py @@ -8,11 +8,10 @@ from ..shared import weblinksitems as shared_weblinksitems from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import Dict, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceCompanyInfo: r"""In the Codat system, company information includes standard commercial details about @@ -20,9 +19,9 @@ class CommerceCompanyInfo: Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=companyInfo) for this data type. """ - account_balances: Optional[list[shared_accountbalance.AccountBalance]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountBalances'), 'exclude': lambda f: f is None }}) + account_balances: Optional[List[shared_accountbalance.AccountBalance]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountBalances'), 'exclude': lambda f: f is None }}) r"""The available and current cash balances for the company's accounts""" - addresses: Optional[list[shared_items.Items]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) + addresses: Optional[List[shared_items.Items]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) r"""Addresses associated with the company""" base_currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('baseCurrency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -61,14 +60,14 @@ class CommerceCompanyInfo: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - phone_numbers: Optional[list[shared_phonenumbersitems.PhoneNumbersitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phoneNumbers'), 'exclude': lambda f: f is None }}) + phone_numbers: Optional[List[shared_phonenumbersitems.PhoneNumbersitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phoneNumbers'), 'exclude': lambda f: f is None }}) r"""Phone numbers associated with the company""" registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber'), 'exclude': lambda f: f is None }}) r"""The registration number of the company""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) - source_urls: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceUrls'), 'exclude': lambda f: f is None }}) + source_urls: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceUrls'), 'exclude': lambda f: f is None }}) r"""URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system""" - web_links: Optional[list[shared_weblinksitems.WebLinksitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('webLinks'), 'exclude': lambda f: f is None }}) + web_links: Optional[List[shared_weblinksitems.WebLinksitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('webLinks'), 'exclude': lambda f: f is None }}) r"""Weblinks associated with the company""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomer.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomer.py index 840e51af1..b7d31f7d8 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomer.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomer.py @@ -5,11 +5,10 @@ from ..shared import commerceaddresstype as shared_commerceaddresstype from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceCustomerAddress: city: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('city'), 'exclude': lambda f: f is None }}) @@ -31,7 +30,6 @@ class CommerceCustomerAddress: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceCustomer: r"""When a customer places an order with the connected commerce store their details are added to the Customers dataset. You can use the data from the Customers endpoints to calculate key metrics, such as customer churn. @@ -40,7 +38,7 @@ class CommerceCustomer: """ id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""A unique, persistent identifier for this record""" - addresses: Optional[list[CommerceCustomerAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) + addresses: Optional[List[CommerceCustomerAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) r"""Addresses of the customer""" created_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('createdDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -71,7 +69,7 @@ class CommerceCustomer: modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) r"""Any additional information about the customer""" - phone: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone'), 'exclude': lambda f: f is None }}) + phone: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone') }}) r"""A phone number.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomerref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomerref.py index ed91e7d15..a70c5abe5 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomerref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomerref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceCustomerRef: r"""Reference to the customer that placed the order.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomers.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomers.py index 1175af53a..cd8807e2a 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomers.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercecustomers.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceCustomers: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commercecustomer.CommerceCustomer]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commercecustomer.CommerceCustomer]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercelocation.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercelocation.py index c3e983938..b073bff22 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercelocation.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercelocation.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceLocation: r"""The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type. diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercelocations.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercelocations.py index f13c801c2..7312d6bdc 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercelocations.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercelocations.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceLocations: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commercelocation.CommerceLocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commercelocation.CommerceLocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceorder.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceorder.py index 66db3732d..569db470f 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceorder.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceorder.py @@ -7,27 +7,14 @@ from ..shared import orderlineitem as shared_orderlineitem from ..shared import paymentref as shared_paymentref from ..shared import servicecharge as shared_servicecharge +from ..shared import supplementaldata as shared_supplementaldata from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Any, Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class CommerceOrderSupplementalData: - r"""Supplemental data is additional data you can include in our standard data types. - - It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. - """ - content: Optional[dict[str, dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('content'), 'exclude': lambda f: f is None }}) - - - - -@dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceOrder: r"""Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR). @@ -91,25 +78,25 @@ class CommerceOrder: location_ref: Optional[shared_locationref.LocationRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('locationRef'), 'exclude': lambda f: f is None }}) r"""Reference to the geographic location where the order was placed.""" modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - order_line_items: Optional[list[shared_orderlineitem.OrderLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('orderLineItems'), 'exclude': lambda f: f is None }}) + order_line_items: Optional[List[shared_orderlineitem.OrderLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('orderLineItems'), 'exclude': lambda f: f is None }}) order_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('orderNumber'), 'exclude': lambda f: f is None }}) r"""Friendly reference for the order in the commerce or point of sale platform.""" - payments: Optional[list[shared_paymentref.PaymentRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payments'), 'exclude': lambda f: f is None }}) - service_charges: Optional[list[shared_servicecharge.ServiceCharge]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('serviceCharges'), 'exclude': lambda f: f is None }}) + payments: Optional[List[shared_paymentref.PaymentRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payments'), 'exclude': lambda f: f is None }}) + service_charges: Optional[List[shared_servicecharge.ServiceCharge]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('serviceCharges'), 'exclude': lambda f: f is None }}) source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) - supplemental_data: Optional[CommerceOrderSupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) r"""Supplemental data is additional data you can include in our standard data types. It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total amount of the order, including tax, net of any discounts and refunds.""" + r"""Total amount of the order, including discounts, refunds, and tax, but excluding gratuities.""" total_discount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalDiscount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total amount of discount applied to the order.""" + r"""Total amount of any discounts applied to the order, excluding tax. This is typically positive (for discounts which decrease the amount of the order), but can also be negative (for discounts which increase the amount of the order).""" total_gratuity: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalGratuity'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Extra amount added to a bill.""" + r"""Extra amount added to the order.""" total_refund: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalRefund'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total amount refunded issued by a merchant on an order (always a negative value).""" + r"""Total amount of any refunds issued on the order, including discounts and tax, but excluding gratuities. This is always negative.""" total_tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalTaxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Total amount of tax applied to the order.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceorders.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceorders.py index d7d5f3df4..36ef405e7 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceorders.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceorders.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceOrders: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commerceorder.CommerceOrder]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commerceorder.CommerceOrder]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepayment.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepayment.py index 69f66591c..b0115af07 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepayment.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepayment.py @@ -2,15 +2,16 @@ from __future__ import annotations import dataclasses +from ..shared import paymentmethodref as shared_paymentmethodref from ..shared import paymentstatus as shared_paymentstatus +from ..shared import supplementaldata as shared_supplementaldata from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Any, Optional +from typing import Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommercePayment: r"""Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status. @@ -77,11 +78,17 @@ class CommercePayment: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - payment_method_ref: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentMethodRef'), 'exclude': lambda f: f is None }}) + payment_method_ref: Optional[shared_paymentmethodref.PaymentMethodRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentMethodRef'), 'exclude': lambda f: f is None }}) + r"""The payment method the record is linked to in the accounting or commerce platform.""" payment_provider: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentProvider'), 'exclude': lambda f: f is None }}) r"""Service provider of the payment, if applicable.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_paymentstatus.PaymentStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Status of the payment.""" + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepaymentmethod.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepaymentmethod.py index a8665431e..c40d05c82 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepaymentmethod.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepaymentmethod.py @@ -2,14 +2,19 @@ from __future__ import annotations import dataclasses -from ..shared import paymentmethodstatus as shared_paymentmethodstatus from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json +from enum import Enum from typing import Optional +class CommercePaymentMethodStatus(str, Enum): + r"""Status of the Payment Method.""" + UNKNOWN = 'Unknown' + ACTIVE = 'Active' + ARCHIVED = 'Archived' -@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class CommercePaymentMethod: r"""A Payment Method represents the payment method(s) used to make payments. @@ -22,7 +27,7 @@ class CommercePaymentMethod: name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""The name of the PaymentMethod""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) - status: Optional[shared_paymentmethodstatus.PaymentMethodStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) - r"""Status of the Payment Method""" + status: Optional[CommercePaymentMethodStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) + r"""Status of the Payment Method.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepaymentmethods.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepaymentmethods.py index 95ad95fb3..eab986743 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepaymentmethods.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepaymentmethods.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommercePaymentMethods: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commercepaymentmethod.CommercePaymentMethod]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commercepaymentmethod.CommercePaymentMethod]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepayments.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepayments.py index 4044783f7..436b29fc0 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepayments.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercepayments.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommercePayments: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commercepayment.CommercePayment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commercepayment.CommercePayment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceproduct.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceproduct.py index 7a6943c4c..0a7b27f3c 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceproduct.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceproduct.py @@ -3,13 +3,13 @@ from __future__ import annotations import dataclasses from ..shared import productvariant as shared_productvariant +from ..shared import supplementaldata as shared_supplementaldata from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceProduct: r"""A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale. @@ -19,15 +19,20 @@ class CommerceProduct: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""A unique, persistent identifier for this record""" categorization: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categorization'), 'exclude': lambda f: f is None }}) - r"""Retail category that the product is assigned to""" + r"""Retail category that the product is assigned to e.g. `Hardware`.""" description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) r"""Description of the product recorded in the commerce or point of sale platform.""" is_gift_card: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isGiftCard'), 'exclude': lambda f: f is None }}) r"""Whether the product represents a gift card or voucher that - can be redeemed in the commerce or POS platform + can be redeemed in the commerce or POS platform. """ name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""Name of the product in the commerce or POS system""" - variants: Optional[list[shared_productvariant.ProductVariant]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('variants'), 'exclude': lambda f: f is None }}) + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ + variants: Optional[List[shared_productvariant.ProductVariant]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('variants'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceproducts.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceproducts.py index 2d4d19923..d8c6c4da4 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceproducts.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commerceproducts.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceProducts: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commerceproduct.CommerceProduct]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commerceproduct.CommerceProduct]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercetransaction.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercetransaction.py index ff37723f0..f5298175d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercetransaction.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercetransaction.py @@ -2,6 +2,7 @@ from __future__ import annotations import dataclasses +from ..shared import supplementaldata as shared_supplementaldata from ..shared import transactionsourceref as shared_transactionsourceref from ..shared import transactiontype as shared_transactiontype from codatsynccommerce import utils @@ -11,7 +12,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceTransaction: r"""Details of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type. For example, payments, service charges, and fees. @@ -82,6 +82,11 @@ class CommerceTransaction: source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) sub_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subType'), 'exclude': lambda f: f is None }}) r"""Non-standardised transaction type data from the commerce platform""" + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""The total transaction amount""" transaction_source_ref: Optional[shared_transactionsourceref.TransactionSourceRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactionSourceRef'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercetransactions.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercetransactions.py index 57ed4cc62..4751e10d3 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercetransactions.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/commercetransactions.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceTransactions: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commercetransaction.CommerceTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commercetransaction.CommerceTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/companies.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/companies.py index 9eb74e0da..7717edab3 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/companies.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/companies.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Companies: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_company.Company]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_company.Company]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/company.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/company.py index 79d11d20e..3705be1f3 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/company.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/company.py @@ -5,11 +5,10 @@ from ..shared import connection as shared_connection from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Company: r"""In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/sync-for-commerce-v1-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data. @@ -46,7 +45,8 @@ class Company: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ created_by_user_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('createdByUserName'), 'exclude': lambda f: f is None }}) - data_connections: Optional[list[shared_connection.Connection]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnections'), 'exclude': lambda f: f is None }}) + r"""Name of user that created the company in Codat.""" + data_connections: Optional[List[shared_connection.Connection]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnections'), 'exclude': lambda f: f is None }}) description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) r"""Additional information about the company. This can be used to store foreign IDs, references, etc.""" last_sync: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lastSync'), 'exclude': lambda f: f is None }}) @@ -71,6 +71,9 @@ class Company: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ platform: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('platform'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + r"""`platformKeys` name used when creating the company. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/configaccount.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/configaccount.py index 39bc9635a..2ac5c7489 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/configaccount.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/configaccount.py @@ -5,23 +5,22 @@ from ..shared import accountoption as shared_accountoption from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ConfigAccount: r"""G/L account object for configuration.""" - account_options: Optional[list[shared_accountoption.AccountOption]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountOptions'), 'exclude': lambda f: f is None }}) + account_options: Optional[List[shared_accountoption.AccountOption]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountOptions') }}) r"""Object containing account options.""" - description_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('descriptionText'), 'exclude': lambda f: f is None }}) + description_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('descriptionText') }}) r"""Descriprtive text for sales configuration section.""" - label_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('labelText'), 'exclude': lambda f: f is None }}) + label_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('labelText') }}) r"""Label text for sales configuration section.""" required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) r"""Required section to be configured for sync.""" - selected_account_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedAccountId'), 'exclude': lambda f: f is None }}) + selected_account_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedAccountId') }}) r"""Selected account id from the list of available accounts.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/configuration.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/configuration.py index a6841359a..1440380a1 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/configuration.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/configuration.py @@ -12,7 +12,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Configuration: fees: Optional[shared_fees.Fees] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fees'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/connection.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/connection.py index b7942f8d5..ee1222ec7 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/connection.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/connection.py @@ -7,7 +7,7 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum -from typing import Any, Optional +from typing import Any, Dict, List, Optional class ConnectionSourceType(str, Enum): r"""The type of platform of the connection.""" @@ -19,7 +19,6 @@ class ConnectionSourceType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Connection: r"""A connection represents a [company's](https://docs.codat.io/sync-for-commerce-v1-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source. @@ -61,7 +60,9 @@ class Connection: integration_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('integrationKey') }}) r"""A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future.""" link_url: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('linkUrl') }}) + r"""The link URL your customers can use to authorize access to their business application.""" platform_name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('platformName') }}) + r"""Name of integration connected to company.""" source_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceId') }}) r"""A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.""" source_type: ConnectionSourceType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) @@ -69,8 +70,8 @@ class Connection: status: shared_dataconnectionstatus.DataConnectionStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""The current authorization status of the data connection.""" additional_properties: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('additionalProperties'), 'exclude': lambda f: f is None }}) - connection_info: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionInfo'), 'exclude': lambda f: f is None }}) - data_connection_errors: Optional[list[shared_dataconnectionerror.DataConnectionError]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionErrors'), 'exclude': lambda f: f is None }}) + connection_info: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionInfo'), 'exclude': lambda f: f is None }}) + data_connection_errors: Optional[List[shared_dataconnectionerror.DataConnectionError]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionErrors'), 'exclude': lambda f: f is None }}) last_sync: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lastSync'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/connections.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/connections.py index a0b61c196..def95fc1c 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/connections.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/connections.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Connections: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_connection.Connection]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_connection.Connection]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/contact.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/contact.py index 520b30ce2..7d1730a96 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/contact.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/contact.py @@ -7,17 +7,16 @@ from ..shared import phonenumbersitems as shared_phonenumbersitems from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Contact: status: shared_customerstatus.CustomerStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""Status of customer.""" address: Optional[shared_items1.Items1] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('address'), 'exclude': lambda f: f is None }}) - email: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('email'), 'exclude': lambda f: f is None }}) + email: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('email') }}) r"""Email of a contact for a customer.""" modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -40,9 +39,9 @@ class Contact: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of a contact for a customer.""" - phone: Optional[list[shared_phonenumbersitems.PhoneNumbersitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone'), 'exclude': lambda f: f is None }}) + phone: Optional[List[shared_phonenumbersitems.PhoneNumbersitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone') }}) r"""An array of Phone numbers.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/createcompany.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/createcompany.py index 105191212..ad01498ef 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/createcompany.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/createcompany.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CreateCompany: name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/creditnotelineitem.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/creditnotelineitem.py index 07b41f443..742ea9718 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/creditnotelineitem.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/creditnotelineitem.py @@ -12,27 +12,29 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CreditNoteLineItemTrackingProjectReference: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + r"""Unique identifier to the project reference.""" + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""The project's name.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CreditNoteLineItemTracking: r"""Categories, and a project and customer, against which the item is tracked.""" - category_refs: list[shared_trackingcategoryrefsitems.TrackingCategoryRefsitems] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categoryRefs') }}) + category_refs: List[shared_trackingcategoryrefsitems.TrackingCategoryRefsitems] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categoryRefs') }}) is_billed_to: shared_billedtotype.BilledToType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isBilledTo') }}) + r"""Defines if the bill or bill credit note is billed/rebilled to a project.""" is_rebilled_to: shared_billedtotype.BilledToType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isRebilledTo') }}) + r"""Defines if the bill or bill credit note is billed/rebilled to a project.""" customer_ref: Optional[shared_accountingcustomerref.AccountingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) project_ref: Optional[CreditNoteLineItemTrackingProjectReference] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('projectRef'), 'exclude': lambda f: f is None }}) record_ref: Optional[shared_recordref.RecordRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRef'), 'exclude': lambda f: f is None }}) @@ -45,7 +47,6 @@ class CreditNoteLineItemTracking: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CreditNoteLineItem: quantity: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -54,26 +55,27 @@ class CreditNoteLineItem: r"""Unit price of the goods or service.""" account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Friendly name of each line item. For example, the goods or service for which credit has been issued.""" - discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Value of any discounts applied.""" - discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Percentage rate of any discount applied to the line item.""" is_direct_income: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDirectIncome'), 'exclude': lambda f: f is None }}) + r"""The credit note is a direct income if `True`.""" item_ref: Optional[shared_itemref.ItemRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) r"""Reference to the product, service type, or inventory item to which the direct cost is linked.""" - sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of credit associated with the line item, including discounts but excluding tax.""" - tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of tax associated with the line item.""" tax_rate_ref: Optional[shared_taxrateref.TaxRateRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateRef'), 'exclude': lambda f: f is None }}) r"""Reference to the tax rate to which the line item is linked.""" - total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Total amount of the line item, including discounts and tax.""" tracking: Optional[CreditNoteLineItemTracking] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tracking'), 'exclude': lambda f: f is None }}) r"""Categories, and a project and customer, against which the item is tracked.""" - tracking_category_refs: Optional[list[shared_trackingcategoryrefsitems.TrackingCategoryRefsitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs'), 'exclude': lambda f: f is None }}) + tracking_category_refs: Optional[List[shared_trackingcategoryrefsitems.TrackingCategoryRefsitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs') }}) r"""Reference to the tracking categories to which the line item is linked. Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/creditnotestatus.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/creditnotestatus.py index df12ba166..adbebfef0 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/creditnotestatus.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/creditnotestatus.py @@ -4,6 +4,7 @@ from enum import Enum class CreditNoteStatus(str, Enum): + r"""Current state of the credit note.""" UNKNOWN = 'Unknown' DRAFT = 'Draft' SUBMITTED = 'Submitted' diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/customer.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/customer.py index b7e4aeb98..d7fa83c0c 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/customer.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/customer.py @@ -5,16 +5,15 @@ from ..shared import option as shared_option from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Customer: - customer_options: Optional[list[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerOptions'), 'exclude': lambda f: f is None }}) + customer_options: Optional[List[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerOptions') }}) r"""List of customer options from the list of customer records on the accounting software.""" - selected_customer_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedCustomerId'), 'exclude': lambda f: f is None }}) + selected_customer_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedCustomerId') }}) r"""Selected customer id from the list of customer records on the accounting software.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/dataconnectionerror.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/dataconnectionerror.py index 940b51d0f..b960aa146 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/dataconnectionerror.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/dataconnectionerror.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataConnectionError: errored_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('erroredOnUtc'), 'exclude': lambda f: f is None }}) @@ -33,7 +32,10 @@ class DataConnectionError: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) + r"""A brief message about the error.""" status_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode'), 'exclude': lambda f: f is None }}) + r"""The HTTP status code returned by the error.""" status_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusText'), 'exclude': lambda f: f is None }}) + r"""A non-numeric status code/text.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/dataset.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/dataset.py index 476deefaf..8f670d1a5 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/dataset.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/dataset.py @@ -2,45 +2,73 @@ from __future__ import annotations import dataclasses +from ..shared import datasetstatus as shared_datasetstatus from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Optional -class DatasetStatus(str, Enum): - INITIAL = 'Initial' - QUEUED = 'Queued' - FETCHING = 'Fetching' - MAP_QUEUED = 'MapQueued' - MAPPING = 'Mapping' - COMPLETE = 'Complete' - FETCH_ERROR = 'FetchError' - MAP_ERROR = 'MapError' - INTERNAL_ERROR = 'InternalError' - PROCESSING_QUEUED = 'ProcessingQueued' - PROCESSING = 'Processing' - PROCESSING_ERROR = 'ProcessingError' - VALIDATION_QUEUED = 'ValidationQueued' - VALIDATING = 'Validating' - VALIDATION_ERROR = 'ValidationError' - AUTH_ERROR = 'AuthError' - CANCELLED = 'Cancelled' - NOT_SUPPORTED = 'NotSupported' - RATE_LIMIT_ERROR = 'RateLimitError' - PERMISSIONS_ERROR = 'PermissionsError' - PREREQUISITE_NOT_MET = 'PrerequisiteNotMet' +class DatasetDataTypes(str, Enum): + r"""Available Data types""" + ACCOUNT_TRANSACTIONS = 'accountTransactions' + BALANCE_SHEET = 'balanceSheet' + BANK_ACCOUNTS = 'bankAccounts' + BANK_TRANSACTIONS = 'bankTransactions' + BILL_CREDIT_NOTES = 'billCreditNotes' + BILL_PAYMENTS = 'billPayments' + BILLS = 'bills' + CASH_FLOW_STATEMENT = 'cashFlowStatement' + CHART_OF_ACCOUNTS = 'chartOfAccounts' + COMPANY = 'company' + CREDIT_NOTES = 'creditNotes' + CUSTOMERS = 'customers' + DIRECT_COSTS = 'directCosts' + DIRECT_INCOMES = 'directIncomes' + INVOICES = 'invoices' + ITEMS = 'items' + JOURNAL_ENTRIES = 'journalEntries' + JOURNALS = 'journals' + PAYMENT_METHODS = 'paymentMethods' + PAYMENTS = 'payments' + PROFIT_AND_LOSS = 'profitAndLoss' + PURCHASE_ORDERS = 'purchaseOrders' + SALES_ORDERS = 'salesOrders' + SUPPLIERS = 'suppliers' + TAX_RATES = 'taxRates' + TRACKING_CATEGORIES = 'trackingCategories' + TRANSFERS = 'transfers' + BANKING_ACCOUNT_BALANCES = 'banking-accountBalances' + BANKING_ACCOUNTS = 'banking-accounts' + BANKING_TRANSACTION_CATEGORIES = 'banking-transactionCategories' + BANKING_TRANSACTIONS = 'banking-transactions' + COMMERCE_COMPANY_INFO = 'commerce-companyInfo' + COMMERCE_CUSTOMERS = 'commerce-customers' + COMMERCE_DISPUTES = 'commerce-disputes' + COMMERCE_LOCATIONS = 'commerce-locations' + COMMERCE_ORDERS = 'commerce-orders' + COMMERCE_PAYMENT_METHODS = 'commerce-paymentMethods' + COMMERCE_PAYMENTS = 'commerce-payments' + COMMERCE_PRODUCT_CATEGORIES = 'commerce-productCategories' + COMMERCE_PRODUCTS = 'commerce-products' + COMMERCE_TAX_COMPONENTS = 'commerce-taxComponents' + COMMERCE_TRANSACTIONS = 'commerce-transactions' @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Dataset: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) + r"""Unique identifier for your SMB in Codat.""" connection_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionId') }}) + r"""Unique identifier for a company's data connection.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) + r"""Identifier for the dataset.""" is_completed: bool = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isCompleted') }}) + r"""`True` if the dataset completed successfully.""" is_errored: bool = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isErrored') }}) + r"""`True` if the dataset entered an error state.""" progress: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('progress') }}) + r"""An integer signifying the progress of the dataset.""" requested: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('requested') }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -62,7 +90,8 @@ class Dataset: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - status: DatasetStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + status: shared_datasetstatus.DatasetStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + r"""The current status of the dataset.""" completed: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completed'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -84,9 +113,13 @@ class Dataset: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - dataset_logs_url: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetLogsUrl'), 'exclude': lambda f: f is None }}) - data_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - validation_information_url: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validationInformationUrl'), 'exclude': lambda f: f is None }}) + dataset_logs_url: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetLogsUrl') }}) + r"""URI to the dataset's logs.""" + data_type: Optional[DatasetDataTypes] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A brief message about the error.""" + validation_information_url: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validationInformationUrl') }}) + r"""URI to the dataset's validation information.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/datasetstatus.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/datasetstatus.py new file mode 100755 index 000000000..dcf6a58d3 --- /dev/null +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/datasetstatus.py @@ -0,0 +1,28 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +from enum import Enum + +class DatasetStatus(str, Enum): + r"""The current status of the dataset.""" + INITIAL = 'Initial' + QUEUED = 'Queued' + FETCHING = 'Fetching' + MAP_QUEUED = 'MapQueued' + MAPPING = 'Mapping' + COMPLETE = 'Complete' + FETCH_ERROR = 'FetchError' + MAP_ERROR = 'MapError' + INTERNAL_ERROR = 'InternalError' + PROCESSING_QUEUED = 'ProcessingQueued' + PROCESSING = 'Processing' + PROCESSING_ERROR = 'ProcessingError' + VALIDATION_QUEUED = 'ValidationQueued' + VALIDATING = 'Validating' + VALIDATION_ERROR = 'ValidationError' + AUTH_ERROR = 'AuthError' + CANCELLED = 'Cancelled' + NOT_SUPPORTED = 'NotSupported' + RATE_LIMIT_ERROR = 'RateLimitError' + PERMISSIONS_ERROR = 'PermissionsError' + PREREQUISITE_NOT_MET = 'PrerequisiteNotMet' diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/datastatus.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/datastatus.py index 1150ef889..f11c95977 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/datastatus.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/datastatus.py @@ -2,18 +2,20 @@ from __future__ import annotations import dataclasses +from ..shared import datatype as shared_datatype from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataStatus: r"""Describes the state of data in the Codat cache for a company and data type""" current_status: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currentStatus') }}) - data_type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType') }}) + r"""The current status of the dataset in Codat's cache.""" + data_type: shared_datatype.DataType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType') }}) + r"""Available Data types""" last_successful_sync: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lastSuccessfulSync') }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -36,6 +38,8 @@ class DataStatus: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ latest_successful_sync_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('latestSuccessfulSyncId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for the most recent successful sync of data type.""" latest_sync_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('latestSyncId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for most recent sync of data type.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/datatypefeature.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/datatypefeature.py index 712bec761..477868070 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/datatypefeature.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/datatypefeature.py @@ -2,65 +2,19 @@ from __future__ import annotations import dataclasses +from ..shared import datatype as shared_datatype from ..shared import supportedfeature as shared_supportedfeature from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Optional - -class DataTypeFeatureDataTypes(str, Enum): - r"""Available Data types""" - ACCOUNT_TRANSACTIONS = 'accountTransactions' - BALANCE_SHEET = 'balanceSheet' - BANK_ACCOUNTS = 'bankAccounts' - BANK_TRANSACTIONS = 'bankTransactions' - BILL_CREDIT_NOTES = 'billCreditNotes' - BILL_PAYMENTS = 'billPayments' - BILLS = 'bills' - CASH_FLOW_STATEMENT = 'cashFlowStatement' - CHART_OF_ACCOUNTS = 'chartOfAccounts' - COMPANY = 'company' - CREDIT_NOTES = 'creditNotes' - CUSTOMERS = 'customers' - DIRECT_COSTS = 'directCosts' - DIRECT_INCOMES = 'directIncomes' - INVOICES = 'invoices' - ITEMS = 'items' - JOURNAL_ENTRIES = 'journalEntries' - JOURNALS = 'journals' - PAYMENT_METHODS = 'paymentMethods' - PAYMENTS = 'payments' - PROFIT_AND_LOSS = 'profitAndLoss' - PURCHASE_ORDERS = 'purchaseOrders' - SALES_ORDERS = 'salesOrders' - SUPPLIERS = 'suppliers' - TAX_RATES = 'taxRates' - TRACKING_CATEGORIES = 'trackingCategories' - TRANSFERS = 'transfers' - BANKING_ACCOUNT_BALANCES = 'banking-accountBalances' - BANKING_ACCOUNTS = 'banking-accounts' - BANKING_TRANSACTION_CATEGORIES = 'banking-transactionCategories' - BANKING_TRANSACTIONS = 'banking-transactions' - COMMERCE_COMPANY_INFO = 'commerce-companyInfo' - COMMERCE_CUSTOMERS = 'commerce-customers' - COMMERCE_DISPUTES = 'commerce-disputes' - COMMERCE_LOCATIONS = 'commerce-locations' - COMMERCE_ORDERS = 'commerce-orders' - COMMERCE_PAYMENT_METHODS = 'commerce-paymentMethods' - COMMERCE_PAYMENTS = 'commerce-payments' - COMMERCE_PRODUCT_CATEGORIES = 'commerce-productCategories' - COMMERCE_PRODUCTS = 'commerce-products' - COMMERCE_TAX_COMPONENTS = 'commerce-taxComponents' - COMMERCE_TRANSACTIONS = 'commerce-transactions' +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataTypeFeature: r"""Describes support for a given datatype and associated operations""" - supported_features: list[shared_supportedfeature.SupportedFeature] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supportedFeatures') }}) - data_type: Optional[DataTypeFeatureDataTypes] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + supported_features: List[shared_supportedfeature.SupportedFeature] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supportedFeatures') }}) + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/daterange.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/daterange.py index d67187afe..10e5d876b 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/daterange.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/daterange.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DateRange: finish: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('finish'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/directincomelineitem.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/directincomelineitem.py index bd928b7ae..d4278c59e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/directincomelineitem.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/directincomelineitem.py @@ -6,24 +6,22 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DirectIncomeLineItemItemReference: r"""Reference to the product, service type, or inventory item to which the direct cost is linked.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""Unique identifier for the item in the accounting platform.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of the item in the accounting platform.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DirectIncomeLineItemTaxRateReference: r"""Reference to the tax rate to which the line item is linked.""" @@ -38,7 +36,6 @@ class DirectIncomeLineItemTaxRateReference: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DirectIncomeLineItemTrackingCategoryRefs: r"""References a category against which the item is tracked. @@ -46,13 +43,14 @@ class DirectIncomeLineItemTrackingCategoryRefs: Deprecated class: This will be removed in a future release, please migrate away from it as soon as possible. """ id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + r"""Unique identifier to the tracking category.""" + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""Name of tracking category.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DirectIncomeLineItem: quantity: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -66,25 +64,25 @@ class DirectIncomeLineItem: """ account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""A user-friendly name of the goods or services.""" - discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Discount amount for the line before tax.""" - discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Discount percentage for the line before tax.""" item_ref: Optional[DirectIncomeLineItemItemReference] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) r"""Reference to the product, service type, or inventory item to which the direct cost is linked.""" - sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""The amount of the line, inclusive of discounts, but exclusive of tax.""" - tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""The amount of tax for the line. Note: If the platform does not provide this information, the quantity will be mapped as 0.00. """ tax_rate_ref: Optional[DirectIncomeLineItemTaxRateReference] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateRef'), 'exclude': lambda f: f is None }}) r"""Reference to the tax rate to which the line item is linked.""" - total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""The total amount of the line, including tax.""" - tracking_category_refs: Optional[list[DirectIncomeLineItemTrackingCategoryRefs]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs'), 'exclude': lambda f: f is None }}) + tracking_category_refs: Optional[List[DirectIncomeLineItemTrackingCategoryRefs]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs') }}) r"""An array of categories against which this direct cost is tracked.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/errormessage.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/errormessage.py index 93e9f616e..3e884c08f 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/errormessage.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/errormessage.py @@ -8,14 +8,19 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ErrorMessage: can_be_retried: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('canBeRetried'), 'exclude': lambda f: f is None }}) + r"""`True` if the error occurred transiently and can be retried.""" correlation_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('correlationId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier used to propagate to all downstream services and determine the source of the error.""" detailed_error_code: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('detailedErrorCode'), 'exclude': lambda f: f is None }}) + r"""Machine readable error code used to automate processes based on the code returned.""" error: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('error'), 'exclude': lambda f: f is None }}) + r"""A brief description of the error.""" service: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('service'), 'exclude': lambda f: f is None }}) + r"""Codat's service the returned the error.""" status_code: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode'), 'exclude': lambda f: f is None }}) + r"""The HTTP status code returned by the error.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/featurestate.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/featurestate.py index dad3de462..886707d9d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/featurestate.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/featurestate.py @@ -4,6 +4,7 @@ from enum import Enum class FeatureState(str, Enum): + r"""The current release state of the feature.""" RELEASE = 'Release' ALPHA = 'Alpha' BETA = 'Beta' diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/featuretype.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/featuretype.py index 2f584f359..81af9c452 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/featuretype.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/featuretype.py @@ -4,6 +4,7 @@ from enum import Enum class FeatureType(str, Enum): + r"""The type of feature.""" GET = 'Get' POST = 'Post' CATEGORIZATION = 'Categorization' diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/fees.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/fees.py index 432d674f7..ad4e4ea58 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/fees.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/fees.py @@ -6,14 +6,13 @@ from ..shared import feessupplier as shared_feessupplier from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import Dict, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Fees: - accounts: Optional[dict[str, shared_configaccount.ConfigAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts'), 'exclude': lambda f: f is None }}) + accounts: Optional[Dict[str, shared_configaccount.ConfigAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts') }}) fees_supplier: Optional[shared_feessupplier.FeesSupplier] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feesSupplier'), 'exclude': lambda f: f is None }}) sync_fees: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncFees'), 'exclude': lambda f: f is None }}) r"""Boolean indicator to enable syncing fees.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/feessupplier.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/feessupplier.py index 12b289812..ff6b649ed 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/feessupplier.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/feessupplier.py @@ -5,16 +5,15 @@ from ..shared import option as shared_option from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class FeesSupplier: - selected_supplier_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedSupplierId'), 'exclude': lambda f: f is None }}) + selected_supplier_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedSupplierId') }}) r"""Selected supplier id from the list of supplier records on the accounting software.""" - supplier_options: Optional[list[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplierOptions'), 'exclude': lambda f: f is None }}) + supplier_options: Optional[List[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplierOptions') }}) r"""List of supplier options from the list of supplier records on the accounting software.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/grouping.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/grouping.py index 4f4f9df04..fd93837b8 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/grouping.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/grouping.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Grouping: grouping_levels: Optional[shared_groupinglevels.GroupingLevels] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('groupingLevels'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/groupinglevels.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/groupinglevels.py index 1dfc09d7d..90e2eaa70 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/groupinglevels.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/groupinglevels.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class GroupingLevels: invoice_level: Optional[shared_invoicelevelselection.InvoiceLevelSelection] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoiceLevel'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/groupingperiod.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/groupingperiod.py index 89470b240..8adb0b2f6 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/groupingperiod.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/groupingperiod.py @@ -4,16 +4,15 @@ import dataclasses from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class GroupingPeriod: - grouping_period_options: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('groupingPeriodOptions'), 'exclude': lambda f: f is None }}) + grouping_period_options: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('groupingPeriodOptions') }}) r"""Array of grouping period options.""" - selected_grouping_period: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedGroupingPeriod'), 'exclude': lambda f: f is None }}) + selected_grouping_period: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedGroupingPeriod') }}) r"""Grouping period i.e. Daily sales.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/halref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/halref.py index 1e6990cc6..28854b55f 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/halref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/halref.py @@ -8,9 +8,9 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class HalRef: href: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('href'), 'exclude': lambda f: f is None }}) + r"""Uri hypertext reference.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/imagereference.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/imagereference.py index 49d8bf93d..35ae94c29 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/imagereference.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/imagereference.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ImageReference: r"""Image reference.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/integration.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/integration.py index 18836606e..013ce471b 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/integration.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/integration.py @@ -6,26 +6,30 @@ from ..shared import sourcetype as shared_sourcetype from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Integration: r"""An integration that Codat supports""" enabled: bool = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enabled') }}) - r"""Whether this integration is enabled for your customers to use""" + r"""Whether this integration is enabled for your customers to use.""" key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('key') }}) - r"""A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/accounting-platform-keys), [banking](https://docs.codat.io/integrations/banking/banking-platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/commerce-platform-keys) platform keys.""" + r"""A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys.""" logo_url: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('logoUrl') }}) + r"""Static url for integration's logo.""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""Name of integration.""" data_provided_by: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataProvidedBy'), 'exclude': lambda f: f is None }}) - datatype_features: Optional[list[shared_datatypefeature.DataTypeFeature]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datatypeFeatures'), 'exclude': lambda f: f is None }}) + r"""The name of the data provider.""" + datatype_features: Optional[List[shared_datatypefeature.DataTypeFeature]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datatypeFeatures'), 'exclude': lambda f: f is None }}) integration_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('integrationId'), 'exclude': lambda f: f is None }}) r"""A Codat ID representing the integration.""" is_beta: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isBeta'), 'exclude': lambda f: f is None }}) + r"""`True` if the integration is currently in beta release.""" is_offline_connector: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isOfflineConnector'), 'exclude': lambda f: f is None }}) + r"""`True` if the integration is to an application installed and run locally on an SMBs computer.""" source_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceId'), 'exclude': lambda f: f is None }}) r"""A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.""" source_type: Optional[shared_sourcetype.SourceType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/integrations.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/integrations.py index eaab607a0..409fab049 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/integrations.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/integrations.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Integrations: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_integration.Integration]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_integration.Integration]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelevelselection.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelevelselection.py index cbd562f99..2ce53ff66 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelevelselection.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelevelselection.py @@ -4,16 +4,15 @@ import dataclasses from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class InvoiceLevelSelection: - group_by_options: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('groupByOptions'), 'exclude': lambda f: f is None }}) + group_by_options: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('groupByOptions') }}) r"""Options for grouping sales.""" - selected_group_by_options: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedGroupByOptions'), 'exclude': lambda f: f is None }}) + selected_group_by_options: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedGroupByOptions') }}) r"""Selected array of grouping options.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelineitem.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelineitem.py index fc9266901..ebc26a51a 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelineitem.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelineitem.py @@ -10,11 +10,10 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class InvoiceLineItem: quantity: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -23,26 +22,27 @@ class InvoiceLineItem: r"""Price of each unit of goods or services.""" account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Friendly name of the goods or services provided.""" - discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Numerical value of any discounts applied.""" - discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Percentage rate (from 0 to 100) of any discounts applied to the unit amount.""" is_direct_income: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDirectIncome'), 'exclude': lambda f: f is None }}) + r"""The invoice is a direct income if `True`.""" item_ref: Optional[shared_itemref.ItemRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) r"""Reference to the product, service type, or inventory item to which the direct cost is linked.""" - sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of the line, inclusive of discounts but exclusive of tax.""" - tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of tax for the line.""" tax_rate_ref: Optional[shared_taxrateref.TaxRateRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateRef'), 'exclude': lambda f: f is None }}) r"""Reference to the tax rate to which the line item is linked.""" - total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Total amount of the line, including tax. When pushing invoices to Xero, the total amount is exclusive of tax to allow automatic calculations if a tax rate or tax amount is not specified.""" tracking: Optional[shared_tracking.Tracking] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tracking'), 'exclude': lambda f: f is None }}) r"""Categories, and a project and customer, against which the item is tracked.""" - tracking_category_refs: Optional[list[shared_trackingcategoryrefsitems.TrackingCategoryRefsitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs'), 'exclude': lambda f: f is None }}) + tracking_category_refs: Optional[List[shared_trackingcategoryrefsitems.TrackingCategoryRefsitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs') }}) r"""Reference to the tracking categories to which the line item is linked. Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelinelevelselection.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelinelevelselection.py index 1a03dd647..dfd39f4d9 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelinelevelselection.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicelinelevelselection.py @@ -4,16 +4,15 @@ import dataclasses from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class InvoiceLineLevelSelection: - group_by_options: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('groupByOptions'), 'exclude': lambda f: f is None }}) + group_by_options: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('groupByOptions') }}) r"""Options for grouping on invoice lines.""" - selected_group_by_options: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedGroupByOptions'), 'exclude': lambda f: f is None }}) + selected_group_by_options: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedGroupByOptions') }}) r"""Invoice line level selection.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicestatus1.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicestatus1.py index 876d9c57d..693b0af5d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicestatus1.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/invoicestatus1.py @@ -4,16 +4,15 @@ import dataclasses from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class InvoiceStatus1: - invoice_status_options: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoiceStatusOptions'), 'exclude': lambda f: f is None }}) + invoice_status_options: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoiceStatusOptions') }}) r"""Options for invoice statuses.""" - selected_invoice_status: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedInvoiceStatus'), 'exclude': lambda f: f is None }}) + selected_invoice_status: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedInvoiceStatus') }}) r"""Selected option for invoice status for invoice to be synced.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/itemref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/itemref.py index 1c74c1b97..997af3cbd 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/itemref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/itemref.py @@ -8,13 +8,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ItemRef: r"""Reference to the product, service type, or inventory item to which the direct cost is linked.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""Unique identifier for the item in the accounting platform.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of the item in the accounting platform.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/items.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/items.py index 4e50d43fb..82203818e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/items.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/items.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Items: city: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('city'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/items1.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/items1.py index 40e3b8ad0..19b72c56c 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/items1.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/items1.py @@ -9,22 +9,21 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Items1: type: shared_accountingaddresstype.AccountingAddressType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""The type of the address""" - city: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('city'), 'exclude': lambda f: f is None }}) + city: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('city') }}) r"""City of the customer address.""" - country: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('country'), 'exclude': lambda f: f is None }}) + country: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('country') }}) r"""Country of the customer address.""" - line1: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line1'), 'exclude': lambda f: f is None }}) + line1: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line1') }}) r"""Line 1 of the customer address.""" - line2: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line2'), 'exclude': lambda f: f is None }}) + line2: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line2') }}) r"""Line 2 of the customer address.""" - postal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('postalCode'), 'exclude': lambda f: f is None }}) + postal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('postalCode') }}) r"""Postal code or zip code.""" - region: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region'), 'exclude': lambda f: f is None }}) + region: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region') }}) r"""Region of the customer address.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/journalline.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/journalline.py index a6a7b895c..57c60a1d0 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/journalline.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/journalline.py @@ -7,30 +7,28 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class JournalLineTracking: r"""List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.)""" - record_refs: Optional[list[shared_recordref.RecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefs'), 'exclude': lambda f: f is None }}) + record_refs: Optional[List[shared_recordref.RecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefs') }}) @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class JournalLine: net_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('netAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative.""" account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" - currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) + currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) r"""Currency for the journal line item.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Description of the journal line item.""" tracking: Optional[JournalLineTracking] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tracking'), 'exclude': lambda f: f is None }}) r"""List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.)""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/links.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/links.py index 4e8b99d92..82b752a29 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/links.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/links.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Links: current: shared_halref.HalRef = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('current') }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/localization.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/localization.py index d17f4cd16..52d74edee 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/localization.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/localization.py @@ -8,11 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Localization: required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) - text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('text'), 'exclude': lambda f: f is None }}) + r"""`True` if required.""" + text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('text') }}) r"""Value of the property.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/locationref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/locationref.py index 55dfa7c18..350b3d555 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/locationref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/locationref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LocationRef: r"""Reference to the geographic location where the order was placed.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/metadata.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/metadata.py index d9a1a3d62..47771ce53 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/metadata.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/metadata.py @@ -8,10 +8,9 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Metadata: - is_deleted: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDeleted'), 'exclude': lambda f: f is None }}) + is_deleted: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDeleted') }}) r"""Indicates whether the record has been deleted in the third-party system this record originated from.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/newpayments.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/newpayments.py index 9052f2871..11cb6e910 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/newpayments.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/newpayments.py @@ -5,14 +5,13 @@ from ..shared import configaccount as shared_configaccount from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import Dict, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class NewPayments: - accounts: Optional[dict[str, shared_configaccount.ConfigAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts'), 'exclude': lambda f: f is None }}) + accounts: Optional[Dict[str, shared_configaccount.ConfigAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts') }}) sync_payments: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncPayments'), 'exclude': lambda f: f is None }}) r"""Boolean indicator for syncing payments.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/newtaxrates.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/newtaxrates.py index e5f17c3de..ee0a52d12 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/newtaxrates.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/newtaxrates.py @@ -6,22 +6,21 @@ from ..shared import taxratemapping as shared_taxratemapping from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class NewTaxRates: - accounting_tax_rate_options: Optional[list[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountingTaxRateOptions'), 'exclude': lambda f: f is None }}) + accounting_tax_rate_options: Optional[List[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountingTaxRateOptions') }}) r"""Array of accounting tax rate options.""" - commerce_tax_rate_options: Optional[list[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('commerceTaxRateOptions'), 'exclude': lambda f: f is None }}) + commerce_tax_rate_options: Optional[List[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('commerceTaxRateOptions') }}) r"""Array of tax component options.""" - default_zero_tax_rate_options: Optional[list[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('defaultZeroTaxRateOptions'), 'exclude': lambda f: f is None }}) + default_zero_tax_rate_options: Optional[List[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('defaultZeroTaxRateOptions') }}) r"""Default zero tax rate selected for sync.""" - selected_default_zero_tax_rate_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedDefaultZeroTaxRateId'), 'exclude': lambda f: f is None }}) + selected_default_zero_tax_rate_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedDefaultZeroTaxRateId') }}) r"""Default tax rate selected for sync.""" - tax_rate_mappings: Optional[list[shared_taxratemapping.TaxRateMapping]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateMappings'), 'exclude': lambda f: f is None }}) + tax_rate_mappings: Optional[List[shared_taxratemapping.TaxRateMapping]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateMappings') }}) r"""Array of tax component to rate mapppings.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/option.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/option.py index 949e757f5..bd13fd1f1 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/option.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/option.py @@ -8,12 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Option: id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the option.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name value of the option.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/orderdiscountallocation.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/orderdiscountallocation.py index 9e5546ec6..283f3a981 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/orderdiscountallocation.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/orderdiscountallocation.py @@ -9,12 +9,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class OrderDiscountAllocation: name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""Name of the discount in the commerce or point of sale platform.""" total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total amount of discount applied.""" + r"""Total amount of discount applied, excluding tax. This is typically positive (for discounts which decrease the amount of the order line), but can also be negative (for discounts which increase the amount of the order line).""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/orderlineitem.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/orderlineitem.py index 52848f868..3bda9042c 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/orderlineitem.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/orderlineitem.py @@ -9,33 +9,32 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class OrderLineItem: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""A unique, persistent identifier for this record""" - discount_allocations: Optional[list[shared_orderdiscountallocation.OrderDiscountAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAllocations'), 'exclude': lambda f: f is None }}) + discount_allocations: Optional[List[shared_orderdiscountallocation.OrderDiscountAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAllocations'), 'exclude': lambda f: f is None }}) product_ref: Optional[shared_productref.ProductRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('productRef'), 'exclude': lambda f: f is None }}) r"""Reference that links the line item to the correct product details.""" product_variant_ref: Optional[shared_productvariantref.ProductVariantRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('productVariantRef'), 'exclude': lambda f: f is None }}) r"""Reference that links the line item to the specific version of product that has been ordered.""" quantity: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Number of units of the product sold. - For refunds, quantity is a negative value. + For refunds, quantity is negative. """ - taxes: Optional[list[shared_taxesitems.Taxesitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxes'), 'exclude': lambda f: f is None }}) + taxes: Optional[List[shared_taxesitems.Taxesitems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxes'), 'exclude': lambda f: f is None }}) r"""Taxes breakdown as applied to order lines.""" tax_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Percentage rate (from 0 to 100) of any sale tax applied to the unit amount.""" + r"""Percentage rate (from 0 to 100) of any sales tax applied to the unit price.""" total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total price of the line item, including discounts, tax and minus any refunds.""" + r"""Total amount of the line item, including discounts and tax.""" total_tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalTaxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total amount of tax applied to the line item.""" + r"""Total amount of tax applied to the line item, factoring in any discounts.""" unit_price: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unitPrice'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Price per unit of goods or service.""" + r"""Price per unit of goods or services, excluding discounts and tax.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentallocationpayment.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentallocationpayment.py index 0f27e80e5..57f619d6b 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentallocationpayment.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentallocationpayment.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PaymentAllocationPayment: account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) @@ -24,7 +23,7 @@ class PaymentAllocationPayment: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -53,7 +52,7 @@ class PaymentAllocationPayment: """ id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier of the allocated payment.""" - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Notes attached to the allocated payment.""" paid_on_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paidOnDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -76,7 +75,7 @@ class PaymentAllocationPayment: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference'), 'exclude': lambda f: f is None }}) + reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference') }}) r"""Reference to the allocated payment.""" total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Total amount that was paid.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentallocationsitems.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentallocationsitems.py index 8211caf44..81047e0c0 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentallocationsitems.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentallocationsitems.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ItemsAllocation: allocated_on_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allocatedOnDate'), 'exclude': lambda f: f is None }}) @@ -43,7 +42,7 @@ class ItemsAllocation: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -77,7 +76,6 @@ class ItemsAllocation: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PaymentAllocationsitems: allocation: ItemsAllocation = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allocation') }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentline.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentline.py index 53936a190..11c2184b0 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentline.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentline.py @@ -6,11 +6,10 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PaymentLine: amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -36,6 +35,6 @@ class PaymentLine: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - links: Optional[list[shared_paymentlinelink.PaymentLineLink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('links'), 'exclude': lambda f: f is None }}) + links: Optional[List[shared_paymentlinelink.PaymentLineLink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('links') }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentlinelink.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentlinelink.py index 7687a27c3..87ab288ac 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentlinelink.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentlinelink.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PaymentLineLink: type: shared_paymentlinktype.PaymentLinkType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) @@ -26,12 +25,12 @@ class PaymentLineLink: `Manual Journal` `Discount` - ID refers to the payment """ - amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount by which the balance of the linked entity is altered, in the currency of the linked entity. A negative link amount _reduces_ the outstanding amount on the accounts receivable account. A positive link amount _increases_ the outstanding amount on the accounts receivable account. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentmethodref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentmethodref.py new file mode 100755 index 000000000..cebcdbc4d --- /dev/null +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentmethodref.py @@ -0,0 +1,19 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from codatsynccommerce import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class PaymentMethodRef: + r"""The payment method the record is linked to in the accounting or commerce platform.""" + id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) + r"""The unique identifier of the location being referenced.""" + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + r"""Name of the location being referenced.""" + + diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentmethodstatus.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentmethodstatus.py deleted file mode 100755 index 9a8cecaa7..000000000 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentmethodstatus.py +++ /dev/null @@ -1,10 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -from enum import Enum - -class PaymentMethodStatus(str, Enum): - r"""Status of the Payment Method""" - ACTIVE = 'Active' - ARCHIVED = 'Archived' - UNKNOWN = 'Unknown' diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentref.py index 0023490bc..de7895d72 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/paymentref.py @@ -11,12 +11,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PaymentRef: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""A unique, persistent identifier for this record""" - amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Payment Amount (including gratuity).""" created_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('createdDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -75,7 +74,7 @@ class PaymentRef: source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_paymentstatus.PaymentStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Status of the payment.""" - type: Optional[shared_paymenttype.PaymentType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[shared_paymenttype.PaymentType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""Type of payment.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/payments.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/payments.py index 61982b886..9073cf428 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/payments.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/payments.py @@ -5,14 +5,13 @@ from ..shared import configaccount as shared_configaccount from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import Dict, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Payments: - accounts: Optional[dict[str, shared_configaccount.ConfigAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts'), 'exclude': lambda f: f is None }}) + accounts: Optional[Dict[str, shared_configaccount.ConfigAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts') }}) sync_payments: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncPayments'), 'exclude': lambda f: f is None }}) r"""Boolean indicator for syncing sales.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/phonenumbersitems.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/phonenumbersitems.py index c7713ac48..315c0bd43 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/phonenumbersitems.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/phonenumbersitems.py @@ -5,13 +5,13 @@ from ..shared import phonenumbertype as shared_phonenumbertype from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json +from typing import Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PhoneNumbersitems: - number: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('number') }}) + number: Optional[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('number') }}) r"""A phone number.""" type: shared_phonenumbertype.PhoneNumberType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""The type of phone number""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productinventory.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productinventory.py index 7a6b8c5a8..486816ac8 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productinventory.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productinventory.py @@ -6,15 +6,15 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductInventory: r"""Information about the total inventory as well as the locations inventory is in.""" - locations: Optional[list[shared_productinventorylocation.ProductInventoryLocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('locations'), 'exclude': lambda f: f is None }}) - total_quantity: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalQuantity'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + locations: Optional[List[shared_productinventorylocation.ProductInventoryLocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('locations'), 'exclude': lambda f: f is None }}) + total_quantity: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalQuantity'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) + r"""The total quantity of stock remaining across locations.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productinventorylocation.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productinventorylocation.py index 7c3deee88..161103bb8 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productinventorylocation.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productinventorylocation.py @@ -10,11 +10,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductInventoryLocation: location_ref: Optional[shared_locationref.LocationRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('locationRef'), 'exclude': lambda f: f is None }}) r"""Reference to the geographic location where the order was placed.""" quantity: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""The quantity of stock remaining at location.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productprice.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productprice.py index a5d072193..9376317f0 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productprice.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productprice.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductPrice: currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) @@ -22,5 +21,6 @@ class ProductPrice: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ unit_price: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unitPrice'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""The product variant's unit price.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productref.py index e94cc45b2..3127948e1 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productref.py @@ -8,12 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductRef: r"""Reference that links the line item to the correct product details.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - r"""The unique identitifer of the product being referenced.""" + r"""The unique identifier of the product being referenced.""" name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""Name of the product being referenced.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariant.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariant.py index ac3fd7a95..475505eff 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariant.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariant.py @@ -8,11 +8,10 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductVariant: r"""Represents a variation of a product available for sale, for example an item of clothing that may be available for sale in multiple sizes and colors.""" @@ -48,7 +47,7 @@ class ProductVariant: modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""Name of the product recorded in the commerce or point of sale platform.""" - prices: Optional[list[shared_productprice.ProductPrice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('prices'), 'exclude': lambda f: f is None }}) + prices: Optional[List[shared_productprice.ProductPrice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('prices'), 'exclude': lambda f: f is None }}) r"""Prices for the product variants in different currencies.""" shipping_required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('shippingRequired'), 'exclude': lambda f: f is None }}) r"""Indicates whether or not the product requires physical delivery.""" @@ -56,6 +55,7 @@ class ProductVariant: r"""SKU (stock keeping unit) of the variant, as defined by the merchant.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_productvariantstatus.ProductVariantStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) + r"""The status of the product variant.""" unit_of_measure: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unitOfMeasure'), 'exclude': lambda f: f is None }}) r"""Unit of measure for the variant, such as `kg` or `meters`.""" vat_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('vatPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariantref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariantref.py index 136210619..c003a8598 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariantref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariantref.py @@ -8,12 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductVariantRef: r"""Reference that links the line item to the specific version of product that has been ordered.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - r"""The unique identitifer of the product variant being referenced.""" + r"""The unique identifier of the product variant being referenced.""" name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""Name of the product variant being referenced.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariantstatus.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariantstatus.py index 5f073db6a..f54446a78 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariantstatus.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/productvariantstatus.py @@ -4,6 +4,7 @@ from enum import Enum class ProductVariantStatus(str, Enum): + r"""The status of the product variant.""" UNKNOWN = 'Unknown' PUBLISHED = 'Published' UNPUBLISHED = 'Unpublished' diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pulloperation.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pulloperation.py index 56e69ffe1..f67011c85 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pulloperation.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pulloperation.py @@ -2,11 +2,14 @@ from __future__ import annotations import dataclasses +from ..shared import datatype as shared_datatype from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum +from typing import Optional class PullOperationStatus(str, Enum): + r"""The current status of the pull operation.""" INITIAL = 'Initial' QUEUED = 'Queued' FETCHING = 'Fetching' @@ -33,19 +36,25 @@ class PullOperationStatus(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PullOperation: r"""Information about a queued, in progress or completed pull operation. *Formally called `dataset`* """ company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) + r"""Unique identifier of the company associated to this pull operation.""" connection_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionId') }}) - data_type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType') }}) + r"""Unique identifier of the connection associated to this pull operation.""" + data_type: shared_datatype.DataType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType') }}) + r"""Available Data types""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) + r"""Unique identifier of the pull operation.""" is_completed: bool = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isCompleted') }}) + r"""`True` if the pull operation completed successfully.""" is_errored: bool = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isErrored') }}) + r"""`True` if the pull operation entered an error state.""" progress: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('progress') }}) + r"""An integer signifying the progress of the pull operation.""" requested: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('requested') }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -68,5 +77,29 @@ class PullOperation: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: PullOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + r"""The current status of the pull operation.""" + completed: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completed'), 'exclude': lambda f: f is None }}) + r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + + ``` + 2020-10-08T22:40:50Z + 2021-01-01T00:00:00 + ``` + + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: + + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` + - Unqualified local time: `2021-11-15T01:00:00` + - UTC time offsets: `2021-11-15T01:00:00-05:00` + + > Time zones + > + > Not all dates from Codat will contain information about time zones. + > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + """ + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about a transient or persistent error.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pulloperations.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pulloperations.py index 6eb5eb83d..7b380bf7f 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pulloperations.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pulloperations.py @@ -6,17 +6,19 @@ from ..shared import pulloperation as shared_pulloperation from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PullOperations: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_pulloperation.PullOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_pulloperation.PullOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushchangetype.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushchangetype.py index 88e1a3ec7..55cd1990f 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushchangetype.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushchangetype.py @@ -4,6 +4,7 @@ from enum import Enum class PushChangeType(str, Enum): + r"""Type of change being applied to record in third party platform.""" UNKNOWN = 'Unknown' CREATED = 'Created' MODIFIED = 'Modified' diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperation.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperation.py index 234051bf0..67791503d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperation.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperation.py @@ -8,11 +8,10 @@ from ..shared import validation as shared_validation from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOperation: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -43,9 +42,10 @@ class PushOperation: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The status of the push operation.""" + r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -70,10 +70,15 @@ class PushOperation: """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationchange.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationchange.py index cd3fe0af6..fcfd20865 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationchange.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationchange.py @@ -10,11 +10,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOperationChange: - attachment_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attachmentId'), 'exclude': lambda f: f is None }}) + attachment_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attachmentId') }}) + r"""Unique identifier for the attachment created otherwise null.""" record_ref: Optional[shared_pushoperationref.PushOperationRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRef'), 'exclude': lambda f: f is None }}) type: Optional[shared_pushchangetype.PushChangeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + r"""Type of change being applied to record in third party platform.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationref.py index 8ab01ed58..6276a35ca 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationref.py @@ -9,11 +9,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOperationRef: data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a push operation.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperations.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperations.py index 4b257d189..b1e86ea8d 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperations.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperations.py @@ -6,17 +6,19 @@ from ..shared import pushoperation as shared_pushoperation from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOperations: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_pushoperation.PushOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_pushoperation.PushOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationstatus.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationstatus.py index fc391b0a2..5b3fabf24 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationstatus.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/pushoperationstatus.py @@ -4,7 +4,7 @@ from enum import Enum class PushOperationStatus(str, Enum): - r"""The status of the push operation.""" + r"""The current status of the push operation.""" PENDING = 'Pending' FAILED = 'Failed' SUCCESS = 'Success' diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/recordref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/recordref.py index 2afde445f..2e27da574 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/recordref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/recordref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class RecordRef: r"""Links the current record to the underlying record or data type that created it. diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/sales.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/sales.py index 982416b75..8d5491a20 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/sales.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/sales.py @@ -10,20 +10,19 @@ from ..shared import taxrateamount as shared_taxrateamount from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import Dict, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Sales: - accounts: Optional[dict[str, shared_configaccount.ConfigAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts'), 'exclude': lambda f: f is None }}) + accounts: Optional[Dict[str, shared_configaccount.ConfigAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts') }}) grouping: Optional[shared_grouping.Grouping] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('grouping'), 'exclude': lambda f: f is None }}) invoice_status: Optional[shared_invoicestatus1.InvoiceStatus1] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoiceStatus'), 'exclude': lambda f: f is None }}) new_tax_rates: Optional[shared_newtaxrates.NewTaxRates] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('newTaxRates'), 'exclude': lambda f: f is None }}) sales_customer: Optional[shared_customer.Customer] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('salesCustomer'), 'exclude': lambda f: f is None }}) sync_sales: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncSales'), 'exclude': lambda f: f is None }}) r"""Boolean indicator for syncing sales.""" - tax_rates: Optional[dict[str, shared_taxrateamount.TaxRateAmount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRates'), 'exclude': lambda f: f is None }}) + tax_rates: Optional[Dict[str, shared_taxrateamount.TaxRateAmount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRates') }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/security.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/security.py index a72246378..1d57f5faa 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/security.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/security.py @@ -4,7 +4,6 @@ import dataclasses - @dataclasses.dataclass class Security: auth_header: str = dataclasses.field(metadata={'security': { 'scheme': True, 'type': 'apiKey', 'sub_type': 'header', 'field_name': 'Authorization' }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/servicecharge.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/servicecharge.py index 42e3b854e..696ae4837 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/servicecharge.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/servicecharge.py @@ -6,11 +6,10 @@ from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ServiceChargeTaxComponentAllocationTaxComponentRef: r"""Taxes rates reference object depending on the rates being available on source commerce package.""" @@ -23,10 +22,9 @@ class ServiceChargeTaxComponentAllocationTaxComponentRef: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ServiceChargeTaxComponentAllocation: - rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('rate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('rate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Tax amount on order line sale as available from source commerce platform.""" tax_component_ref: Optional[ServiceChargeTaxComponentAllocationTaxComponentRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxComponentRef'), 'exclude': lambda f: f is None }}) r"""Taxes rates reference object depending on the rates being available on source commerce package.""" @@ -35,7 +33,6 @@ class ServiceChargeTaxComponentAllocation: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ServiceCharge: description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) @@ -44,12 +41,12 @@ class ServiceCharge: r"""The number of times the charge is charged.""" tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Amount of the service charge that is tax.""" - taxes: Optional[list[ServiceChargeTaxComponentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxes'), 'exclude': lambda f: f is None }}) + taxes: Optional[List[ServiceChargeTaxComponentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxes'), 'exclude': lambda f: f is None }}) r"""Taxes breakdown as applied to service charges.""" tax_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Percentage rate (from 0 to 100) of any tax applied to the service charge.""" total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total service charge, including taxes.""" + r"""Total amount of the service charge, including tax.""" type: Optional[shared_servicechargetype.ServiceChargeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) r"""The type of the service charge.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/supplementaldata.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/supplementaldata.py index 2e168d04e..4c8b19ce7 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/supplementaldata.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/supplementaldata.py @@ -4,17 +4,16 @@ import dataclasses from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Any, Optional +from typing import Any, Dict, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SupplementalData: r"""Supplemental data is additional data you can include in our standard data types. It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ - content: Optional[dict[str, dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('content'), 'exclude': lambda f: f is None }}) + content: Optional[Dict[str, Dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('content') }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/supportedfeature.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/supportedfeature.py index 11050d335..862c82b77 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/supportedfeature.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/supportedfeature.py @@ -9,10 +9,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SupportedFeature: feature_state: shared_featurestate.FeatureState = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('featureState') }}) + r"""The current release state of the feature.""" feature_type: shared_featuretype.FeatureType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('featureType') }}) + r"""The type of feature.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncflowurl.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncflowurl.py index 9ad763321..9b506ecb7 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncflowurl.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncflowurl.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncFlowURL: url: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('url'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncrange.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncrange.py index 6751f3e13..9169cae38 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncrange.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncrange.py @@ -7,7 +7,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncRangeDateRange: finish: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('finish') }}) @@ -57,7 +56,6 @@ class SyncRangeDateRange: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncRange: date_range: SyncRangeDateRange = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dateRange') }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncsummary.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncsummary.py index e6991a532..0d273276e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncsummary.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/syncsummary.py @@ -6,27 +6,26 @@ from ..shared import daterange as shared_daterange from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncSummary: commerce_sync_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('commerceSyncId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the sync in Codat.""" company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for your SMB in Codat.""" - data_connections: Optional[list[shared_connection.Connection]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnections'), 'exclude': lambda f: f is None }}) + data_connections: Optional[List[shared_connection.Connection]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnections') }}) r"""Array of containing objects data connection information for the company.""" data_pushed: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataPushed'), 'exclude': lambda f: f is None }}) r"""Boolean indicator for data being pushed during a sync operation.""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) r"""Friendly error message for the sync operation.""" sync_date_range_utc: Optional[shared_daterange.DateRange] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncDateRangeUtc'), 'exclude': lambda f: f is None }}) - sync_exception_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncExceptionMessage'), 'exclude': lambda f: f is None }}) + sync_exception_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncExceptionMessage') }}) r"""Exception message for the sync operation.""" - sync_status: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncStatus'), 'exclude': lambda f: f is None }}) + sync_status: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncStatus') }}) r"""Status of the sync of the company data. This is linked to status code.""" sync_status_code: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncStatusCode'), 'exclude': lambda f: f is None }}) r"""Numerical status code sync of the company data.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/synctolatestargs.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/synctolatestargs.py index afbb072d9..a24904c53 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/synctolatestargs.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/synctolatestargs.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncToLatestArgs: sync_to: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncTo'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxesitems.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxesitems.py index f9e8c6588..8b2e1d8b6 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxesitems.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxesitems.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ItemsTaxComponentRef: r"""Taxes rates reference object depending on the rates being available on source commerce package.""" @@ -22,10 +21,9 @@ class ItemsTaxComponentRef: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Taxesitems: - rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('rate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('rate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Tax amount on order line sale as available from source commerce platform.""" tax_component_ref: Optional[ItemsTaxComponentRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxComponentRef'), 'exclude': lambda f: f is None }}) r"""Taxes rates reference object depending on the rates being available on source commerce package.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxrateamount.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxrateamount.py index b1a048e02..78ce908aa 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxrateamount.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxrateamount.py @@ -5,16 +5,15 @@ from ..shared import option as shared_option from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TaxRateAmount: - selected_tax_rate_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedTaxRateId'), 'exclude': lambda f: f is None }}) + selected_tax_rate_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedTaxRateId') }}) r"""Selected tax rate id from the list of tax rates on the accounting software.""" - tax_rate_options: Optional[list[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateOptions'), 'exclude': lambda f: f is None }}) + tax_rate_options: Optional[List[shared_option.Option]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateOptions') }}) r"""Array of tax rate options object.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxratemapping.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxratemapping.py index e41a16a0d..cb60ce3fc 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxratemapping.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxratemapping.py @@ -4,16 +4,15 @@ import dataclasses from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TaxRateMapping: - selected_accounting_tax_rate_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedAccountingTaxRateId'), 'exclude': lambda f: f is None }}) + selected_accounting_tax_rate_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedAccountingTaxRateId') }}) r"""Selected tax rate id from the list of tax rates on the accounting software.""" - selected_commerce_tax_rate_ids: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedCommerceTaxRateIds'), 'exclude': lambda f: f is None }}) + selected_commerce_tax_rate_ids: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('selectedCommerceTaxRateIds') }}) r"""Selected tax component id from the list of tax components on the commerce software.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxrateref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxrateref.py index f146fd111..54d354e7e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxrateref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/taxrateref.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TaxRateRef: r"""Reference to the tax rate to which the line item is linked.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/tracking.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/tracking.py index 7027052d4..3c4992316 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/tracking.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/tracking.py @@ -8,27 +8,29 @@ from ..shared import trackingcategoryrefsitems as shared_trackingcategoryrefsitems from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TrackingProjectReference: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + r"""Unique identifier to the project reference.""" + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""The project's name.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Tracking: r"""Categories, and a project and customer, against which the item is tracked.""" - category_refs: list[shared_trackingcategoryrefsitems.TrackingCategoryRefsitems] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categoryRefs') }}) + category_refs: List[shared_trackingcategoryrefsitems.TrackingCategoryRefsitems] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categoryRefs') }}) is_billed_to: shared_billedtotype.BilledToType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isBilledTo') }}) + r"""Defines if the bill or bill credit note is billed/rebilled to a project.""" is_rebilled_to: shared_billedtotype.BilledToType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isRebilledTo') }}) + r"""Defines if the bill or bill credit note is billed/rebilled to a project.""" customer_ref: Optional[shared_accountingcustomerref.AccountingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) project_ref: Optional[TrackingProjectReference] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('projectRef'), 'exclude': lambda f: f is None }}) record_ref: Optional[shared_recordref.RecordRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRef'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/trackingcategoryrefsitems.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/trackingcategoryrefsitems.py index fb674705e..b1d2ef71e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/trackingcategoryrefsitems.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/trackingcategoryrefsitems.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TrackingCategoryRefsitems: r"""References a category against which the item is tracked. @@ -16,6 +15,8 @@ class TrackingCategoryRefsitems: Deprecated class: This will be removed in a future release, please migrate away from it as soon as possible. """ id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + r"""Unique identifier to the tracking category.""" + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""Name of tracking category.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/transactionsourceref.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/transactionsourceref.py index ea17b7e2a..54a5db7bd 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/transactionsourceref.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/transactionsourceref.py @@ -8,11 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TransactionSourceRef: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""The unique identitifer of the record being referenced""" type: shared_transactionsourcetype.TransactionSourceType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + r"""The type of source the transaction arose.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/transactionsourcetype.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/transactionsourcetype.py index 90c7bd583..7efe4d8de 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/transactionsourcetype.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/transactionsourcetype.py @@ -4,6 +4,7 @@ from enum import Enum class TransactionSourceType(str, Enum): + r"""The type of source the transaction arose.""" FEE = 'Fee' ORDER = 'Order' PAYMENT = 'Payment' diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/updateconnection.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/updateconnection.py index 77b5b6edb..c12362439 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/updateconnection.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/updateconnection.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class UpdateConnection: status: Optional[shared_dataconnectionstatus.DataConnectionStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/validation.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/validation.py index ac1a9cecc..8266d5c88 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/validation.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/validation.py @@ -5,15 +5,14 @@ from ..shared import validationitem as shared_validationitem from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Validation: r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" - errors: Optional[list[shared_validationitem.ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) - warnings: Optional[list[shared_validationitem.ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings'), 'exclude': lambda f: f is None }}) + errors: Optional[List[shared_validationitem.ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors') }}) + warnings: Optional[List[shared_validationitem.ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings') }}) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/validationitem.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/validationitem.py index 2fbfa66fa..b8ea1d3ed 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/validationitem.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/validationitem.py @@ -8,11 +8,13 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ValidationItem: - item_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemId'), 'exclude': lambda f: f is None }}) - message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message'), 'exclude': lambda f: f is None }}) - validator_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validatorName'), 'exclude': lambda f: f is None }}) + item_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemId') }}) + r"""Unique identifier for a validation item.""" + message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message') }}) + r"""A message outlining validation item's issue.""" + validator_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validatorName') }}) + r"""Name of validator.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/visibleaccounts.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/visibleaccounts.py index 2f1edbd15..e09a36465 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/visibleaccounts.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/visibleaccounts.py @@ -4,14 +4,13 @@ import dataclasses from codatsynccommerce import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class VisibleAccounts: - visible_accounts: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('visibleAccounts'), 'exclude': lambda f: f is None }}) + visible_accounts: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('visibleAccounts') }}) r"""Visible accounts on sync flow.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/weblinksitems.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/weblinksitems.py index a36d786f1..a2fa8e1f5 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/weblinksitems.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/weblinksitems.py @@ -15,7 +15,6 @@ class ItemsType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class WebLinksitems: r"""Weblink associated with the company.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/withholdingtaxitems.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/withholdingtaxitems.py index 1dda26961..f7709330e 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/withholdingtaxitems.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/models/shared/withholdingtaxitems.py @@ -8,10 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class WithholdingTaxitems: amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) + r"""Amount of tax withheld.""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""Name assigned to withheld tax.""" diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/push_data.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/push_data.py index 5af29e3cd..f91568221 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/push_data.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/push_data.py @@ -22,7 +22,7 @@ def get_operation(self, request: operations.GetPushOperationRequest, retries: Op url = utils.generate_url(operations.GetPushOperationRequest, base_url, '/companies/{companyId}/push/{pushOperationKey}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def get_operation(self, request: operations.GetPushOperationRequest, retries: Op def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -72,7 +72,7 @@ def list_operations(self, request: operations.GetCompanyPushHistoryRequest, retr headers = {} query_params = utils.get_query_params(operations.GetCompanyPushHistoryRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -86,7 +86,7 @@ def list_operations(self, request: operations.GetCompanyPushHistoryRequest, retr def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/refresh_data.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/refresh_data.py index 81ae70d93..acafc9380 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/refresh_data.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/refresh_data.py @@ -3,7 +3,7 @@ from .sdkconfiguration import SDKConfiguration from codatsynccommerce import utils from codatsynccommerce.models import errors, operations, shared -from typing import Optional +from typing import Dict, Optional class RefreshData: r"""Asynchronously retrieve data from an integration to refresh data in Codat.""" @@ -26,7 +26,7 @@ def all(self, request: operations.RefreshCompanyDataRequest, retries: Optional[u url = utils.generate_url(operations.RefreshCompanyDataRequest, base_url, '/companies/{companyId}/data/all', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -40,7 +40,7 @@ def all(self, request: operations.RefreshCompanyDataRequest, retries: Optional[u def do_request(): return client.request('POST', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -74,7 +74,7 @@ def by_data_type(self, request: operations.RefreshDataTypeRequest, retries: Opti headers = {} query_params = utils.get_query_params(operations.RefreshDataTypeRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -88,7 +88,7 @@ def by_data_type(self, request: operations.RefreshDataTypeRequest, retries: Opti def do_request(): return client.request('POST', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -123,7 +123,7 @@ def get_company_data_status(self, request: operations.GetCompanyDataStatusReques url = utils.generate_url(operations.GetCompanyDataStatusRequest, base_url, '/companies/{companyId}/dataStatus', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -137,7 +137,7 @@ def get_company_data_status(self, request: operations.GetCompanyDataStatusReques def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -149,7 +149,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[dict[str, shared.DataStatus]]) + out = utils.unmarshal_json(http_res.text, Optional[Dict[str, shared.DataStatus]]) res.data_status_response = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) @@ -172,7 +172,7 @@ def get_pull_operation(self, request: operations.GetPullOperationRequest, retrie url = utils.generate_url(operations.GetPullOperationRequest, base_url, '/companies/{companyId}/data/history/{datasetId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -186,7 +186,7 @@ def get_pull_operation(self, request: operations.GetPullOperationRequest, retrie def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -222,7 +222,7 @@ def list_pull_operations(self, request: operations.ListPullOperationsRequest, re headers = {} query_params = utils.get_query_params(operations.ListPullOperationsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -236,7 +236,7 @@ def list_pull_operations(self, request: operations.ListPullOperationsRequest, re def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sdk.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sdk.py index 7d896a9bd..486621391 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sdk.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sdk.py @@ -29,6 +29,7 @@ from .sync_flow_preferences import SyncFlowPreferences from codatsynccommerce import utils from codatsynccommerce.models import shared +from typing import Dict class CodatSyncCommerce: r"""Sync for Commerce (v1): The API for Sync for Commerce V1. @@ -96,7 +97,7 @@ def __init__(self, security: shared.Security = None, server_idx: int = None, server_url: str = None, - url_params: dict[str, str] = None, + url_params: Dict[str, str] = None, client: requests_http.Session = None, retry_config: utils.RetryConfig = None ) -> None: @@ -109,7 +110,7 @@ def __init__(self, :param server_url: The server URL to use for all operations :type server_url: str :param url_params: Parameters to optionally template the server URL with - :type url_params: dict[str, str] + :type url_params: Dict[str, str] :param client: The requests.Session HTTP client to use for all operations :type client: requests_http.Session :param retry_config: The utils.RetryConfig to use globally @@ -118,8 +119,10 @@ def __init__(self, if client is None: client = requests_http.Session() + security_client = utils.configure_security_client(client, security) + if server_url is not None: if url_params is not None: server_url = utils.template_url(server_url, url_params) diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sdkconfiguration.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sdkconfiguration.py index 17e061932..633e8a575 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sdkconfiguration.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sdkconfiguration.py @@ -2,8 +2,9 @@ import requests from dataclasses import dataclass - +from typing import Dict, Tuple from .utils.retries import RetryConfig +from .utils import utils SERVERS = [ @@ -20,13 +21,14 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.1' - sdk_version: str = '0.1.0' - gen_version: str = '2.108.3' + sdk_version: str = '0.2.0' + gen_version: str = '2.159.2' + user_agent: str = 'speakeasy-sdk/python 0.2.0 2.159.2 1.1 codat-sync-for-commerce-version-1' retry_config: RetryConfig = None - def get_server_details(self) -> tuple[str, dict[str, str]]: + def get_server_details(self) -> Tuple[str, Dict[str, str]]: if self.server_url: - return self.server_url.removesuffix('/'), {} + return utils.remove_suffix(self.server_url, '/'), {} if self.server_idx is None: self.server_idx = 0 diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sync.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sync.py index 76d69745c..ee76f0fe6 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sync.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sync.py @@ -22,7 +22,7 @@ def get_sync_status(self, request: operations.GetSyncStatusRequest, retries: Opt url = utils.generate_url(operations.GetSyncStatusRequest, base_url, '/meta/companies/{companyId}/sync/commerce/status', request) headers = {} headers['Accept'] = '*/*' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def get_sync_status(self, request: operations.GetSyncStatusRequest, retries: Opt def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -59,11 +59,11 @@ def request_sync(self, request: operations.RequestSyncRequest, retries: Optional url = utils.generate_url(operations.RequestSyncRequest, base_url, '/companies/{companyId}/sync/commerce/latest', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "sync_to_latest_args", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "sync_to_latest_args", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -77,7 +77,7 @@ def request_sync(self, request: operations.RequestSyncRequest, retries: Optional def do_request(): return client.request('POST', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -105,11 +105,11 @@ def request_sync_for_date_range(self, request: operations.RequestSyncForDateRang url = utils.generate_url(operations.RequestSyncForDateRangeRequest, base_url, '/meta/companies/{companyId}/sync/commerce/historic', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "sync_range", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "sync_range", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -123,7 +123,7 @@ def request_sync_for_date_range(self, request: operations.RequestSyncForDateRang def do_request(): return client.request('POST', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sync_flow_preferences.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sync_flow_preferences.py index ade1117f3..55067c6ab 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sync_flow_preferences.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/sync_flow_preferences.py @@ -3,7 +3,7 @@ from .sdkconfiguration import SDKConfiguration from codatsynccommerce import utils from codatsynccommerce.models import errors, operations, shared -from typing import Optional +from typing import Dict, Optional class SyncFlowPreferences: r"""Configure preferences for any given Sync for Commerce company using sync flow.""" @@ -14,7 +14,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def get_config_text_sync_flow(self, retries: Optional[utils.RetryConfig] = None) -> operations.GetConfigTextSyncFlowResponse: - r"""Retrieve preferences for text fields on Sync Flow + r"""Retrieve preferences for text fields on sync flow To enable retrieval of preferences set for the text fields on Sync Flow. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) @@ -22,7 +22,7 @@ def get_config_text_sync_flow(self, retries: Optional[utils.RetryConfig] = None) url = base_url + '/sync/commerce/config/ui/text' headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def get_config_text_sync_flow(self, retries: Optional[utils.RetryConfig] = None) def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -48,7 +48,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[dict[str, shared.Localization]]) + out = utils.unmarshal_json(http_res.text, Optional[Dict[str, shared.Localization]]) res.localization_info = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) @@ -66,7 +66,7 @@ def get_sync_flow_url(self, request: operations.GetSyncFlowURLRequest, retries: headers = {} query_params = utils.get_query_params(operations.GetSyncFlowURLRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -80,7 +80,7 @@ def get_sync_flow_url(self, request: operations.GetSyncFlowURLRequest, retries: def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -109,7 +109,7 @@ def get_visible_accounts(self, request: operations.GetVisibleAccountsRequest, re url = utils.generate_url(operations.GetVisibleAccountsRequest, base_url, '/clients/{clientId}/config/ui/accounts/platform/{platformKey}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -123,7 +123,7 @@ def get_visible_accounts(self, request: operations.GetVisibleAccountsRequest, re def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -143,7 +143,7 @@ def do_request(): return res - def update_config_text_sync_flow(self, request: dict[str, shared.Localization], retries: Optional[utils.RetryConfig] = None) -> operations.UpdateConfigTextSyncFlowResponse: + def update_config_text_sync_flow(self, request: Dict[str, shared.Localization], retries: Optional[utils.RetryConfig] = None) -> operations.UpdateConfigTextSyncFlowResponse: r"""Update preferences for text fields on sync flow To enable update of preferences set for the text fields on sync flow. """ @@ -151,11 +151,11 @@ def update_config_text_sync_flow(self, request: dict[str, shared.Localization], url = base_url + '/sync/commerce/config/ui/text' headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -169,7 +169,7 @@ def update_config_text_sync_flow(self, request: dict[str, shared.Localization], def do_request(): return client.request('PATCH', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -181,7 +181,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[dict[str, shared.Localization]]) + out = utils.unmarshal_json(http_res.text, Optional[Dict[str, shared.Localization]]) res.localization_info = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) @@ -190,18 +190,18 @@ def do_request(): def update_visible_accounts_sync_flow(self, request: operations.UpdateVisibleAccountsSyncFlowRequest, retries: Optional[utils.RetryConfig] = None) -> operations.UpdateVisibleAccountsSyncFlowResponse: - r"""Update the visible accounts on Sync Flow + r"""Update the visible accounts on sync flow To enable update of accounts visible preferences set on Sync Flow. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.UpdateVisibleAccountsSyncFlowRequest, base_url, '/sync/commerce/config/ui/accounts/platform/{platformKey}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "visible_accounts", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "visible_accounts", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -215,7 +215,7 @@ def update_visible_accounts_sync_flow(self, request: operations.UpdateVisibleAcc def do_request(): return client.request('POST', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/utils/retries.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/utils/retries.py index 2138c1b5e..25f49a1f2 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/utils/retries.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/utils/retries.py @@ -2,6 +2,7 @@ import random import time +from typing import List import requests @@ -32,9 +33,9 @@ def __init__(self, strategy: str, backoff: BackoffStrategy, retry_connection_err class Retries: config: RetryConfig - status_codes: list[str] + status_codes: List[str] - def __init__(self, config: RetryConfig, status_codes: list[str]): + def __init__(self, config: RetryConfig, status_codes: List[str]): self.config = config self.status_codes = status_codes diff --git a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/utils/utils.py b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/utils/utils.py index 05eafba6c..ccfad9f7a 100755 --- a/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/utils/utils.py +++ b/previous-versions/sync-for-commerce-version-1/src/codatsynccommerce/utils/utils.py @@ -3,12 +3,14 @@ import base64 import json import re +import sys from dataclasses import Field, dataclass, fields, is_dataclass, make_dataclass from datetime import date, datetime from decimal import Decimal from email.message import Message from enum import Enum -from typing import Any, Callable, Optional, Tuple, Union, get_args, get_origin +from typing import (Any, Callable, Dict, List, Optional, Tuple, Union, + get_args, get_origin) from xmlrpc.client import boolean import dateutil.parser @@ -18,14 +20,14 @@ class SecurityClient: client: requests.Session - query_params: dict[str, str] = {} + query_params: Dict[str, str] = {} def __init__(self, client: requests.Session): self.client = client def request(self, method, url, **kwargs): params = kwargs.get('params', {}) - kwargs["params"] = self.query_params | params + kwargs["params"] = {**self.query_params, **params} return self.client.request(method, url, **kwargs) @@ -68,7 +70,7 @@ def _parse_security_option(client: SecurityClient, option: dataclass): client, metadata, getattr(option, opt_field.name)) -def _parse_security_scheme(client: SecurityClient, scheme_metadata: dict, scheme: any): +def _parse_security_scheme(client: SecurityClient, scheme_metadata: Dict, scheme: any): scheme_type = scheme_metadata.get('type') sub_type = scheme_metadata.get('sub_type') @@ -92,7 +94,7 @@ def _parse_security_scheme(client: SecurityClient, scheme_metadata: dict, scheme client, scheme_metadata, scheme_metadata, scheme) -def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: dict, security_metadata: dict, value: any): +def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: Dict, security_metadata: Dict, value: any): scheme_type = scheme_metadata.get('type') sub_type = scheme_metadata.get('sub_type') @@ -144,7 +146,7 @@ def _parse_basic_auth_scheme(client: SecurityClient, scheme: dataclass): def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass, - gbls: dict[str, dict[str, dict[str, Any]]] = None) -> str: + gbls: Dict[str, Dict[str, Dict[str, Any]]] = None) -> str: path_param_fields: Tuple[Field, ...] = fields(clazz) for field in path_param_fields: request_metadata = field.metadata.get('request') @@ -173,16 +175,16 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass '{' + key + '}', value, 1) else: if param_metadata.get('style', 'simple') == 'simple': - if isinstance(param, list): - pp_vals: list[str] = [] + if isinstance(param, List): + pp_vals: List[str] = [] for pp_val in param: if pp_val is None: continue pp_vals.append(_val_to_string(pp_val)) path = path.replace( '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - elif isinstance(param, dict): - pp_vals: list[str] = [] + elif isinstance(param, Dict): + pp_vals: List[str] = [] for pp_key in param: if param[pp_key] is None: continue @@ -195,7 +197,7 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass path = path.replace( '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) elif not isinstance(param, (str, int, float, complex, bool, Decimal)): - pp_vals: list[str] = [] + pp_vals: List[str] = [] param_fields: Tuple[Field, ...] = fields(param) for param_field in param_fields: param_value_metadata = param_field.metadata.get( @@ -221,14 +223,14 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass path = path.replace( '{' + param_metadata.get('field_name', field.name) + '}', _val_to_string(param), 1) - return server_url.removesuffix("/") + path + return remove_suffix(server_url, '/') + path def is_optional(field): return get_origin(field) is Union and type(None) in get_args(field) -def template_url(url_with_params: str, params: dict[str, str]) -> str: +def template_url(url_with_params: str, params: Dict[str, str]) -> str: for key, value in params.items(): url_with_params = url_with_params.replace( '{' + key + '}', value) @@ -236,9 +238,9 @@ def template_url(url_with_params: str, params: dict[str, str]) -> str: return url_with_params -def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[str, dict[str, Any]]] = None) -> dict[ - str, list[str]]: - params: dict[str, list[str]] = {} +def get_query_params(clazz: type, query_params: dataclass, gbls: Dict[str, Dict[str, Dict[str, Any]]] = None) -> Dict[ + str, List[str]]: + params: Dict[str, List[str]] = {} param_fields: Tuple[Field, ...] = fields(clazz) for field in param_fields: @@ -268,24 +270,24 @@ def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[ else: style = metadata.get('style', 'form') if style == 'deepObject': - params = params | _get_deep_object_query_params( - metadata, f_name, value) + params = {**params, **_get_deep_object_query_params( + metadata, f_name, value)} elif style == 'form': - params = params | _get_delimited_query_params( - metadata, f_name, value, ",") + params = {**params, **_get_delimited_query_params( + metadata, f_name, value, ",")} elif style == 'pipeDelimited': - params = params | _get_delimited_query_params( - metadata, f_name, value, "|") + params = {**params, **_get_delimited_query_params( + metadata, f_name, value, "|")} else: raise Exception('not yet implemented') return params -def get_headers(headers_params: dataclass) -> dict[str, str]: +def get_headers(headers_params: dataclass) -> Dict[str, str]: if headers_params is None: return {} - headers: dict[str, str] = {} + headers: Dict[str, str] = {} param_fields: Tuple[Field, ...] = fields(headers_params) for field in param_fields: @@ -302,8 +304,8 @@ def get_headers(headers_params: dataclass) -> dict[str, str]: return headers -def _get_serialized_params(metadata: dict, field_name: str, obj: any) -> dict[str, str]: - params: dict[str, str] = {} +def _get_serialized_params(metadata: Dict, field_name: str, obj: any) -> Dict[str, str]: + params: Dict[str, str] = {} serialization = metadata.get('serialization', '') if serialization == 'json': @@ -312,8 +314,8 @@ def _get_serialized_params(metadata: dict, field_name: str, obj: any) -> dict[st return params -def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> dict[str, list[str]]: - params: dict[str, list[str]] = {} +def _get_deep_object_query_params(metadata: Dict, field_name: str, obj: any) -> Dict[str, List[str]]: + params: Dict[str, List[str]] = {} if obj is None: return params @@ -329,7 +331,7 @@ def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> if obj_val is None: continue - if isinstance(obj_val, list): + if isinstance(obj_val, List): for val in obj_val: if val is None: continue @@ -347,12 +349,12 @@ def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> params[ f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'] = [ _val_to_string(obj_val)] - elif isinstance(obj, dict): + elif isinstance(obj, Dict): for key, value in obj.items(): if value is None: continue - if isinstance(value, list): + if isinstance(value, List): for val in value: if val is None: continue @@ -378,8 +380,8 @@ def _get_query_param_field_name(obj_field: Field) -> str: return obj_param_metadata.get("field_name", obj_field.name) -def _get_delimited_query_params(metadata: dict, field_name: str, obj: any, delimiter: str) -> dict[ - str, list[str]]: +def _get_delimited_query_params(metadata: Dict, field_name: str, obj: any, delimiter: str) -> Dict[ + str, List[str]]: return _populate_form(field_name, metadata.get("explode", True), obj, _get_query_param_field_name, delimiter) @@ -392,17 +394,22 @@ def _get_delimited_query_params(metadata: dict, field_name: str, obj: any, delim } -def serialize_request_body(request: dataclass, request_field_name: str, serialization_method: str) -> Tuple[ +def serialize_request_body(request: dataclass, request_field_name: str, nullable: bool, optional: bool, serialization_method: str, encoder=None) -> Tuple[ str, any, any]: if request is None: - return None, None, None + if not nullable and optional: + return None, None, None if not is_dataclass(request) or not hasattr(request, request_field_name): return serialize_content_type(request_field_name, SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], - request) + request, encoder) request_val = getattr(request, request_field_name) + if request_val is None: + if not nullable and optional: + return None, None, None + request_fields: Tuple[Field, ...] = fields(request) request_metadata = None @@ -418,9 +425,9 @@ def serialize_request_body(request: dataclass, request_field_name: str, serializ request_val) -def serialize_content_type(field_name: str, media_type: str, request: dataclass) -> Tuple[str, any, list[list[any]]]: +def serialize_content_type(field_name: str, media_type: str, request: dataclass, encoder=None) -> Tuple[str, any, List[List[any]]]: if re.match(r'(application|text)\/.*?\+*json.*', media_type) is not None: - return media_type, marshal_json(request), None + return media_type, marshal_json(request, encoder), None if re.match(r'multipart\/.*', media_type) is not None: return serialize_multipart_form(media_type, request) if re.match(r'application\/x-www-form-urlencoded.*', media_type) is not None: @@ -434,8 +441,8 @@ def serialize_content_type(field_name: str, media_type: str, request: dataclass) f"invalid request body type {type(request)} for mediaType {media_type}") -def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, any, list[list[any]]]: - form: list[list[any]] = [] +def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, any, List[List[any]]]: + form: List[List[any]] = [] request_fields = fields(request) for field in request_fields: @@ -476,7 +483,7 @@ def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, else: field_name = field_metadata.get( "field_name", field.name) - if isinstance(val, list): + if isinstance(val, List): for value in val: if value is None: continue @@ -487,8 +494,8 @@ def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, return media_type, None, form -def serialize_dict(original: dict, explode: bool, field_name, existing: Optional[dict[str, list[str]]]) -> dict[ - str, list[str]]: +def serialize_dict(original: Dict, explode: bool, field_name, existing: Optional[Dict[str, List[str]]]) -> Dict[ + str, List[str]]: if existing is None: existing = [] @@ -508,8 +515,8 @@ def serialize_dict(original: dict, explode: bool, field_name, existing: Optional return existing -def serialize_form_data(field_name: str, data: dataclass) -> dict[str, any]: - form: dict[str, list[str]] = {} +def serialize_form_data(field_name: str, data: dataclass) -> Dict[str, any]: + form: Dict[str, List[str]] = {} if is_dataclass(data): for field in fields(data): @@ -527,12 +534,12 @@ def serialize_form_data(field_name: str, data: dataclass) -> dict[str, any]: form[field_name] = [marshal_json(val)] else: if metadata.get('style', 'form') == 'form': - form = form | _populate_form( - field_name, metadata.get('explode', True), val, _get_form_field_name, ",") + form = {**form, **_populate_form( + field_name, metadata.get('explode', True), val, _get_form_field_name, ",")} else: raise Exception( f'Invalid form style for field {field.name}') - elif isinstance(data, dict): + elif isinstance(data, Dict): for key, value in data.items(): form[key] = [_val_to_string(value)] else: @@ -551,8 +558,8 @@ def _get_form_field_name(obj_field: Field) -> str: def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_func: Callable, delimiter: str) -> \ - dict[str, list[str]]: - params: dict[str, list[str]] = {} + Dict[str, List[str]]: + params: Dict[str, List[str]] = {} if obj is None: return params @@ -578,7 +585,7 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f if len(items) > 0: params[field_name] = [delimiter.join(items)] - elif isinstance(obj, dict): + elif isinstance(obj, Dict): items = [] for key, value in obj.items(): if value is None: @@ -591,7 +598,7 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f if len(items) > 0: params[field_name] = [delimiter.join(items)] - elif isinstance(obj, list): + elif isinstance(obj, List): items = [] for value in obj: @@ -645,7 +652,7 @@ def _serialize_header(explode: bool, obj: any) -> str: if len(items) > 0: return ','.join(items) - elif isinstance(obj, dict): + elif isinstance(obj, Dict): items = [] for key, value in obj.items(): @@ -660,7 +667,7 @@ def _serialize_header(explode: bool, obj: any) -> str: if len(items) > 0: return ','.join([str(item) for item in items]) - elif isinstance(obj, list): + elif isinstance(obj, List): items = [] for value in obj: @@ -677,7 +684,7 @@ def _serialize_header(explode: bool, obj: any) -> str: return '' -def unmarshal_json(data, typ): +def unmarshal_json(data, typ, decoder=None): unmarshal = make_dataclass('Unmarshal', [('res', typ)], bases=(DataClassJsonMixin,)) json_dict = json.loads(data) @@ -686,15 +693,19 @@ def unmarshal_json(data, typ): except AttributeError as attr_err: raise AttributeError( f'unable to unmarshal {data} as {typ}') from attr_err - return out.res + + return out.res if decoder is None else decoder(out.res) -def marshal_json(val): +def marshal_json(val, encoder=None): marshal = make_dataclass('Marshal', [('res', type(val))], bases=(DataClassJsonMixin,)) marshaller = marshal(res=val) json_dict = marshaller.to_dict() - return json.dumps(json_dict["res"]) + + val = json_dict["res"] if encoder is None else encoder(json_dict["res"]) + + return json.dumps(val) def match_content_type(content_type: str, pattern: str) -> boolean: @@ -768,6 +779,56 @@ def decimaldecoder(val): return Decimal(str(val)) +def map_encoder(optional: bool, value_encoder: Callable): + def map_encode(val: Dict): + if optional and val is None: + return None + + encoded = {} + for key, value in val.items(): + encoded[key] = value_encoder(value) + + return encoded + + return map_encode + + +def map_decoder(value_decoder: Callable): + def map_decode(val: Dict): + decoded = {} + for key, value in val.items(): + decoded[key] = value_decoder(value) + + return decoded + + return map_decode + + +def list_encoder(optional: bool, value_encoder: Callable): + def list_encode(val: List): + if optional and val is None: + return None + + encoded = [] + for value in val: + encoded.append(value_encoder(value)) + + return encoded + + return list_encode + + +def list_decoder(value_decoder: Callable): + def list_decode(val: List): + decoded = [] + for value in val: + decoded.append(value_decoder(value)) + + return decoded + + return list_decode + + def get_field_name(name): def override(_, _field_name=name): return _field_name @@ -786,7 +847,7 @@ def _val_to_string(val): return str(val) -def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: dict[str, dict[str, dict[str, Any]]]): +def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: Dict[str, Dict[str, Dict[str, Any]]]): if value is None and gbls is not None: if 'parameters' in gbls: if param_type in gbls['parameters']: @@ -796,3 +857,16 @@ def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: d value = global_value return value + + +def decoder_with_discriminator(field_name): + def decode_fx(obj): + kls = getattr(sys.modules['sdk.models.shared'], obj[field_name]) + return unmarshal_json(json.dumps(obj), kls) + return decode_fx + + +def remove_suffix(input_string, suffix): + if suffix and input_string.endswith(suffix): + return input_string[:-len(suffix)] + return input_string