diff --git a/sync-for-expenses/README.md b/sync-for-expenses/README.md index f55722fb2..d35b916e8 100755 --- a/sync-for-expenses/README.md +++ b/sync-for-expenses/README.md @@ -33,35 +33,37 @@ req = operations.CreateAccountRequest( fully_qualified_category='Asset.Current', fully_qualified_name='Cash On Hand', id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e', - is_bank_account=False, - metadata=shared.AccountMetadata( - is_deleted=False, - ), + metadata=shared.AccountMetadata(), 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={ + "Money": { + "blue": 'shred', + }, + }, + ), type=shared.AccountType.ASSET, valid_datatype_links=[ shared.AccountValidDataTypeLinks( links=[ - 'Money', + 'abnormally', ], - property='Cambridgeshire grey technology', ), ], ), - allow_sync_on_push_complete=False, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=86, ) res = s.accounts.create(req) if res.create_account_response is not None: # handle response + pass ``` @@ -146,8 +148,6 @@ if res.create_account_response is not None: - - diff --git a/sync-for-expenses/RELEASES.md b/sync-for-expenses/RELEASES.md index 5076322c7..d7e2b207e 100644 --- a/sync-for-expenses/RELEASES.md +++ b/sync-for-expenses/RELEASES.md @@ -666,4 +666,14 @@ Based on: ### Generated - [python v3.1.0] sync-for-expenses ### Releases -- [PyPI v3.1.0] https://pypi.org/project/codat-sync-for-expenses/3.1.0 - sync-for-expenses \ No newline at end of file +- [PyPI v3.1.0] https://pypi.org/project/codat-sync-for-expenses/3.1.0 - sync-for-expenses + +## 2023-10-17 14:49:12 +### Changes +Based on: +- OpenAPI Doc prealpha https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Expenses.yaml +- Speakeasy CLI 1.100.2 (2.159.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v4.0.0] sync-for-expenses +### Releases +- [PyPI v4.0.0] https://pypi.org/project/codat-sync-for-expenses/4.0.0 - sync-for-expenses \ No newline at end of file diff --git a/sync-for-expenses/USAGE.md b/sync-for-expenses/USAGE.md index 380bb8f47..252bf4705 100755 --- a/sync-for-expenses/USAGE.md +++ b/sync-for-expenses/USAGE.md @@ -20,34 +20,36 @@ req = operations.CreateAccountRequest( fully_qualified_category='Asset.Current', fully_qualified_name='Cash On Hand', id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e', - is_bank_account=False, - metadata=shared.AccountMetadata( - is_deleted=False, - ), + metadata=shared.AccountMetadata(), 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={ + "Money": { + "blue": 'shred', + }, + }, + ), type=shared.AccountType.ASSET, valid_datatype_links=[ shared.AccountValidDataTypeLinks( links=[ - 'Money', + 'abnormally', ], - property='Cambridgeshire grey technology', ), ], ), - allow_sync_on_push_complete=False, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=86, ) res = s.accounts.create(req) if res.create_account_response is not None: # handle response + pass ``` \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/createaccountrequest.md b/sync-for-expenses/docs/models/operations/createaccountrequest.md index ac7264515..9bb2d8077 100755 --- a/sync-for-expenses/docs/models/operations/createaccountrequest.md +++ b/sync-for-expenses/docs/models/operations/createaccountrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `account` | [Optional[shared.Account]](undefined/models/shared/account.md) | :heavy_minus_sign: | N/A | | +| `account` | [Optional[shared.Account]](../../models/shared/account.md) | :heavy_minus_sign: | N/A | | | `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a connection. | 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 | | `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/sync-for-expenses/docs/models/operations/createaccountresponse.md b/sync-for-expenses/docs/models/operations/createaccountresponse.md index ede8402b8..a91d51ce3 100755 --- a/sync-for-expenses/docs/models/operations/createaccountresponse.md +++ b/sync-for-expenses/docs/models/operations/createaccountresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `create_account_response` | [Optional[shared.CreateAccountResponse]](undefined/models/shared/createaccountresponse.md) | :heavy_minus_sign: | Success | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *Optional[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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `create_account_response` | [Optional[shared.CreateAccountResponse]](../../models/shared/createaccountresponse.md) | :heavy_minus_sign: | Success | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | +| `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/sync-for-expenses/docs/models/operations/createcompanyresponse.md b/sync-for-expenses/docs/models/operations/createcompanyresponse.md index 7aed877cc..b780d6bc9 100755 --- a/sync-for-expenses/docs/models/operations/createcompanyresponse.md +++ b/sync-for-expenses/docs/models/operations/createcompanyresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `company` | [Optional[shared.Company]](undefined/models/shared/company.md) | :heavy_minus_sign: | OK | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | +| `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: | 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/sync-for-expenses/docs/models/operations/createconnectionrequest.md b/sync-for-expenses/docs/models/operations/createconnectionrequest.md index 046971b1f..b315a6d5e 100755 --- a/sync-for-expenses/docs/models/operations/createconnectionrequest.md +++ b/sync-for-expenses/docs/models/operations/createconnectionrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `request_body` | [Optional[operations.CreateConnectionRequestBody]](undefined/models/operations/createconnectionrequestbody.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[CreateConnectionRequestBody]](../../models/operations/createconnectionrequestbody.md) | :heavy_minus_sign: | N/A | | +| `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/sync-for-expenses/docs/models/operations/createconnectionresponse.md b/sync-for-expenses/docs/models/operations/createconnectionresponse.md index 1164dca25..6cf898dc4 100755 --- a/sync-for-expenses/docs/models/operations/createconnectionresponse.md +++ b/sync-for-expenses/docs/models/operations/createconnectionresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connection` | [Optional[shared.Connection]](undefined/models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | +| `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: | 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/sync-for-expenses/docs/models/operations/createcustomerrequest.md b/sync-for-expenses/docs/models/operations/createcustomerrequest.md index 9e5d0be9f..1d3602c2c 100755 --- a/sync-for-expenses/docs/models/operations/createcustomerrequest.md +++ b/sync-for-expenses/docs/models/operations/createcustomerrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `customer` | [Optional[shared.Customer]](undefined/models/shared/customer.md) | :heavy_minus_sign: | N/A | | +| `customer` | [Optional[shared.Customer]](../../models/shared/customer.md) | :heavy_minus_sign: | N/A | | | `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a connection. | 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 | | `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/sync-for-expenses/docs/models/operations/createcustomerresponse.md b/sync-for-expenses/docs/models/operations/createcustomerresponse.md index a12f6e362..2577803fe 100755 --- a/sync-for-expenses/docs/models/operations/createcustomerresponse.md +++ b/sync-for-expenses/docs/models/operations/createcustomerresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `create_customer_response` | [Optional[shared.CreateCustomerResponse]](undefined/models/shared/createcustomerresponse.md) | :heavy_minus_sign: | Success | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *Optional[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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `create_customer_response` | [Optional[shared.CreateCustomerResponse]](../../models/shared/createcustomerresponse.md) | :heavy_minus_sign: | Success | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | +| `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/sync-for-expenses/docs/models/operations/createexpensetransactionrequest.md b/sync-for-expenses/docs/models/operations/createexpensetransactionrequest.md index 115be974e..c77505081 100755 --- a/sync-for-expenses/docs/models/operations/createexpensetransactionrequest.md +++ b/sync-for-expenses/docs/models/operations/createexpensetransactionrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `create_expense_request` | [Optional[shared.CreateExpenseRequest]](undefined/models/shared/createexpenserequest.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `create_expense_request` | [Optional[shared.CreateExpenseRequest]](../../models/shared/createexpenserequest.md) | :heavy_minus_sign: | N/A | | +| `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/sync-for-expenses/docs/models/operations/createexpensetransactionresponse.md b/sync-for-expenses/docs/models/operations/createexpensetransactionresponse.md index 5890d476f..ea454810e 100755 --- a/sync-for-expenses/docs/models/operations/createexpensetransactionresponse.md +++ b/sync-for-expenses/docs/models/operations/createexpensetransactionresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `create_expense_response` | [Optional[shared.CreateExpenseResponse]](undefined/models/shared/createexpenseresponse.md) | :heavy_minus_sign: | OK | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *Optional[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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `create_expense_response` | [Optional[shared.CreateExpenseResponse]](../../models/shared/createexpenseresponse.md) | :heavy_minus_sign: | OK | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | +| `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/sync-for-expenses/docs/models/operations/createpartnerexpenseconnectionrequest.md b/sync-for-expenses/docs/models/operations/createpartnerexpenseconnectionrequest.md index ea9e2ce7d..d1793f934 100755 --- a/sync-for-expenses/docs/models/operations/createpartnerexpenseconnectionrequest.md +++ b/sync-for-expenses/docs/models/operations/createpartnerexpenseconnectionrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/createpartnerexpenseconnectionresponse.md b/sync-for-expenses/docs/models/operations/createpartnerexpenseconnectionresponse.md index ea35f4b8e..795803141 100755 --- a/sync-for-expenses/docs/models/operations/createpartnerexpenseconnectionresponse.md +++ b/sync-for-expenses/docs/models/operations/createpartnerexpenseconnectionresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connection` | [Optional[shared.Connection]](undefined/models/shared/connection.md) | :heavy_minus_sign: | Success | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | Success | +| `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: | 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/sync-for-expenses/docs/models/operations/createsupplierrequest.md b/sync-for-expenses/docs/models/operations/createsupplierrequest.md index 2bedc87a2..52d43571a 100755 --- a/sync-for-expenses/docs/models/operations/createsupplierrequest.md +++ b/sync-for-expenses/docs/models/operations/createsupplierrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `supplier` | [Optional[shared.Supplier]](undefined/models/shared/supplier.md) | :heavy_minus_sign: | N/A | | +| `supplier` | [Optional[shared.Supplier]](../../models/shared/supplier.md) | :heavy_minus_sign: | N/A | | | `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a connection. | 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 | | `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/sync-for-expenses/docs/models/operations/createsupplierresponse.md b/sync-for-expenses/docs/models/operations/createsupplierresponse.md index d64742a74..f8620575a 100755 --- a/sync-for-expenses/docs/models/operations/createsupplierresponse.md +++ b/sync-for-expenses/docs/models/operations/createsupplierresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `create_supplier_response` | [Optional[shared.CreateSupplierResponse]](undefined/models/shared/createsupplierresponse.md) | :heavy_minus_sign: | Success | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *Optional[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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `create_supplier_response` | [Optional[shared.CreateSupplierResponse]](../../models/shared/createsupplierresponse.md) | :heavy_minus_sign: | Success | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | +| `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/sync-for-expenses/docs/models/operations/deletecompanyrequest.md b/sync-for-expenses/docs/models/operations/deletecompanyrequest.md index 13ef712cb..338ee40e5 100755 --- a/sync-for-expenses/docs/models/operations/deletecompanyrequest.md +++ b/sync-for-expenses/docs/models/operations/deletecompanyrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/deletecompanyresponse.md b/sync-for-expenses/docs/models/operations/deletecompanyresponse.md index b3e7dbfeb..f3f21c2cb 100755 --- a/sync-for-expenses/docs/models/operations/deletecompanyresponse.md +++ b/sync-for-expenses/docs/models/operations/deletecompanyresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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/sync-for-expenses/docs/models/operations/deleteconnectionrequest.md b/sync-for-expenses/docs/models/operations/deleteconnectionrequest.md index d368cd960..9650dc387 100755 --- a/sync-for-expenses/docs/models/operations/deleteconnectionrequest.md +++ b/sync-for-expenses/docs/models/operations/deleteconnectionrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a connection. | 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/sync-for-expenses/docs/models/operations/deleteconnectionresponse.md b/sync-for-expenses/docs/models/operations/deleteconnectionresponse.md index 3b507d766..30889c508 100755 --- a/sync-for-expenses/docs/models/operations/deleteconnectionresponse.md +++ b/sync-for-expenses/docs/models/operations/deleteconnectionresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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/sync-for-expenses/docs/models/operations/getcompanyconfigurationrequest.md b/sync-for-expenses/docs/models/operations/getcompanyconfigurationrequest.md index 02dc022ac..a5b1fe784 100755 --- a/sync-for-expenses/docs/models/operations/getcompanyconfigurationrequest.md +++ b/sync-for-expenses/docs/models/operations/getcompanyconfigurationrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/getcompanyconfigurationresponse.md b/sync-for-expenses/docs/models/operations/getcompanyconfigurationresponse.md index 6e2c5a46e..47d32738c 100755 --- a/sync-for-expenses/docs/models/operations/getcompanyconfigurationresponse.md +++ b/sync-for-expenses/docs/models/operations/getcompanyconfigurationresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `company_configuration` | [Optional[shared.CompanyConfiguration]](undefined/models/shared/companyconfiguration.md) | :heavy_minus_sign: | Success | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `company_configuration` | [Optional[shared.CompanyConfiguration]](../../models/shared/companyconfiguration.md) | :heavy_minus_sign: | Success | +| `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: | 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/sync-for-expenses/docs/models/operations/getcompanyrequest.md b/sync-for-expenses/docs/models/operations/getcompanyrequest.md index 47faa5619..240b811b6 100755 --- a/sync-for-expenses/docs/models/operations/getcompanyrequest.md +++ b/sync-for-expenses/docs/models/operations/getcompanyrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/getcompanyresponse.md b/sync-for-expenses/docs/models/operations/getcompanyresponse.md index 781207522..2f82e6ca0 100755 --- a/sync-for-expenses/docs/models/operations/getcompanyresponse.md +++ b/sync-for-expenses/docs/models/operations/getcompanyresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `company` | [Optional[shared.Company]](undefined/models/shared/company.md) | :heavy_minus_sign: | OK | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | +| `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: | 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/sync-for-expenses/docs/models/operations/getconnectionrequest.md b/sync-for-expenses/docs/models/operations/getconnectionrequest.md index 9c44e2c99..6e9f3d18b 100755 --- a/sync-for-expenses/docs/models/operations/getconnectionrequest.md +++ b/sync-for-expenses/docs/models/operations/getconnectionrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a connection. | 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/sync-for-expenses/docs/models/operations/getconnectionresponse.md b/sync-for-expenses/docs/models/operations/getconnectionresponse.md index 33e0a0283..c308aece1 100755 --- a/sync-for-expenses/docs/models/operations/getconnectionresponse.md +++ b/sync-for-expenses/docs/models/operations/getconnectionresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connection` | [Optional[shared.Connection]](undefined/models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | +| `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: | 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/sync-for-expenses/docs/models/operations/getcreatechartofaccountsmodelrequest.md b/sync-for-expenses/docs/models/operations/getcreatechartofaccountsmodelrequest.md index b7eabbe69..11af40316 100755 --- a/sync-for-expenses/docs/models/operations/getcreatechartofaccountsmodelrequest.md +++ b/sync-for-expenses/docs/models/operations/getcreatechartofaccountsmodelrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a connection. | 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/sync-for-expenses/docs/models/operations/getcreatechartofaccountsmodelresponse.md b/sync-for-expenses/docs/models/operations/getcreatechartofaccountsmodelresponse.md index 4305f6570..fa5a05fa4 100755 --- a/sync-for-expenses/docs/models/operations/getcreatechartofaccountsmodelresponse.md +++ b/sync-for-expenses/docs/models/operations/getcreatechartofaccountsmodelresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `push_option` | [Optional[shared.PushOption]](undefined/models/shared/pushoption.md) | :heavy_minus_sign: | OK | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | +| `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/sync-for-expenses/docs/models/operations/getcustomerrequest.md b/sync-for-expenses/docs/models/operations/getcustomerrequest.md index 74d8ba5ed..48c68a5d4 100755 --- a/sync-for-expenses/docs/models/operations/getcustomerrequest.md +++ b/sync-for-expenses/docs/models/operations/getcustomerrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `customer_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a customer. | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `customer_id` | *str* | :heavy_check_mark: | Unique identifier for a customer. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/getcustomerresponse.md b/sync-for-expenses/docs/models/operations/getcustomerresponse.md index d698a4808..e9c7abe95 100755 --- a/sync-for-expenses/docs/models/operations/getcustomerresponse.md +++ b/sync-for-expenses/docs/models/operations/getcustomerresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `customer` | [Optional[shared.Customer]](undefined/models/shared/customer.md) | :heavy_minus_sign: | Success | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `customer` | [Optional[shared.Customer]](../../models/shared/customer.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: | 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/sync-for-expenses/docs/models/operations/getdatastatusrequest.md b/sync-for-expenses/docs/models/operations/getdatastatusrequest.md index 16085ef95..12c2e50b6 100755 --- a/sync-for-expenses/docs/models/operations/getdatastatusrequest.md +++ b/sync-for-expenses/docs/models/operations/getdatastatusrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/getdatastatusresponse.md b/sync-for-expenses/docs/models/operations/getdatastatusresponse.md index a38cb2518..18bcc12b7 100755 --- a/sync-for-expenses/docs/models/operations/getdatastatusresponse.md +++ b/sync-for-expenses/docs/models/operations/getdatastatusresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `data_status_response` | dict[str, [shared.DataStatus](undefined/models/shared/datastatus.md)] | :heavy_minus_sign: | OK | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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/sync-for-expenses/docs/models/operations/getlastsuccessfulsyncrequest.md b/sync-for-expenses/docs/models/operations/getlastsuccessfulsyncrequest.md index 53a7e6324..9963e44ed 100755 --- a/sync-for-expenses/docs/models/operations/getlastsuccessfulsyncrequest.md +++ b/sync-for-expenses/docs/models/operations/getlastsuccessfulsyncrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/getlastsuccessfulsyncresponse.md b/sync-for-expenses/docs/models/operations/getlastsuccessfulsyncresponse.md index fc913a65e..bccf3a7da 100755 --- a/sync-for-expenses/docs/models/operations/getlastsuccessfulsyncresponse.md +++ b/sync-for-expenses/docs/models/operations/getlastsuccessfulsyncresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `company_sync_status` | [Optional[shared.CompanySyncStatus]](undefined/models/shared/companysyncstatus.md) | :heavy_minus_sign: | Success | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `company_sync_status` | [Optional[shared.CompanySyncStatus]](../../models/shared/companysyncstatus.md) | :heavy_minus_sign: | Success | +| `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: | 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/sync-for-expenses/docs/models/operations/getlatestsyncrequest.md b/sync-for-expenses/docs/models/operations/getlatestsyncrequest.md index fdf284a58..a3bf4745a 100755 --- a/sync-for-expenses/docs/models/operations/getlatestsyncrequest.md +++ b/sync-for-expenses/docs/models/operations/getlatestsyncrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/getlatestsyncresponse.md b/sync-for-expenses/docs/models/operations/getlatestsyncresponse.md index 662614dab..bd4e2cd6c 100755 --- a/sync-for-expenses/docs/models/operations/getlatestsyncresponse.md +++ b/sync-for-expenses/docs/models/operations/getlatestsyncresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `company_sync_status` | [Optional[shared.CompanySyncStatus]](undefined/models/shared/companysyncstatus.md) | :heavy_minus_sign: | Success | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `company_sync_status` | [Optional[shared.CompanySyncStatus]](../../models/shared/companysyncstatus.md) | :heavy_minus_sign: | Success | +| `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: | 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/sync-for-expenses/docs/models/operations/getmappingoptionsrequest.md b/sync-for-expenses/docs/models/operations/getmappingoptionsrequest.md index e9a18171d..ee9e96101 100755 --- a/sync-for-expenses/docs/models/operations/getmappingoptionsrequest.md +++ b/sync-for-expenses/docs/models/operations/getmappingoptionsrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/getmappingoptionsresponse.md b/sync-for-expenses/docs/models/operations/getmappingoptionsresponse.md index 27d23ad2c..2da443b6c 100755 --- a/sync-for-expenses/docs/models/operations/getmappingoptionsresponse.md +++ b/sync-for-expenses/docs/models/operations/getmappingoptionsresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `mapping_options` | [Optional[shared.MappingOptions]](undefined/models/shared/mappingoptions.md) | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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. | +| `mapping_options` | [Optional[shared.MappingOptions]](../../models/shared/mappingoptions.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/sync-for-expenses/docs/models/operations/getpulloperationrequest.md b/sync-for-expenses/docs/models/operations/getpulloperationrequest.md index b44c0bbdc..d2382bd6c 100755 --- a/sync-for-expenses/docs/models/operations/getpulloperationrequest.md +++ b/sync-for-expenses/docs/models/operations/getpulloperationrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `dataset_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for the dataset that completed its sync. | | \ No newline at end of file +| `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/sync-for-expenses/docs/models/operations/getpulloperationresponse.md b/sync-for-expenses/docs/models/operations/getpulloperationresponse.md index b88270e05..41674afa9 100755 --- a/sync-for-expenses/docs/models/operations/getpulloperationresponse.md +++ b/sync-for-expenses/docs/models/operations/getpulloperationresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `pull_operation` | [Optional[shared.PullOperation]](undefined/models/shared/pulloperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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/sync-for-expenses/docs/models/operations/getpushoperationrequest.md b/sync-for-expenses/docs/models/operations/getpushoperationrequest.md index 3f856477b..d667790b5 100755 --- a/sync-for-expenses/docs/models/operations/getpushoperationrequest.md +++ b/sync-for-expenses/docs/models/operations/getpushoperationrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `push_operation_key` | *Optional[str]* | :heavy_check_mark: | Push operation key. | | \ No newline at end of file +| `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/sync-for-expenses/docs/models/operations/getpushoperationresponse.md b/sync-for-expenses/docs/models/operations/getpushoperationresponse.md index 1630534b2..7dd02aeed 100755 --- a/sync-for-expenses/docs/models/operations/getpushoperationresponse.md +++ b/sync-for-expenses/docs/models/operations/getpushoperationresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `push_operation` | [Optional[shared.PushOperation]](undefined/models/shared/pushoperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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/sync-for-expenses/docs/models/operations/getsupplierrequest.md b/sync-for-expenses/docs/models/operations/getsupplierrequest.md index cadd649ee..afebc9154 100755 --- a/sync-for-expenses/docs/models/operations/getsupplierrequest.md +++ b/sync-for-expenses/docs/models/operations/getsupplierrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `supplier_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a supplier. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `supplier_id` | *str* | :heavy_check_mark: | Unique identifier for a supplier. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/getsupplierresponse.md b/sync-for-expenses/docs/models/operations/getsupplierresponse.md index 29cb0c709..3af35ef18 100755 --- a/sync-for-expenses/docs/models/operations/getsupplierresponse.md +++ b/sync-for-expenses/docs/models/operations/getsupplierresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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 | -| `supplier` | [Optional[shared.Supplier]](undefined/models/shared/supplier.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `supplier` | [Optional[shared.Supplier]](../../models/shared/supplier.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/getsyncbyidrequest.md b/sync-for-expenses/docs/models/operations/getsyncbyidrequest.md index 41420d082..3de850e2b 100755 --- a/sync-for-expenses/docs/models/operations/getsyncbyidrequest.md +++ b/sync-for-expenses/docs/models/operations/getsyncbyidrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `sync_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a sync. | 6fb40d5e-b13e-11ed-afa1-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `sync_id` | *str* | :heavy_check_mark: | Unique identifier for a sync. | 6fb40d5e-b13e-11ed-afa1-0242ac120002 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/getsyncbyidresponse.md b/sync-for-expenses/docs/models/operations/getsyncbyidresponse.md index f72566d1f..7bca2f4ba 100755 --- a/sync-for-expenses/docs/models/operations/getsyncbyidresponse.md +++ b/sync-for-expenses/docs/models/operations/getsyncbyidresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `company_sync_status` | [Optional[shared.CompanySyncStatus]](undefined/models/shared/companysyncstatus.md) | :heavy_minus_sign: | Success | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `company_sync_status` | [Optional[shared.CompanySyncStatus]](../../models/shared/companysyncstatus.md) | :heavy_minus_sign: | Success | +| `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: | 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/sync-for-expenses/docs/models/operations/getsynctransactionrequest.md b/sync-for-expenses/docs/models/operations/getsynctransactionrequest.md index 9ae4bf572..d5075762f 100755 --- a/sync-for-expenses/docs/models/operations/getsynctransactionrequest.md +++ b/sync-for-expenses/docs/models/operations/getsynctransactionrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `sync_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a sync. | 6fb40d5e-b13e-11ed-afa1-0242ac120002 | -| `transaction_id` | *Optional[str]* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `sync_id` | *str* | :heavy_check_mark: | Unique identifier for a sync. | 6fb40d5e-b13e-11ed-afa1-0242ac120002 | +| `transaction_id` | *str* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/getsynctransactionresponse.md b/sync-for-expenses/docs/models/operations/getsynctransactionresponse.md index f1d7ffd21..a7b2408a3 100755 --- a/sync-for-expenses/docs/models/operations/getsynctransactionresponse.md +++ b/sync-for-expenses/docs/models/operations/getsynctransactionresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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 | -| `transaction` | [Optional[shared.Transaction]](undefined/models/shared/transaction.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `transaction` | [Optional[shared.Transaction]](../../models/shared/transaction.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/initiatesyncrequest.md b/sync-for-expenses/docs/models/operations/initiatesyncrequest.md index a16ee10ef..b16459728 100755 --- a/sync-for-expenses/docs/models/operations/initiatesyncrequest.md +++ b/sync-for-expenses/docs/models/operations/initiatesyncrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `initiate_sync` | [Optional[shared.InitiateSync]](undefined/models/shared/initiatesync.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `initiate_sync` | [Optional[shared.InitiateSync]](../../models/shared/initiatesync.md) | :heavy_minus_sign: | N/A | | +| `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/sync-for-expenses/docs/models/operations/initiatesyncresponse.md b/sync-for-expenses/docs/models/operations/initiatesyncresponse.md index a12de27cb..ca473e61b 100755 --- a/sync-for-expenses/docs/models/operations/initiatesyncresponse.md +++ b/sync-for-expenses/docs/models/operations/initiatesyncresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | If model is incorrect | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | If model is incorrect | +| `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_initiated` | [Optional[shared.SyncInitiated]](undefined/models/shared/syncinitiated.md) | :heavy_minus_sign: | Returns the newly created SyncId | \ No newline at end of file +| `sync_initiated` | [Optional[shared.SyncInitiated]](../../models/shared/syncinitiated.md) | :heavy_minus_sign: | Returns the newly created SyncId | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/listcompaniesresponse.md b/sync-for-expenses/docs/models/operations/listcompaniesresponse.md index c2e7f425f..d9c512cea 100755 --- a/sync-for-expenses/docs/models/operations/listcompaniesresponse.md +++ b/sync-for-expenses/docs/models/operations/listcompaniesresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `companies` | [Optional[shared.Companies]](undefined/models/shared/companies.md) | :heavy_minus_sign: | OK | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `companies` | [Optional[shared.Companies]](../../models/shared/companies.md) | :heavy_minus_sign: | OK | +| `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: | 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/sync-for-expenses/docs/models/operations/listconnectionsrequest.md b/sync-for-expenses/docs/models/operations/listconnectionsrequest.md index 0a1f508ab..e13ad736b 100755 --- a/sync-for-expenses/docs/models/operations/listconnectionsrequest.md +++ b/sync-for-expenses/docs/models/operations/listconnectionsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/listconnectionsresponse.md b/sync-for-expenses/docs/models/operations/listconnectionsresponse.md index 03257ac74..0de0ad796 100755 --- a/sync-for-expenses/docs/models/operations/listconnectionsresponse.md +++ b/sync-for-expenses/docs/models/operations/listconnectionsresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connections` | [Optional[shared.Connections]](undefined/models/shared/connections.md) | :heavy_minus_sign: | OK | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `connections` | [Optional[shared.Connections]](../../models/shared/connections.md) | :heavy_minus_sign: | OK | +| `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: | 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/sync-for-expenses/docs/models/operations/listcustomersrequest.md b/sync-for-expenses/docs/models/operations/listcustomersrequest.md index 4b89ca5af..0d9a2bf1c 100755 --- a/sync-for-expenses/docs/models/operations/listcustomersrequest.md +++ b/sync-for-expenses/docs/models/operations/listcustomersrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/listcustomersresponse.md b/sync-for-expenses/docs/models/operations/listcustomersresponse.md index fbfe167cf..27adb68ef 100755 --- a/sync-for-expenses/docs/models/operations/listcustomersresponse.md +++ b/sync-for-expenses/docs/models/operations/listcustomersresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `customers` | [Optional[shared.Customers]](undefined/models/shared/customers.md) | :heavy_minus_sign: | Success | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `customers` | [Optional[shared.Customers]](../../models/shared/customers.md) | :heavy_minus_sign: | Success | +| `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: | 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/sync-for-expenses/docs/models/operations/listpulloperationsrequest.md b/sync-for-expenses/docs/models/operations/listpulloperationsrequest.md index 9f9ca253c..bdf3bef92 100755 --- a/sync-for-expenses/docs/models/operations/listpulloperationsrequest.md +++ b/sync-for-expenses/docs/models/operations/listpulloperationsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/listpulloperationsresponse.md b/sync-for-expenses/docs/models/operations/listpulloperationsresponse.md index e434a487b..feff59654 100755 --- a/sync-for-expenses/docs/models/operations/listpulloperationsresponse.md +++ b/sync-for-expenses/docs/models/operations/listpulloperationsresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `pull_operations` | [Optional[shared.PullOperations]](undefined/models/shared/pulloperations.md) | :heavy_minus_sign: | OK | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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/sync-for-expenses/docs/models/operations/listpushoperationsrequest.md b/sync-for-expenses/docs/models/operations/listpushoperationsrequest.md index 4a311dc1a..3e934bc15 100755 --- a/sync-for-expenses/docs/models/operations/listpushoperationsrequest.md +++ b/sync-for-expenses/docs/models/operations/listpushoperationsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/listpushoperationsresponse.md b/sync-for-expenses/docs/models/operations/listpushoperationsresponse.md index 0e807e1bc..57c1b20b3 100755 --- a/sync-for-expenses/docs/models/operations/listpushoperationsresponse.md +++ b/sync-for-expenses/docs/models/operations/listpushoperationsresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `push_operations` | [Optional[shared.PushOperations]](undefined/models/shared/pushoperations.md) | :heavy_minus_sign: | OK | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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/sync-for-expenses/docs/models/operations/listsuppliersrequest.md b/sync-for-expenses/docs/models/operations/listsuppliersrequest.md index 25832890f..53fa35624 100755 --- a/sync-for-expenses/docs/models/operations/listsuppliersrequest.md +++ b/sync-for-expenses/docs/models/operations/listsuppliersrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/listsuppliersresponse.md b/sync-for-expenses/docs/models/operations/listsuppliersresponse.md index 789a950ef..35d01e6ba 100755 --- a/sync-for-expenses/docs/models/operations/listsuppliersresponse.md +++ b/sync-for-expenses/docs/models/operations/listsuppliersresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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 | -| `suppliers` | [Optional[shared.Suppliers]](undefined/models/shared/suppliers.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `suppliers` | [Optional[shared.Suppliers]](../../models/shared/suppliers.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/listsyncsrequest.md b/sync-for-expenses/docs/models/operations/listsyncsrequest.md index 50b3c7b20..5bf61df8e 100755 --- a/sync-for-expenses/docs/models/operations/listsyncsrequest.md +++ b/sync-for-expenses/docs/models/operations/listsyncsrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/listsyncsresponse.md b/sync-for-expenses/docs/models/operations/listsyncsresponse.md index 5e070b614..80378b970 100755 --- a/sync-for-expenses/docs/models/operations/listsyncsresponse.md +++ b/sync-for-expenses/docs/models/operations/listsyncsresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `company_sync_statuses` | list[[shared.CompanySyncStatus](undefined/models/shared/companysyncstatus.md)] | :heavy_minus_sign: | Success | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `company_sync_statuses` | List[[shared.CompanySyncStatus](../../models/shared/companysyncstatus.md)] | :heavy_minus_sign: | Success | +| `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: | 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/sync-for-expenses/docs/models/operations/listsynctransactionsrequest.md b/sync-for-expenses/docs/models/operations/listsynctransactionsrequest.md index 9039fcf93..3293bbae1 100755 --- a/sync-for-expenses/docs/models/operations/listsynctransactionsrequest.md +++ b/sync-for-expenses/docs/models/operations/listsynctransactionsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `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 | -| `sync_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a sync. | 6fb40d5e-b13e-11ed-afa1-0242ac120002 | \ No newline at end of file +| `sync_id` | *str* | :heavy_check_mark: | Unique identifier for a sync. | 6fb40d5e-b13e-11ed-afa1-0242ac120002 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/listsynctransactionsresponse.md b/sync-for-expenses/docs/models/operations/listsynctransactionsresponse.md index 07c6c2290..73f78df9a 100755 --- a/sync-for-expenses/docs/models/operations/listsynctransactionsresponse.md +++ b/sync-for-expenses/docs/models/operations/listsynctransactionsresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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 | -| `transactions` | [Optional[shared.Transactions]](undefined/models/shared/transactions.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `transactions` | [Optional[shared.Transactions]](../../models/shared/transactions.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/refreshalldatatypesrequest.md b/sync-for-expenses/docs/models/operations/refreshalldatatypesrequest.md index c08ccf1e3..ea381e387 100755 --- a/sync-for-expenses/docs/models/operations/refreshalldatatypesrequest.md +++ b/sync-for-expenses/docs/models/operations/refreshalldatatypesrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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/sync-for-expenses/docs/models/operations/refreshalldatatypesresponse.md b/sync-for-expenses/docs/models/operations/refreshalldatatypesresponse.md index 313e27203..0788fc5da 100755 --- a/sync-for-expenses/docs/models/operations/refreshalldatatypesresponse.md +++ b/sync-for-expenses/docs/models/operations/refreshalldatatypesresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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/sync-for-expenses/docs/models/operations/refreshdatatyperequest.md b/sync-for-expenses/docs/models/operations/refreshdatatyperequest.md index 98926109e..257381833 100755 --- a/sync-for-expenses/docs/models/operations/refreshdatatyperequest.md +++ b/sync-for-expenses/docs/models/operations/refreshdatatyperequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 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` | [Optional[shared.DataType]](undefined/models/shared/datatype.md) | :heavy_check_mark: | The key of a Codat data type | invoices | \ No newline at end of file +| `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/sync-for-expenses/docs/models/operations/refreshdatatyperesponse.md b/sync-for-expenses/docs/models/operations/refreshdatatyperesponse.md index 942cd3b80..5a4e614bb 100755 --- a/sync-for-expenses/docs/models/operations/refreshdatatyperesponse.md +++ b/sync-for-expenses/docs/models/operations/refreshdatatyperesponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `pull_operation` | [Optional[shared.PullOperation]](undefined/models/shared/pulloperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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: | 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/sync-for-expenses/docs/models/operations/setcompanyconfigurationrequest.md b/sync-for-expenses/docs/models/operations/setcompanyconfigurationrequest.md index ba5176174..1afe2e73f 100755 --- a/sync-for-expenses/docs/models/operations/setcompanyconfigurationrequest.md +++ b/sync-for-expenses/docs/models/operations/setcompanyconfigurationrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `company_configuration` | [Optional[shared.CompanyConfiguration]](undefined/models/shared/companyconfiguration.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `company_configuration` | [Optional[shared.CompanyConfiguration]](../../models/shared/companyconfiguration.md) | :heavy_minus_sign: | N/A | | +| `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/sync-for-expenses/docs/models/operations/setcompanyconfigurationresponse.md b/sync-for-expenses/docs/models/operations/setcompanyconfigurationresponse.md index 55f30f332..4f53a61ad 100755 --- a/sync-for-expenses/docs/models/operations/setcompanyconfigurationresponse.md +++ b/sync-for-expenses/docs/models/operations/setcompanyconfigurationresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `company_configuration` | [Optional[shared.CompanyConfiguration]](undefined/models/shared/companyconfiguration.md) | :heavy_minus_sign: | Success | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *Optional[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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `company_configuration` | [Optional[shared.CompanyConfiguration]](../../models/shared/companyconfiguration.md) | :heavy_minus_sign: | Success | +| `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: | 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/sync-for-expenses/docs/models/operations/unlinkconnectionrequest.md b/sync-for-expenses/docs/models/operations/unlinkconnectionrequest.md index 20d524f86..1f83e7cfa 100755 --- a/sync-for-expenses/docs/models/operations/unlinkconnectionrequest.md +++ b/sync-for-expenses/docs/models/operations/unlinkconnectionrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `request_body` | [Optional[operations.UnlinkConnectionUpdateConnection]](undefined/models/operations/unlinkconnectionupdateconnection.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[UnlinkConnectionUpdateConnection]](../../models/operations/unlinkconnectionupdateconnection.md) | :heavy_minus_sign: | N/A | | +| `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/sync-for-expenses/docs/models/operations/unlinkconnectionresponse.md b/sync-for-expenses/docs/models/operations/unlinkconnectionresponse.md index ad1281ad3..642e8e815 100755 --- a/sync-for-expenses/docs/models/operations/unlinkconnectionresponse.md +++ b/sync-for-expenses/docs/models/operations/unlinkconnectionresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connection` | [Optional[shared.Connection]](undefined/models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | +| `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: | 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/sync-for-expenses/docs/models/operations/unlinkconnectionupdateconnection.md b/sync-for-expenses/docs/models/operations/unlinkconnectionupdateconnection.md index 5acff4684..5a5f2911b 100755 --- a/sync-for-expenses/docs/models/operations/unlinkconnectionupdateconnection.md +++ b/sync-for-expenses/docs/models/operations/unlinkconnectionupdateconnection.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `status` | [Optional[shared.DataConnectionStatus]](undefined/models/shared/dataconnectionstatus.md) | :heavy_minus_sign: | The current authorization status of the data connection. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `status` | [Optional[shared.DataConnectionStatus]](../../models/shared/dataconnectionstatus.md) | :heavy_minus_sign: | The current authorization status of the data connection. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/updatecompanyrequest.md b/sync-for-expenses/docs/models/operations/updatecompanyrequest.md index 6fe6a041b..7b76c7562 100755 --- a/sync-for-expenses/docs/models/operations/updatecompanyrequest.md +++ b/sync-for-expenses/docs/models/operations/updatecompanyrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `company_request_body` | [Optional[shared.CompanyRequestBody]](undefined/models/shared/companyrequestbody.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `company_request_body` | [Optional[shared.CompanyRequestBody]](../../models/shared/companyrequestbody.md) | :heavy_minus_sign: | N/A | | +| `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/sync-for-expenses/docs/models/operations/updatecompanyresponse.md b/sync-for-expenses/docs/models/operations/updatecompanyresponse.md index f6582a2d8..b60ed7a56 100755 --- a/sync-for-expenses/docs/models/operations/updatecompanyresponse.md +++ b/sync-for-expenses/docs/models/operations/updatecompanyresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `company` | [Optional[shared.Company]](undefined/models/shared/company.md) | :heavy_minus_sign: | OK | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | +| `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: | 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/sync-for-expenses/docs/models/operations/updatecustomerrequest.md b/sync-for-expenses/docs/models/operations/updatecustomerrequest.md index d9a07531a..8de2214ec 100755 --- a/sync-for-expenses/docs/models/operations/updatecustomerrequest.md +++ b/sync-for-expenses/docs/models/operations/updatecustomerrequest.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `customer` | [Optional[shared.Customer]](undefined/models/shared/customer.md) | :heavy_minus_sign: | N/A | | +| `customer` | [Optional[shared.Customer]](../../models/shared/customer.md) | :heavy_minus_sign: | N/A | | | `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `customer_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a customer. | | +| `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. | | | `force_update` | *Optional[bool]* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | | `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/sync-for-expenses/docs/models/operations/updatecustomerresponse.md b/sync-for-expenses/docs/models/operations/updatecustomerresponse.md index 0b8d4786e..90547c4f8 100755 --- a/sync-for-expenses/docs/models/operations/updatecustomerresponse.md +++ b/sync-for-expenses/docs/models/operations/updatecustomerresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *Optional[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 | -| `update_customer_response` | [Optional[shared.UpdateCustomerResponse]](undefined/models/shared/updatecustomerresponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `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: | 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 | +| `update_customer_response` | [Optional[shared.UpdateCustomerResponse]](../../models/shared/updatecustomerresponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/updateexpensetransactionrequest.md b/sync-for-expenses/docs/models/operations/updateexpensetransactionrequest.md index b746b82b6..44a52487c 100755 --- a/sync-for-expenses/docs/models/operations/updateexpensetransactionrequest.md +++ b/sync-for-expenses/docs/models/operations/updateexpensetransactionrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `update_expense_request` | [Optional[shared.UpdateExpenseRequest]](undefined/models/shared/updateexpenserequest.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `transaction_id` | *Optional[str]* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `update_expense_request` | [Optional[shared.UpdateExpenseRequest]](../../models/shared/updateexpenserequest.md) | :heavy_minus_sign: | N/A | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `transaction_id` | *str* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/updateexpensetransactionresponse.md b/sync-for-expenses/docs/models/operations/updateexpensetransactionresponse.md index e76518ba5..f84937fc8 100755 --- a/sync-for-expenses/docs/models/operations/updateexpensetransactionresponse.md +++ b/sync-for-expenses/docs/models/operations/updateexpensetransactionresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *Optional[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 | -| `update_expense_response` | [Optional[shared.UpdateExpenseResponse]](undefined/models/shared/updateexpenseresponse.md) | :heavy_minus_sign: | Accepted | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `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: | 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 | +| `update_expense_response` | [Optional[shared.UpdateExpenseResponse]](../../models/shared/updateexpenseresponse.md) | :heavy_minus_sign: | Accepted | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/updatesupplierrequest.md b/sync-for-expenses/docs/models/operations/updatesupplierrequest.md index a70139857..5e94a53f2 100755 --- a/sync-for-expenses/docs/models/operations/updatesupplierrequest.md +++ b/sync-for-expenses/docs/models/operations/updatesupplierrequest.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `supplier` | [Optional[shared.Supplier]](undefined/models/shared/supplier.md) | :heavy_minus_sign: | N/A | | +| `supplier` | [Optional[shared.Supplier]](../../models/shared/supplier.md) | :heavy_minus_sign: | N/A | | | `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a connection. | 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 | | `force_update` | *Optional[bool]* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | -| `supplier_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a supplier. | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `supplier_id` | *str* | :heavy_check_mark: | Unique identifier for a supplier. | 13d946f0-c5d5-42bc-b092-97ece17923ab | | `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/sync-for-expenses/docs/models/operations/updatesupplierresponse.md b/sync-for-expenses/docs/models/operations/updatesupplierresponse.md index 1c9d1ae66..d52d8fea0 100755 --- a/sync-for-expenses/docs/models/operations/updatesupplierresponse.md +++ b/sync-for-expenses/docs/models/operations/updatesupplierresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *Optional[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 | -| `update_supplier_response` | [Optional[shared.UpdateSupplierResponse]](undefined/models/shared/updatesupplierresponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `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: | 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 | +| `update_supplier_response` | [Optional[shared.UpdateSupplierResponse]](../../models/shared/updatesupplierresponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/uploadexpenseattachmentrequest.md b/sync-for-expenses/docs/models/operations/uploadexpenseattachmentrequest.md index f8d267d7c..dc1a49039 100755 --- a/sync-for-expenses/docs/models/operations/uploadexpenseattachmentrequest.md +++ b/sync-for-expenses/docs/models/operations/uploadexpenseattachmentrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `request_body` | [Optional[operations.UploadExpenseAttachmentRequestBody]](undefined/models/operations/uploadexpenseattachmentrequestbody.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `sync_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a sync. | 6fb40d5e-b13e-11ed-afa1-0242ac120002 | -| `transaction_id` | *Optional[str]* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[UploadExpenseAttachmentRequestBody]](../../models/operations/uploadexpenseattachmentrequestbody.md) | :heavy_minus_sign: | N/A | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `sync_id` | *str* | :heavy_check_mark: | Unique identifier for a sync. | 6fb40d5e-b13e-11ed-afa1-0242ac120002 | +| `transaction_id` | *str* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/uploadexpenseattachmentrequestbody.md b/sync-for-expenses/docs/models/operations/uploadexpenseattachmentrequestbody.md index 7dc041756..5c372515c 100755 --- a/sync-for-expenses/docs/models/operations/uploadexpenseattachmentrequestbody.md +++ b/sync-for-expenses/docs/models/operations/uploadexpenseattachmentrequestbody.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `content` | *Optional[bytes]* | :heavy_check_mark: | N/A | -| `request_body` | *Optional[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *bytes* | :heavy_check_mark: | N/A | +| `request_body` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/uploadexpenseattachmentresponse.md b/sync-for-expenses/docs/models/operations/uploadexpenseattachmentresponse.md index a655b2aa3..43befdf6a 100755 --- a/sync-for-expenses/docs/models/operations/uploadexpenseattachmentresponse.md +++ b/sync-for-expenses/docs/models/operations/uploadexpenseattachmentresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `attachment` | [Optional[shared.Attachment]](undefined/models/shared/attachment.md) | :heavy_minus_sign: | OK | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | [Optional[shared.ErrorMessage]](undefined/models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `attachment` | [Optional[shared.Attachment]](../../models/shared/attachment.md) | :heavy_minus_sign: | OK | +| `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: | 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/sync-for-expenses/docs/models/shared/account.md b/sync-for-expenses/docs/models/shared/account.md index 6a5ee1115..1cfb72f5d 100755 --- a/sync-for-expenses/docs/models/shared/account.md +++ b/sync-for-expenses/docs/models/shared/account.md @@ -41,11 +41,12 @@ To determine the list of allowed categories for a specific integration, you can: | `fully_qualified_name` | *Optional[str]* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | Cash On Hand | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the account, unique for the company. | 1b6266d1-1e44-46c5-8eb5-a8f98e03124e | | `is_bank_account` | *Optional[bool]* | :heavy_minus_sign: | Confirms whether the account is a bank account or not. | | -| `metadata` | [Optional[shared.AccountMetadata]](undefined/models/shared/accountmetadata.md) | :heavy_minus_sign: | N/A | | +| `metadata` | [Optional[AccountMetadata]](../../models/shared/accountmetadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `name` | *Optional[str]* | :heavy_minus_sign: | Name of the account. | Accounts Receivable | | `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[shared.AccountStatus]](undefined/models/shared/accountstatus.md) | :heavy_minus_sign: | Status of the account | Active | -| `type` | [Optional[shared.AccountType]](undefined/models/shared/accounttype.md) | :heavy_minus_sign: | Type of account | Asset | -| `valid_datatype_links` | list[[shared.AccountValidDataTypeLinks](undefined/models/shared/accountvaliddatatypelinks.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](/sync-for-expenses-api#/schemas/ValidDataTypeLinks). | | \ No newline at end of file +| `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[[AccountValidDataTypeLinks](../../models/shared/accountvaliddatatypelinks.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](/sync-for-expenses-api#/schemas/ValidDataTypeLinks). | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/accountmappinginfo.md b/sync-for-expenses/docs/models/shared/accountmappinginfo.md index c7b1488f3..0c8ff041b 100755 --- a/sync-for-expenses/docs/models/shared/accountmappinginfo.md +++ b/sync-for-expenses/docs/models/shared/accountmappinginfo.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `account_type` | [Optional[shared.AccountMappingInfoAccountType]](undefined/models/shared/accountmappinginfoaccounttype.md) | :heavy_minus_sign: | Type of the account. | Expense | -| `currency` | *Optional[str]* | :heavy_minus_sign: | Currency of the account. | GBP | -| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of account. | 6 | -| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the account as it appears in the companies accounting software. | Purchases | -| `valid_transaction_types` | list[[shared.AccountMappingInfoValidTransactionTypes](undefined/models/shared/accountmappinginfovalidtransactiontypes.md)] | :heavy_minus_sign: | Supported transaction types for the account. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `account_type` | [Optional[AccountMappingInfoAccountType]](../../models/shared/accountmappinginfoaccounttype.md) | :heavy_minus_sign: | Type of the account. | Expense | +| `currency` | *Optional[str]* | :heavy_minus_sign: | Currency of the account. | GBP | +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of account. | 6 | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the account as it appears in the companies accounting software. | Purchases | +| `valid_transaction_types` | List[[AccountMappingInfoValidTransactionTypes](../../models/shared/accountmappinginfovalidtransactiontypes.md)] | :heavy_minus_sign: | Supported transaction types for the account. | Payment | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/accountvaliddatatypelinks.md b/sync-for-expenses/docs/models/shared/accountvaliddatatypelinks.md index 682687d7a..233f913e3 100755 --- a/sync-for-expenses/docs/models/shared/accountvaliddatatypelinks.md +++ b/sync-for-expenses/docs/models/shared/accountvaliddatatypelinks.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/sync-for-expenses/docs/models/shared/clientratelimitreachedwebhook.md b/sync-for-expenses/docs/models/shared/clientratelimitreachedwebhook.md index fdbab3b4d..3d7030310 100755 --- a/sync-for-expenses/docs/models/shared/clientratelimitreachedwebhook.md +++ b/sync-for-expenses/docs/models/shared/clientratelimitreachedwebhook.md @@ -5,12 +5,12 @@ Webhook request body for a client that has reached their rate limit. ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | -| `data` | [Optional[shared.ClientRateLimitReachedWebhookData]](undefined/models/shared/clientratelimitreachedwebhookdata.md) | :heavy_minus_sign: | N/A | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | -| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional[ClientRateLimitReachedWebhookData]](../../models/shared/clientratelimitreachedwebhookdata.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/clientratelimitresetwebhook.md b/sync-for-expenses/docs/models/shared/clientratelimitresetwebhook.md index e6adea800..7336566a4 100755 --- a/sync-for-expenses/docs/models/shared/clientratelimitresetwebhook.md +++ b/sync-for-expenses/docs/models/shared/clientratelimitresetwebhook.md @@ -5,12 +5,12 @@ Webhook request body for a client that has had their rate limit reset. ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | -| `data` | [Optional[shared.ClientRateLimitResetWebhookData]](undefined/models/shared/clientratelimitresetwebhookdata.md) | :heavy_minus_sign: | N/A | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | -| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional[ClientRateLimitResetWebhookData]](../../models/shared/clientratelimitresetwebhookdata.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/companies.md b/sync-for-expenses/docs/models/shared/companies.md index ff26523f4..eeaacf9de 100755 --- a/sync-for-expenses/docs/models/shared/companies.md +++ b/sync-for-expenses/docs/models/shared/companies.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `links` | [Optional[shared.Links]](undefined/models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *Optional[int]* | :heavy_check_mark: | Current page number. | -| `page_size` | *Optional[int]* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | list[[shared.Company](undefined/models/shared/company.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *Optional[int]* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | +| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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/sync-for-expenses/docs/models/shared/company.md b/sync-for-expenses/docs/models/shared/company.md index b397e3fac..9ce212b8f 100755 --- a/sync-for-expenses/docs/models/shared/company.md +++ b/sync-for-expenses/docs/models/shared/company.md @@ -13,10 +13,10 @@ When you create a company, you can specify a `name` and we will automatically ge | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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: | Name of user that created the company in Codat. | | -| `data_connections` | list[[shared.Connection](undefined/models/shared/connection.md)] | :heavy_minus_sign: | N/A | | +| `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` | *Optional[str]* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `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` | *Optional[str]* | :heavy_check_mark: | The name of the company | Codat Ltd. | +| `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.

`platformKeys` name used when creating the company. | Xero | -| `redirect` | *Optional[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 +| `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/sync-for-expenses/docs/models/shared/companyconfiguration.md b/sync-for-expenses/docs/models/shared/companyconfiguration.md index 70e45c81b..45d797e3a 100755 --- a/sync-for-expenses/docs/models/shared/companyconfiguration.md +++ b/sync-for-expenses/docs/models/shared/companyconfiguration.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `bank_account` | [Optional[shared.BankAccount]](undefined/models/shared/bankaccount.md) | :heavy_check_mark: | N/A | -| `customer` | [Optional[shared.CustomerDetails]](undefined/models/shared/customerdetails.md) | :heavy_check_mark: | N/A | -| `supplier` | [Optional[shared.SupplierDetails]](undefined/models/shared/supplierdetails.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| `bank_account` | [BankAccount](../../models/shared/bankaccount.md) | :heavy_check_mark: | N/A | +| `customer` | [CustomerDetails](../../models/shared/customerdetails.md) | :heavy_check_mark: | N/A | +| `supplier` | [SupplierDetails](../../models/shared/supplierdetails.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/companyrequestbody.md b/sync-for-expenses/docs/models/shared/companyrequestbody.md index 309725e0b..339e136ce 100755 --- a/sync-for-expenses/docs/models/shared/companyrequestbody.md +++ b/sync-for-expenses/docs/models/shared/companyrequestbody.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | `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. | -| `name` | *Optional[str]* | :heavy_check_mark: | Name of company being connected. | Bank of Dave | \ No newline at end of file +| `name` | *str* | :heavy_check_mark: | Name of company being connected. | Bank of Dave | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/connection.md b/sync-for-expenses/docs/models/shared/connection.md index 6fdd6cf75..b7c4beb6e 100755 --- a/sync-for-expenses/docs/models/shared/connection.md +++ b/sync-for-expenses/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 | | -| `created` | *Optional[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[[shared.DataConnectionError](undefined/models/shared/dataconnectionerror.md)] | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `integration_id` | *Optional[str]* | :heavy_check_mark: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | -| `integration_key` | *Optional[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. | | +| `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 | | +| `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` | *Optional[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` | *Optional[str]* | :heavy_check_mark: | Name of integration connected to company. | | -| `source_id` | *Optional[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` | [Optional[shared.ConnectionSourceType]](undefined/models/shared/connectionsourcetype.md) | :heavy_check_mark: | The type of platform of the connection. | Accounting | -| `status` | [Optional[shared.DataConnectionStatus]](undefined/models/shared/dataconnectionstatus.md) | :heavy_check_mark: | The current authorization status of the data connection. | | \ No newline at end of file +| `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/sync-for-expenses/docs/models/shared/connections.md b/sync-for-expenses/docs/models/shared/connections.md index 89f41d5b2..87ee809ab 100755 --- a/sync-for-expenses/docs/models/shared/connections.md +++ b/sync-for-expenses/docs/models/shared/connections.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `links` | [Optional[shared.Links]](undefined/models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *Optional[int]* | :heavy_check_mark: | Current page number. | -| `page_size` | *Optional[int]* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | list[[shared.Connection](undefined/models/shared/connection.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *Optional[int]* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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/sync-for-expenses/docs/models/shared/contact.md b/sync-for-expenses/docs/models/shared/contact.md index 0b012cffb..20c406468 100755 --- a/sync-for-expenses/docs/models/shared/contact.md +++ b/sync-for-expenses/docs/models/shared/contact.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `address` | [Optional[shared.Items]](undefined/models/shared/items.md) | :heavy_minus_sign: | N/A | | +| `address` | [Optional[Items]](../../models/shared/items.md) | :heavy_minus_sign: | N/A | | | `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[[shared.ContactPhone](undefined/models/shared/contactphone.md)] | :heavy_minus_sign: | An array of Phone numbers. | | -| `status` | [Optional[shared.CustomerStatus]](undefined/models/shared/customerstatus.md) | :heavy_check_mark: | Status of customer. | | \ No newline at end of file +| `phone` | List[[ContactPhone](../../models/shared/contactphone.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/sync-for-expenses/docs/models/shared/contactphone.md b/sync-for-expenses/docs/models/shared/contactphone.md index b3ab4da0b..c75207936 100755 --- a/sync-for-expenses/docs/models/shared/contactphone.md +++ b/sync-for-expenses/docs/models/shared/contactphone.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `number` | *Optional[str]* | :heavy_check_mark: | A phone number. | +44 25691 154789 | -| `type` | [Optional[shared.PhoneNumberType]](undefined/models/shared/phonenumbertype.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| `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/sync-for-expenses/docs/models/shared/contactref.md b/sync-for-expenses/docs/models/shared/contactref.md index 39f24319e..cd5da29ba 100755 --- a/sync-for-expenses/docs/models/shared/contactref.md +++ b/sync-for-expenses/docs/models/shared/contactref.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | Identifier of supplier or customer. | 40e3e57c-2322-4898-966c-ca41adfd23fd | -| `type` | [Optional[shared.ContactRefType]](undefined/models/shared/contactreftype.md) | :heavy_minus_sign: | The type of contact. | Supplier | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `id` | *Optional[str]* | :heavy_minus_sign: | Identifier of supplier or customer. | 40e3e57c-2322-4898-966c-ca41adfd23fd | +| `type` | [Optional[ContactRefType]](../../models/shared/contactreftype.md) | :heavy_minus_sign: | The type of contact. | Supplier | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/createaccountresponse.md b/sync-for-expenses/docs/models/shared/createaccountresponse.md index 0e47c2c48..ea709394b 100755 --- a/sync-for-expenses/docs/models/shared/createaccountresponse.md +++ b/sync-for-expenses/docs/models/shared/createaccountresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[shared.PushOperationChange](undefined/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` | *Optional[str]* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `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[shared.Account]](undefined/models/shared/account.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/sync-for-expenses-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` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `data_type` | [Optional[shared.DataType]](undefined/models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `data` | [Optional[Account]](../../models/shared/account.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/sync-for-expenses-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: | A message about the error. | | -| `push_operation_key` | *Optional[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` | *Optional[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` | [Optional[shared.PushOperationStatus]](undefined/models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *Optional[int]* | :heavy_check_mark: | Push status code. | | +| `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 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[shared.Validation]](undefined/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 +| `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/sync-for-expenses/docs/models/shared/createcustomerresponse.md b/sync-for-expenses/docs/models/shared/createcustomerresponse.md index a4433e685..09f6b8162 100755 --- a/sync-for-expenses/docs/models/shared/createcustomerresponse.md +++ b/sync-for-expenses/docs/models/shared/createcustomerresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[shared.PushOperationChange](undefined/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` | *Optional[str]* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `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[shared.Customer]](undefined/models/shared/customer.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/sync-for-expenses-api#/schemas/Invoice).
| | -| `data_connection_key` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `data_type` | [Optional[shared.DataType]](undefined/models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `data` | [Optional[Customer]](../../models/shared/customer.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/sync-for-expenses-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: | A message about the error. | | -| `push_operation_key` | *Optional[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` | *Optional[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` | [Optional[shared.PushOperationStatus]](undefined/models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *Optional[int]* | :heavy_check_mark: | Push status code. | | +| `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 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[shared.Validation]](undefined/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 +| `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/sync-for-expenses/docs/models/shared/createexpenserequest.md b/sync-for-expenses/docs/models/shared/createexpenserequest.md index 140c8f0c9..f65a78658 100755 --- a/sync-for-expenses/docs/models/shared/createexpenserequest.md +++ b/sync-for-expenses/docs/models/shared/createexpenserequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `items` | list[[shared.ExpenseTransaction](undefined/models/shared/expensetransaction.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `items` | List[[ExpenseTransaction](../../models/shared/expensetransaction.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/createsupplierresponse.md b/sync-for-expenses/docs/models/shared/createsupplierresponse.md index fcb5a621f..34eeef48f 100755 --- a/sync-for-expenses/docs/models/shared/createsupplierresponse.md +++ b/sync-for-expenses/docs/models/shared/createsupplierresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[shared.PushOperationChange](undefined/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` | *Optional[str]* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `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[shared.Supplier]](undefined/models/shared/supplier.md) | :heavy_minus_sign: | > View the coverage for suppliers in the Data coverage explorer.

## Overview

From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). | | -| `data_connection_key` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `data_type` | [Optional[shared.DataType]](undefined/models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `data` | [Optional[Supplier]](../../models/shared/supplier.md) | :heavy_minus_sign: | > View the coverage for suppliers in the Data coverage explorer.

## Overview

From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). | | +| `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: | A message about the error. | | -| `push_operation_key` | *Optional[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` | *Optional[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` | [Optional[shared.PushOperationStatus]](undefined/models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *Optional[int]* | :heavy_check_mark: | Push status code. | | +| `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 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[shared.Validation]](undefined/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 +| `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/sync-for-expenses/docs/models/shared/customer.md b/sync-for-expenses/docs/models/shared/customer.md index ac2034c6b..bb6ed2dc1 100755 --- a/sync-for-expenses/docs/models/shared/customer.md +++ b/sync-for-expenses/docs/models/shared/customer.md @@ -14,18 +14,18 @@ Customers' data links to accounts receivable [invoices](https://docs.codat.io/sy | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | list[[shared.Items](undefined/models/shared/items.md)] | :heavy_minus_sign: | An array of Addresses. | | +| `addresses` | List[[Items](../../models/shared/items.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[[shared.Contact](undefined/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. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the customer, unique to the company in the accounting platform. | | -| `metadata` | [Optional[shared.Metadata]](undefined/models/shared/metadata.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 | | `phone` | *Optional[str]* | :heavy_minus_sign: | Phone number the customer can be contacted by. | | | `registration_number` | *Optional[str]* | :heavy_minus_sign: | Company number. In the UK, this is typically the Companies House company registration number. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[shared.CustomerStatus]](undefined/models/shared/customerstatus.md) | :heavy_check_mark: | Status of customer. | | -| `supplemental_data` | [Optional[shared.SupplementalData]](undefined/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. | | +| `status` | [CustomerStatus](../../models/shared/customerstatus.md) | :heavy_check_mark: | Status of customer. | | +| `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. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/customers.md b/sync-for-expenses/docs/models/shared/customers.md index 2b5e72b41..0ef44bd32 100755 --- a/sync-for-expenses/docs/models/shared/customers.md +++ b/sync-for-expenses/docs/models/shared/customers.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `links` | [Optional[shared.Links]](undefined/models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *Optional[int]* | :heavy_check_mark: | Current page number. | -| `page_size` | *Optional[int]* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | list[[shared.Customer](undefined/models/shared/customer.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *Optional[int]* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | +| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[Customer](../../models/shared/customer.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/sync-for-expenses/docs/models/shared/datastatus.md b/sync-for-expenses/docs/models/shared/datastatus.md index f1bac1f63..e835378ab 100755 --- a/sync-for-expenses/docs/models/shared/datastatus.md +++ b/sync-for-expenses/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` | *Optional[str]* | :heavy_check_mark: | The current status of the dataset in Codat's cache. | | -| `data_type` | [Optional[shared.DataStatusDataTypes]](undefined/models/shared/datastatusdatatypes.md) | :heavy_check_mark: | Available Data types | invoices | -| `last_successful_sync` | *Optional[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 | +| `current_status` | *str* | :heavy_check_mark: | The current status of the dataset in Codat's cache. | | +| `data_type` | [DataStatusDataTypes](../../models/shared/datastatusdatatypes.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: | 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/sync-for-expenses/docs/models/shared/expensetransaction.md b/sync-for-expenses/docs/models/shared/expensetransaction.md index 4d252eea4..35b6b6935 100755 --- a/sync-for-expenses/docs/models/shared/expensetransaction.md +++ b/sync-for-expenses/docs/models/shared/expensetransaction.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `bank_account_ref` | [Optional[shared.ExpenseTransactionBankAccountReference]](undefined/models/shared/expensetransactionbankaccountreference.md) | :heavy_minus_sign: | N/A | | -| `contact_ref` | [Optional[shared.ContactRef]](undefined/models/shared/contactref.md) | :heavy_minus_sign: | N/A | | -| `currency` | *Optional[str]* | :heavy_check_mark: | Currency the transaction was recorded in. | GBP | +| `bank_account_ref` | [Optional[ExpenseTransactionBankAccountReference]](../../models/shared/expensetransactionbankaccountreference.md) | :heavy_minus_sign: | N/A | | +| `contact_ref` | [Optional[ContactRef]](../../models/shared/contactref.md) | :heavy_minus_sign: | N/A | | +| `currency` | *str* | :heavy_check_mark: | Currency the transaction was recorded in. | 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 \| | | -| `id` | *Optional[str]* | :heavy_check_mark: | Your unique identifier for the transaction. | 4d7c6929-7770-412b-91bb-44d3bc71d111 | -| `issue_date` | *Optional[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 | -| `lines` | list[[shared.ExpenseTransactionLine](undefined/models/shared/expensetransactionline.md)] | :heavy_minus_sign: | Array of transaction lines. | | +| `id` | *str* | :heavy_check_mark: | Your unique identifier for the transaction. | 4d7c6929-7770-412b-91bb-44d3bc71d111 | +| `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 | +| `lines` | List[[ExpenseTransactionLine](../../models/shared/expensetransactionline.md)] | :heavy_minus_sign: | Array of transaction lines. | | | `merchant_name` | *Optional[str]* | :heavy_minus_sign: | Name of the merchant where the purchase took place | Amazon UK | | `notes` | *Optional[str]* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | -| `type` | [Optional[shared.ExpenseTransactionType]](undefined/models/shared/expensetransactiontype.md) | :heavy_check_mark: | The type of transaction. | Payment | \ No newline at end of file +| `type` | [ExpenseTransactionType](../../models/shared/expensetransactiontype.md) | :heavy_check_mark: | The type of transaction. | Payment | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/expensetransactionline.md b/sync-for-expenses/docs/models/shared/expensetransactionline.md index f72fda0fd..8f63e4aa4 100755 --- a/sync-for-expenses/docs/models/shared/expensetransactionline.md +++ b/sync-for-expenses/docs/models/shared/expensetransactionline.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `account_ref` | [Optional[shared.RecordRef]](undefined/models/shared/recordref.md) | :heavy_check_mark: | N/A | | -| `net_amount` | *Optional[Decimal]* | :heavy_check_mark: | Amount of the line, exclusive of tax. | 110.42 | -| `tax_amount` | *Optional[Decimal]* | :heavy_check_mark: | Amount of tax for the line. | 14.43 | -| `tax_rate_ref` | [Optional[shared.RecordRef]](undefined/models/shared/recordref.md) | :heavy_minus_sign: | N/A | | -| `tracking_refs` | list[[shared.RecordRef](undefined/models/shared/recordref.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `account_ref` | [RecordRef](../../models/shared/recordref.md) | :heavy_check_mark: | N/A | | +| `net_amount` | *Decimal* | :heavy_check_mark: | Amount of the line, exclusive of tax. | 110.42 | +| `tax_amount` | *Decimal* | :heavy_check_mark: | Amount of tax for the line. | 14.43 | +| `tax_rate_ref` | [Optional[RecordRef]](../../models/shared/recordref.md) | :heavy_minus_sign: | N/A | | +| `tracking_refs` | List[[RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/initiatesync.md b/sync-for-expenses/docs/models/shared/initiatesync.md index 53d4ad7df..5ca2e6879 100755 --- a/sync-for-expenses/docs/models/shared/initiatesync.md +++ b/sync-for-expenses/docs/models/shared/initiatesync.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `dataset_ids` | list[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `dataset_ids` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/items.md b/sync-for-expenses/docs/models/shared/items.md index 96fdcf925..c0adcf092 100755 --- a/sync-for-expenses/docs/models/shared/items.md +++ b/sync-for-expenses/docs/models/shared/items.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `city` | *Optional[str]* | :heavy_minus_sign: | City of the customer address. | -| `country` | *Optional[str]* | :heavy_minus_sign: | Country of the customer address. | -| `line1` | *Optional[str]* | :heavy_minus_sign: | Line 1 of the customer address. | -| `line2` | *Optional[str]* | :heavy_minus_sign: | Line 2 of the customer address. | -| `postal_code` | *Optional[str]* | :heavy_minus_sign: | Postal code or zip code. | -| `region` | *Optional[str]* | :heavy_minus_sign: | Region of the customer address. | -| `type` | [Optional[shared.AccountingAddressType]](undefined/models/shared/accountingaddresstype.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `city` | *Optional[str]* | :heavy_minus_sign: | City of the customer address. | +| `country` | *Optional[str]* | :heavy_minus_sign: | Country of the customer address. | +| `line1` | *Optional[str]* | :heavy_minus_sign: | Line 1 of the customer address. | +| `line2` | *Optional[str]* | :heavy_minus_sign: | Line 2 of the customer address. | +| `postal_code` | *Optional[str]* | :heavy_minus_sign: | Postal code or zip code. | +| `region` | *Optional[str]* | :heavy_minus_sign: | Region of the customer address. | +| `type` | [AccountingAddressType](../../models/shared/accountingaddresstype.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/links.md b/sync-for-expenses/docs/models/shared/links.md index c2f1db11e..7aad1ea5d 100755 --- a/sync-for-expenses/docs/models/shared/links.md +++ b/sync-for-expenses/docs/models/shared/links.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `current` | [Optional[shared.HalRef]](undefined/models/shared/halref.md) | :heavy_check_mark: | N/A | -| `next` | [Optional[shared.HalRef]](undefined/models/shared/halref.md) | :heavy_minus_sign: | N/A | -| `previous` | [Optional[shared.HalRef]](undefined/models/shared/halref.md) | :heavy_minus_sign: | N/A | -| `self_` | [Optional[shared.HalRef]](undefined/models/shared/halref.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | +| `current` | [HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | +| `next` | [Optional[HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | +| `previous` | [Optional[HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | +| `self_` | [HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/mappingoptions.md b/sync-for-expenses/docs/models/shared/mappingoptions.md index 1540bbe37..794a5ff03 100755 --- a/sync-for-expenses/docs/models/shared/mappingoptions.md +++ b/sync-for-expenses/docs/models/shared/mappingoptions.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `accounts` | list[[shared.AccountMappingInfo](undefined/models/shared/accountmappinginfo.md)] | :heavy_minus_sign: | Array of available accounts for mapping. | | -| `expense_provider` | *Optional[str]* | :heavy_minus_sign: | Name of the expense integration. | Partner Expense | -| `tax_rates` | list[[shared.TaxRateMappingInfo](undefined/models/shared/taxratemappinginfo.md)] | :heavy_minus_sign: | Array of available tax rates for mapping. | | -| `tracking_categories` | list[[shared.TrackingCategoryMappingInfo](undefined/models/shared/trackingcategorymappinginfo.md)] | :heavy_minus_sign: | Array of available tracking categories for mapping. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `accounts` | List[[AccountMappingInfo](../../models/shared/accountmappinginfo.md)] | :heavy_minus_sign: | Array of available accounts for mapping. | | +| `expense_provider` | *Optional[str]* | :heavy_minus_sign: | Name of the expense integration. | Partner Expense | +| `tax_rates` | List[[TaxRateMappingInfo](../../models/shared/taxratemappinginfo.md)] | :heavy_minus_sign: | Array of available tax rates for mapping. | | +| `tracking_categories` | List[[TrackingCategoryMappingInfo](../../models/shared/trackingcategorymappinginfo.md)] | :heavy_minus_sign: | Array of available tracking categories for mapping. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/pulloperation.md b/sync-for-expenses/docs/models/shared/pulloperation.md index 77aa7916d..07104cbd5 100755 --- a/sync-for-expenses/docs/models/shared/pulloperation.md +++ b/sync-for-expenses/docs/models/shared/pulloperation.md @@ -8,14 +8,14 @@ Information about a queued, in progress or completed pull operation. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *Optional[str]* | :heavy_check_mark: | Unique identifier of the company associated to this pull operation. | 22ece347-e5f6-4896-95e0-35a4c7f17023 | +| `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` | *Optional[str]* | :heavy_check_mark: | Unique identifier of the connection associated to this pull operation. | 50830828-7d39-4367-b0eb-5ddb2de5faa5 | -| `data_type` | [Optional[shared.DataType]](undefined/models/shared/datatype.md) | :heavy_check_mark: | Available Data types | invoices | +| `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` | *Optional[str]* | :heavy_check_mark: | Unique identifier of the pull operation. | 943accd0-4247-42d8-865b-363c8629e1da | -| `is_completed` | *Optional[bool]* | :heavy_check_mark: | `True` if the pull operation completed successfully. | | -| `is_errored` | *Optional[bool]* | :heavy_check_mark: | `True` if the pull operation entered an error state. | | -| `progress` | *Optional[int]* | :heavy_check_mark: | An integer signifying the progress of the pull operation. | | -| `requested` | *Optional[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` | [Optional[shared.PullOperationStatus]](undefined/models/shared/pulloperationstatus.md) | :heavy_check_mark: | The current status of the pull operation. | Complete | \ No newline at end of file +| `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: | The current status of the pull operation. | Complete | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/pulloperations.md b/sync-for-expenses/docs/models/shared/pulloperations.md index bff58cd61..e15916751 100755 --- a/sync-for-expenses/docs/models/shared/pulloperations.md +++ b/sync-for-expenses/docs/models/shared/pulloperations.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `links` | [Optional[shared.Links]](undefined/models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *Optional[int]* | :heavy_check_mark: | Current page number. | -| `page_size` | *Optional[int]* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | list[[shared.PullOperation](undefined/models/shared/pulloperation.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *Optional[int]* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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/sync-for-expenses/docs/models/shared/pushfieldvalidation.md b/sync-for-expenses/docs/models/shared/pushfieldvalidation.md index 9a5d4b2af..60ce548f0 100755 --- a/sync-for-expenses/docs/models/shared/pushfieldvalidation.md +++ b/sync-for-expenses/docs/models/shared/pushfieldvalidation.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `details` | *Optional[str]* | :heavy_check_mark: | Details on the validation issue. | +| `details` | *str* | :heavy_check_mark: | Details on the validation issue. | | `field` | *Optional[str]* | :heavy_minus_sign: | Field name that resulted in the validation issue. | | `ref` | *Optional[str]* | :heavy_minus_sign: | Unique reference identifier for the validation issue. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/pushoperation.md b/sync-for-expenses/docs/models/shared/pushoperation.md index 923c139de..4e0594ecc 100755 --- a/sync-for-expenses/docs/models/shared/pushoperation.md +++ b/sync-for-expenses/docs/models/shared/pushoperation.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[shared.PushOperationChange](undefined/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` | *Optional[str]* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `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` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `data_type` | [Optional[shared.DataType]](undefined/models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `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: | A message about the error. | | -| `push_operation_key` | *Optional[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` | *Optional[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` | [Optional[shared.PushOperationStatus]](undefined/models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *Optional[int]* | :heavy_check_mark: | Push status code. | | +| `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 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[shared.Validation]](undefined/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 +| `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/sync-for-expenses/docs/models/shared/pushoperationchange.md b/sync-for-expenses/docs/models/shared/pushoperationchange.md index 42dc9b4f5..cf6e86896 100755 --- a/sync-for-expenses/docs/models/shared/pushoperationchange.md +++ b/sync-for-expenses/docs/models/shared/pushoperationchange.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `attachment_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the attachment created otherwise null. | -| `record_ref` | [Optional[shared.PushOperationRef]](undefined/models/shared/pushoperationref.md) | :heavy_minus_sign: | N/A | -| `type` | [Optional[shared.PushChangeType]](undefined/models/shared/pushchangetype.md) | :heavy_minus_sign: | Type of change being applied to record in third party platform. | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `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: | Type of change being applied to record in third party platform. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/pushoperationref.md b/sync-for-expenses/docs/models/shared/pushoperationref.md index 279637024..df895faa0 100755 --- a/sync-for-expenses/docs/models/shared/pushoperationref.md +++ b/sync-for-expenses/docs/models/shared/pushoperationref.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `data_type` | [Optional[shared.DataType]](undefined/models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a push operation. | | \ 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 for a push operation. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/pushoperations.md b/sync-for-expenses/docs/models/shared/pushoperations.md index c1d3c959c..1f224ca9b 100755 --- a/sync-for-expenses/docs/models/shared/pushoperations.md +++ b/sync-for-expenses/docs/models/shared/pushoperations.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `links` | [Optional[shared.Links]](undefined/models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *Optional[int]* | :heavy_check_mark: | Current page number. | -| `page_size` | *Optional[int]* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | list[[shared.PushOperation](undefined/models/shared/pushoperation.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *Optional[int]* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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/sync-for-expenses/docs/models/shared/pushoption.md b/sync-for-expenses/docs/models/shared/pushoption.md index ba2384730..72e02d203 100755 --- a/sync-for-expenses/docs/models/shared/pushoption.md +++ b/sync-for-expenses/docs/models/shared/pushoption.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `description` | *Optional[str]* | :heavy_minus_sign: | A description of the property. | -| `display_name` | *Optional[str]* | :heavy_check_mark: | The property's display name. | -| `options` | list[[shared.PushOptionChoice](undefined/models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | -| `properties` | dict[str, [shared.PushOptionProperty](undefined/models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_check_mark: | The property is required if `True`. | -| `type` | [Optional[shared.PushOptionType]](undefined/models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. | -| `validation` | [Optional[shared.PushValidationInfo]](undefined/models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `description` | *Optional[str]* | :heavy_minus_sign: | A description of the property. | +| `display_name` | *str* | :heavy_check_mark: | The property's display name. | +| `options` | List[[PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | +| `properties` | Dict[str, [PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | +| `required` | *bool* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. | +| `validation` | [Optional[PushValidationInfo]](../../models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/pushoptionchoice.md b/sync-for-expenses/docs/models/shared/pushoptionchoice.md index be1e68c07..0b1c9b987 100755 --- a/sync-for-expenses/docs/models/shared/pushoptionchoice.md +++ b/sync-for-expenses/docs/models/shared/pushoptionchoice.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `description` | *Optional[str]* | :heavy_minus_sign: | A description of the property. | -| `display_name` | *Optional[str]* | :heavy_minus_sign: | The property's display name. | -| `required` | *Optional[bool]* | :heavy_minus_sign: | The property is required if `True`. | -| `type` | [Optional[shared.PushOptionType]](undefined/models/shared/pushoptiontype.md) | :heavy_minus_sign: | The option type. | -| `value` | *Optional[str]* | :heavy_minus_sign: | Allowed value for field. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `description` | *Optional[str]* | :heavy_minus_sign: | A description of the property. | +| `display_name` | *Optional[str]* | :heavy_minus_sign: | The property's display name. | +| `required` | *Optional[bool]* | :heavy_minus_sign: | The property is required if `True`. | +| `type` | [Optional[PushOptionType]](../../models/shared/pushoptiontype.md) | :heavy_minus_sign: | The option type. | +| `value` | *Optional[str]* | :heavy_minus_sign: | Allowed value for field. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/pushoptionproperty.md b/sync-for-expenses/docs/models/shared/pushoptionproperty.md index 1c4788a6c..c53a8177f 100755 --- a/sync-for-expenses/docs/models/shared/pushoptionproperty.md +++ b/sync-for-expenses/docs/models/shared/pushoptionproperty.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `description` | *Optional[str]* | :heavy_check_mark: | A description of the property. | -| `display_name` | *Optional[str]* | :heavy_check_mark: | The property's display name. | -| `options` | list[[shared.PushOptionChoice](undefined/models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | -| `properties` | dict[str, [shared.PushOptionProperty](undefined/models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_check_mark: | The property is required if `True`. | -| `type` | [Optional[shared.PushOptionType]](undefined/models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. | -| `validation` | [Optional[shared.PushValidationInfo]](undefined/models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `description` | *str* | :heavy_check_mark: | A description of the property. | +| `display_name` | *str* | :heavy_check_mark: | The property's display name. | +| `options` | List[[PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | +| `properties` | Dict[str, [PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | +| `required` | *bool* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. | +| `validation` | [Optional[PushValidationInfo]](../../models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/pushvalidationinfo.md b/sync-for-expenses/docs/models/shared/pushvalidationinfo.md index 3b2838ea5..bf2fdc062 100755 --- a/sync-for-expenses/docs/models/shared/pushvalidationinfo.md +++ b/sync-for-expenses/docs/models/shared/pushvalidationinfo.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `information` | list[[shared.PushFieldValidation](undefined/models/shared/pushfieldvalidation.md)] | :heavy_minus_sign: | N/A | -| `warnings` | list[[shared.PushFieldValidation](undefined/models/shared/pushfieldvalidation.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| `information` | List[[PushFieldValidation](../../models/shared/pushfieldvalidation.md)] | :heavy_minus_sign: | N/A | +| `warnings` | List[[PushFieldValidation](../../models/shared/pushfieldvalidation.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/security.md b/sync-for-expenses/docs/models/shared/security.md index e41a7e062..2b68bd0e7 100755 --- a/sync-for-expenses/docs/models/shared/security.md +++ b/sync-for-expenses/docs/models/shared/security.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `auth_header` | *Optional[str]* | :heavy_check_mark: | N/A | Basic BASE_64_ENCODED(API_KEY) | \ No newline at end of file +| `auth_header` | *str* | :heavy_check_mark: | N/A | Basic BASE_64_ENCODED(API_KEY) | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/supplementaldata.md b/sync-for-expenses/docs/models/shared/supplementaldata.md index f18fbb90d..f9d04fc2b 100755 --- a/sync-for-expenses/docs/models/shared/supplementaldata.md +++ b/sync-for-expenses/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/sync-for-expenses/docs/models/shared/supplier.md b/sync-for-expenses/docs/models/shared/supplier.md index a3847e966..29804fee0 100755 --- a/sync-for-expenses/docs/models/shared/supplier.md +++ b/sync-for-expenses/docs/models/shared/supplier.md @@ -11,17 +11,17 @@ From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | list[[shared.SupplierAccountingAddress](undefined/models/shared/supplieraccountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | +| `addresses` | List[[SupplierAccountingAddress](../../models/shared/supplieraccountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | | `contact_name` | *Optional[str]* | :heavy_minus_sign: | Name of the main contact for the supplier. | | | `default_currency` | *Optional[str]* | :heavy_minus_sign: | Default currency the supplier's transactional data is recorded in. | | | `email_address` | *Optional[str]* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting platform. | | -| `metadata` | [Optional[shared.Metadata]](undefined/models/shared/metadata.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 | | `phone` | *Optional[str]* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | +44 25691 154789 | | `registration_number` | *Optional[str]* | :heavy_minus_sign: | Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[shared.SupplierStatus]](undefined/models/shared/supplierstatus.md) | :heavy_check_mark: | Status of the supplier. | | -| `supplemental_data` | [Optional[shared.SupplierSupplementalData]](undefined/models/shared/suppliersupplementaldata.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. | | +| `status` | [SupplierStatus](../../models/shared/supplierstatus.md) | :heavy_check_mark: | Status of the supplier. | | +| `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. | | | `supplier_name` | *Optional[str]* | :heavy_minus_sign: | Name of the supplier as recorded in the accounting system, typically the company name. | | | `tax_number` | *Optional[str]* | :heavy_minus_sign: | Supplier's company tax number. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/supplieraccountingaddress.md b/sync-for-expenses/docs/models/shared/supplieraccountingaddress.md index 91404562d..7d316b0ae 100755 --- a/sync-for-expenses/docs/models/shared/supplieraccountingaddress.md +++ b/sync-for-expenses/docs/models/shared/supplieraccountingaddress.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `city` | *Optional[str]* | :heavy_minus_sign: | City of the customer address. | -| `country` | *Optional[str]* | :heavy_minus_sign: | Country of the customer address. | -| `line1` | *Optional[str]* | :heavy_minus_sign: | Line 1 of the customer address. | -| `line2` | *Optional[str]* | :heavy_minus_sign: | Line 2 of the customer address. | -| `postal_code` | *Optional[str]* | :heavy_minus_sign: | Postal code or zip code. | -| `region` | *Optional[str]* | :heavy_minus_sign: | Region of the customer address. | -| `type` | [Optional[shared.AccountingAddressType]](undefined/models/shared/accountingaddresstype.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `city` | *Optional[str]* | :heavy_minus_sign: | City of the customer address. | +| `country` | *Optional[str]* | :heavy_minus_sign: | Country of the customer address. | +| `line1` | *Optional[str]* | :heavy_minus_sign: | Line 1 of the customer address. | +| `line2` | *Optional[str]* | :heavy_minus_sign: | Line 2 of the customer address. | +| `postal_code` | *Optional[str]* | :heavy_minus_sign: | Postal code or zip code. | +| `region` | *Optional[str]* | :heavy_minus_sign: | Region of the customer address. | +| `type` | [AccountingAddressType](../../models/shared/accountingaddresstype.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/suppliers.md b/sync-for-expenses/docs/models/shared/suppliers.md index d4f661545..c027182e6 100755 --- a/sync-for-expenses/docs/models/shared/suppliers.md +++ b/sync-for-expenses/docs/models/shared/suppliers.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `links` | [Optional[shared.Links]](undefined/models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *Optional[int]* | :heavy_check_mark: | Current page number. | -| `page_size` | *Optional[int]* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | list[[shared.Supplier](undefined/models/shared/supplier.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *Optional[int]* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | +| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[Supplier](../../models/shared/supplier.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/sync-for-expenses/docs/models/shared/suppliersupplementaldata.md b/sync-for-expenses/docs/models/shared/suppliersupplementaldata.md deleted file mode 100755 index ec734ed34..000000000 --- a/sync-for-expenses/docs/models/shared/suppliersupplementaldata.md +++ /dev/null @@ -1,12 +0,0 @@ -# SupplierSupplementalData - -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/sync-for-expenses/docs/models/shared/synccompletewebhook.md b/sync-for-expenses/docs/models/shared/synccompletewebhook.md index 6c9eb17e7..002c3ed9e 100755 --- a/sync-for-expenses/docs/models/shared/synccompletewebhook.md +++ b/sync-for-expenses/docs/models/shared/synccompletewebhook.md @@ -5,13 +5,13 @@ Webhook request body used to notify that a sync has completed. ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | -| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `data` | [Optional[shared.SyncCompleteWebhookData]](undefined/models/shared/synccompletewebhookdata.md) | :heavy_minus_sign: | N/A | | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | +| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [Optional[SyncCompleteWebhookData]](../../models/shared/synccompletewebhookdata.md) | :heavy_minus_sign: | N/A | | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/syncfailedwebhook.md b/sync-for-expenses/docs/models/shared/syncfailedwebhook.md index d92bc7b61..4054cefff 100755 --- a/sync-for-expenses/docs/models/shared/syncfailedwebhook.md +++ b/sync-for-expenses/docs/models/shared/syncfailedwebhook.md @@ -5,13 +5,13 @@ Webhook request body used to notify that a sync has failed. ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | -| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `data` | [Optional[shared.SyncFailedWebhookData]](undefined/models/shared/syncfailedwebhookdata.md) | :heavy_minus_sign: | N/A | | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | +| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [Optional[SyncFailedWebhookData]](../../models/shared/syncfailedwebhookdata.md) | :heavy_minus_sign: | N/A | | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/syncstartedwebhook.md b/sync-for-expenses/docs/models/shared/syncstartedwebhook.md index 30e052dfe..15f31c0c6 100755 --- a/sync-for-expenses/docs/models/shared/syncstartedwebhook.md +++ b/sync-for-expenses/docs/models/shared/syncstartedwebhook.md @@ -5,13 +5,13 @@ Webhook request body used to notify that a sync has started. ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | -| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `data` | [Optional[shared.SyncStartedWebhookData]](undefined/models/shared/syncstartedwebhookdata.md) | :heavy_minus_sign: | N/A | | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | +| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [Optional[SyncStartedWebhookData]](../../models/shared/syncstartedwebhookdata.md) | :heavy_minus_sign: | N/A | | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/taxratemappinginfo.md b/sync-for-expenses/docs/models/shared/taxratemappinginfo.md index 571d7bf2c..32486fbc9 100755 --- a/sync-for-expenses/docs/models/shared/taxratemappinginfo.md +++ b/sync-for-expenses/docs/models/shared/taxratemappinginfo.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `code` | *Optional[str]* | :heavy_minus_sign: | Code for the tax rate from the accounting platform. | UK Standard Rate (Bills) | -| `effective_tax_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Effective tax rate. | 20 | -| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of tax rate. | 59_Bills | -| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the tax rate in the accounting platform. | UK Standard Rate (Bills) Bills | -| `total_tax_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Total (not compounded) sum of the components of a tax rate. | 20 | -| `valid_transaction_types` | list[[shared.TaxRateMappingInfoValidTransactionTypes](undefined/models/shared/taxratemappinginfovalidtransactiontypes.md)] | :heavy_minus_sign: | Supported transaction types for the account. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `code` | *Optional[str]* | :heavy_minus_sign: | Code for the tax rate from the accounting platform. | UK Standard Rate (Bills) | +| `effective_tax_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Effective tax rate. | 20 | +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of tax rate. | 59_Bills | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the tax rate in the accounting platform. | UK Standard Rate (Bills) Bills | +| `total_tax_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Total (not compounded) sum of the components of a tax rate. | 20 | +| `valid_transaction_types` | List[[TaxRateMappingInfoValidTransactionTypes](../../models/shared/taxratemappinginfovalidtransactiontypes.md)] | :heavy_minus_sign: | Supported transaction types for the account. | Payment | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/transaction.md b/sync-for-expenses/docs/models/shared/transaction.md index 47cc37e1c..fa152f224 100755 --- a/sync-for-expenses/docs/models/shared/transaction.md +++ b/sync-for-expenses/docs/models/shared/transaction.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `integration_type` | [Optional[shared.IntegrationType]](undefined/models/shared/integrationtype.md) | :heavy_minus_sign: | Type of transaction that has been processed e.g. Expense or Bank Feed. | expenses | +| `integration_type` | [Optional[IntegrationType]](../../models/shared/integrationtype.md) | :heavy_minus_sign: | Type of transaction that has been processed e.g. Expense or Bank Feed. | expenses | | `message` | *Optional[str]* | :heavy_minus_sign: | Metadata such as validation errors or the resulting record created in the accounting software. | | -| `status` | [Optional[shared.TransactionStatus]](undefined/models/shared/transactionstatus.md) | :heavy_minus_sign: | Status of the transaction. | Completed | +| `status` | [Optional[TransactionStatus]](../../models/shared/transactionstatus.md) | :heavy_minus_sign: | Status of the transaction. | Completed | | `transaction_id` | *Optional[str]* | :heavy_minus_sign: | Your unique idenfier of the transaction. | aa02271d-ed5f-47f5-be76-778d5905225a | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/transactions.md b/sync-for-expenses/docs/models/shared/transactions.md index 3702157ec..0cc12f4d9 100755 --- a/sync-for-expenses/docs/models/shared/transactions.md +++ b/sync-for-expenses/docs/models/shared/transactions.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `links` | [Optional[shared.Links]](undefined/models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *Optional[int]* | :heavy_check_mark: | Current page number. | -| `page_size` | *Optional[int]* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | list[[shared.Transaction](undefined/models/shared/transaction.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *Optional[int]* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[Transaction](../../models/shared/transaction.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/sync-for-expenses/docs/models/shared/updatecustomerresponse.md b/sync-for-expenses/docs/models/shared/updatecustomerresponse.md index c33db951a..17c870ff4 100755 --- a/sync-for-expenses/docs/models/shared/updatecustomerresponse.md +++ b/sync-for-expenses/docs/models/shared/updatecustomerresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[shared.PushOperationChange](undefined/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` | *Optional[str]* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `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[shared.Customer]](undefined/models/shared/customer.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/sync-for-expenses-api#/schemas/Invoice).
| | -| `data_connection_key` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `data_type` | [Optional[shared.DataType]](undefined/models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `data` | [Optional[Customer]](../../models/shared/customer.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/sync-for-expenses-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: | A message about the error. | | -| `push_operation_key` | *Optional[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` | *Optional[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` | [Optional[shared.PushOperationStatus]](undefined/models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *Optional[int]* | :heavy_check_mark: | Push status code. | | +| `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 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[shared.Validation]](undefined/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 +| `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/sync-for-expenses/docs/models/shared/updateexpenserequest.md b/sync-for-expenses/docs/models/shared/updateexpenserequest.md index ea71bae92..a90ebe9ee 100755 --- a/sync-for-expenses/docs/models/shared/updateexpenserequest.md +++ b/sync-for-expenses/docs/models/shared/updateexpenserequest.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `bank_account_ref` | [Optional[shared.UpdateExpenseRequestBankAccountReference]](undefined/models/shared/updateexpenserequestbankaccountreference.md) | :heavy_minus_sign: | N/A | | -| `contact_ref` | [Optional[shared.ContactRef]](undefined/models/shared/contactref.md) | :heavy_minus_sign: | N/A | | +| `bank_account_ref` | [Optional[UpdateExpenseRequestBankAccountReference]](../../models/shared/updateexpenserequestbankaccountreference.md) | :heavy_minus_sign: | N/A | | +| `contact_ref` | [Optional[ContactRef]](../../models/shared/contactref.md) | :heavy_minus_sign: | N/A | | | `currency` | *Optional[str]* | :heavy_minus_sign: | Currency the transaction was recorded in. | 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 \| | | -| `issue_date` | *Optional[str]* | :heavy_check_mark: | Date the transaction was recorded. | 2022-06-28T00:00:00.000Z | -| `lines` | list[[shared.ExpenseTransactionLine](undefined/models/shared/expensetransactionline.md)] | :heavy_minus_sign: | Array of transaction lines. | | +| `issue_date` | *str* | :heavy_check_mark: | Date the transaction was recorded. | 2022-06-28T00:00:00.000Z | +| `lines` | List[[ExpenseTransactionLine](../../models/shared/expensetransactionline.md)] | :heavy_minus_sign: | Array of transaction lines. | | | `merchant_name` | *Optional[str]* | :heavy_minus_sign: | Name of the merchant where the purchase took place | Amazon UK | | `notes` | *Optional[str]* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | -| `type` | *Optional[Any]* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | *Any* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/shared/updatesupplierresponse.md b/sync-for-expenses/docs/models/shared/updatesupplierresponse.md index 16c05b4a6..e9ad2b7b9 100755 --- a/sync-for-expenses/docs/models/shared/updatesupplierresponse.md +++ b/sync-for-expenses/docs/models/shared/updatesupplierresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[shared.PushOperationChange](undefined/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` | *Optional[str]* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `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[shared.Supplier]](undefined/models/shared/supplier.md) | :heavy_minus_sign: | > View the coverage for suppliers in the Data coverage explorer.

## Overview

From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). | | -| `data_connection_key` | *Optional[str]* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `data_type` | [Optional[shared.DataType]](undefined/models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `data` | [Optional[Supplier]](../../models/shared/supplier.md) | :heavy_minus_sign: | > View the coverage for suppliers in the Data coverage explorer.

## Overview

From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). | | +| `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: | A message about the error. | | -| `push_operation_key` | *Optional[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` | *Optional[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` | [Optional[shared.PushOperationStatus]](undefined/models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *Optional[int]* | :heavy_check_mark: | Push status code. | | +| `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 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[shared.Validation]](undefined/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 +| `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/sync-for-expenses/docs/models/shared/validation.md b/sync-for-expenses/docs/models/shared/validation.md index 1ecd1089f..294281b51 100755 --- a/sync-for-expenses/docs/models/shared/validation.md +++ b/sync-for-expenses/docs/models/shared/validation.md @@ -5,7 +5,7 @@ A human-readable object describing validation decisions Codat has made when push ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `errors` | list[[shared.ValidationItem](undefined/models/shared/validationitem.md)] | :heavy_minus_sign: | N/A | -| `warnings` | list[[shared.ValidationItem](undefined/models/shared/validationitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| 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 diff --git a/sync-for-expenses/docs/models/webhooks/clientratelimitreachedresponse.md b/sync-for-expenses/docs/models/webhooks/clientratelimitreachedresponse.md index ad8407629..690170c94 100755 --- a/sync-for-expenses/docs/models/webhooks/clientratelimitreachedresponse.md +++ b/sync-for-expenses/docs/models/webhooks/clientratelimitreachedresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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/sync-for-expenses/docs/models/webhooks/clientratelimitresetresponse.md b/sync-for-expenses/docs/models/webhooks/clientratelimitresetresponse.md index d7f86ccad..9fdae0007 100755 --- a/sync-for-expenses/docs/models/webhooks/clientratelimitresetresponse.md +++ b/sync-for-expenses/docs/models/webhooks/clientratelimitresetresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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/sync-for-expenses/docs/models/webhooks/synccompleteresponse.md b/sync-for-expenses/docs/models/webhooks/synccompleteresponse.md index 134fcfdcb..25f0fd387 100755 --- a/sync-for-expenses/docs/models/webhooks/synccompleteresponse.md +++ b/sync-for-expenses/docs/models/webhooks/synccompleteresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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/sync-for-expenses/docs/models/webhooks/syncfailedresponse.md b/sync-for-expenses/docs/models/webhooks/syncfailedresponse.md index 53621d1e5..9b560f9a2 100755 --- a/sync-for-expenses/docs/models/webhooks/syncfailedresponse.md +++ b/sync-for-expenses/docs/models/webhooks/syncfailedresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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/sync-for-expenses/docs/models/webhooks/syncstartedresponse.md b/sync-for-expenses/docs/models/webhooks/syncstartedresponse.md index 2ec9fd87c..0108dfd38 100755 --- a/sync-for-expenses/docs/models/webhooks/syncstartedresponse.md +++ b/sync-for-expenses/docs/models/webhooks/syncstartedresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `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/sync-for-expenses/docs/sdks/accounts/README.md b/sync-for-expenses/docs/sdks/accounts/README.md index 2706dccac..09f8c8b34 100755 --- a/sync-for-expenses/docs/sdks/accounts/README.md +++ b/sync-for-expenses/docs/sdks/accounts/README.md @@ -44,35 +44,37 @@ req = operations.CreateAccountRequest( fully_qualified_category='Asset.Current', fully_qualified_name='Cash On Hand', id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e', - is_bank_account=False, - metadata=shared.AccountMetadata( - is_deleted=False, - ), + metadata=shared.AccountMetadata(), 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={ + "Money": { + "blue": 'shred', + }, + }, + ), type=shared.AccountType.ASSET, valid_datatype_links=[ shared.AccountValidDataTypeLinks( links=[ - 'Money', + 'abnormally', ], - property='Cambridgeshire grey technology', ), ], ), - allow_sync_on_push_complete=False, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=86, ) res = s.accounts.create(req) if res.create_account_response is not None: # handle response + pass ``` ### Parameters @@ -122,6 +124,7 @@ res = s.accounts.get_create_model(req) if res.push_option is not None: # handle response + pass ``` ### Parameters diff --git a/sync-for-expenses/docs/sdks/companies/README.md b/sync-for-expenses/docs/sdks/companies/README.md index b5a40660f..8889b6dc5 100755 --- a/sync-for-expenses/docs/sdks/companies/README.md +++ b/sync-for-expenses/docs/sdks/companies/README.md @@ -42,6 +42,7 @@ res = s.companies.create(req) if res.company is not None: # handle response + pass ``` ### Parameters @@ -82,6 +83,7 @@ res = s.companies.delete(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -121,6 +123,7 @@ res = s.companies.get(req) if res.company is not None: # handle response + pass ``` ### Parameters @@ -156,13 +159,13 @@ req = operations.ListCompaniesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='Northeast Metal Canada', ) res = s.companies.list(req) if res.companies is not None: # handle response + pass ``` ### Parameters @@ -206,6 +209,7 @@ res = s.companies.update(req) if res.company is not None: # handle response + pass ``` ### Parameters diff --git a/sync-for-expenses/docs/sdks/configuration/README.md b/sync-for-expenses/docs/sdks/configuration/README.md index b559ae7dd..642434f4e 100755 --- a/sync-for-expenses/docs/sdks/configuration/README.md +++ b/sync-for-expenses/docs/sdks/configuration/README.md @@ -35,6 +35,7 @@ res = s.configuration.get(req) if res.company_configuration is not None: # handle response + pass ``` ### Parameters @@ -74,6 +75,7 @@ res = s.configuration.get_mapping_options(req) if res.mapping_options is not None: # handle response + pass ``` ### Parameters @@ -110,12 +112,8 @@ req = operations.SetCompanyConfigurationRequest( bank_account=shared.BankAccount( id='32', ), - customer=shared.CustomerDetails( - id='', - ), - supplier=shared.SupplierDetails( - id='', - ), + customer=shared.CustomerDetails(), + supplier=shared.SupplierDetails(), ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -124,6 +122,7 @@ res = s.configuration.set(req) if res.company_configuration is not None: # handle response + pass ``` ### Parameters diff --git a/sync-for-expenses/docs/sdks/connections/README.md b/sync-for-expenses/docs/sdks/connections/README.md index 8eb6fb9fa..b35bef0b3 100755 --- a/sync-for-expenses/docs/sdks/connections/README.md +++ b/sync-for-expenses/docs/sdks/connections/README.md @@ -43,6 +43,7 @@ res = s.connections.create(req) if res.connection is not None: # handle response + pass ``` ### Parameters @@ -82,6 +83,7 @@ res = s.connections.create_partner_expense_connection(req) if res.connection is not None: # handle response + pass ``` ### Parameters @@ -123,6 +125,7 @@ res = s.connections.delete(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -163,6 +166,7 @@ res = s.connections.get(req) if res.connection is not None: # handle response + pass ``` ### Parameters @@ -199,13 +203,13 @@ req = operations.ListConnectionsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='Northeast Metal Canada', ) res = s.connections.list(req) if res.connections is not None: # handle response + pass ``` ### Parameters @@ -238,9 +242,7 @@ s = codatsyncexpenses.CodatSyncExpenses( ) req = operations.UnlinkConnectionRequest( - request_body=operations.UnlinkConnectionUpdateConnection( - status=shared.DataConnectionStatus.PENDING_AUTH, - ), + request_body=operations.UnlinkConnectionUpdateConnection(), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -249,6 +251,7 @@ res = s.connections.unlink(req) if res.connection is not None: # handle response + pass ``` ### Parameters diff --git a/sync-for-expenses/docs/sdks/customers/README.md b/sync-for-expenses/docs/sdks/customers/README.md index 69d12cac0..e3209dd8b 100755 --- a/sync-for-expenses/docs/sdks/customers/README.md +++ b/sync-for-expenses/docs/sdks/customers/README.md @@ -41,70 +41,46 @@ req = operations.CreateCustomerRequest( customer=shared.Customer( addresses=[ shared.Items( - city='Jenafurt', - country='Sweden', - line1='innovative blue', - line2='grey technology East', - postal_code='30778', - region='quantify Polestar mobile', type=shared.AccountingAddressType.BILLING, ), ], - contact_name='Durham after', contacts=[ shared.Contact( address=shared.Items( - city='Darenberg', - country='Cote d\'Ivoire', - line1='Buckinghamshire functionalities Grocery', - line2='Metal', - postal_code='61380', - region='Interactions Senior Mouse', - type=shared.AccountingAddressType.UNKNOWN, + type=shared.AccountingAddressType.BILLING, ), - email='Judd27@hotmail.com', modified_date='2022-10-23T00:00:00.000Z', - name='transmit likewise', phone=[ shared.ContactPhone( - number='(877) 492-8687', - type=shared.PhoneNumberType.FAX, + number='01224 658 999', + type=shared.PhoneNumberType.MOBILE, ), ], - status=shared.CustomerStatus.ACTIVE, + status=shared.CustomerStatus.UNKNOWN, ), ], - customer_name='Rubber silver Indiana', - default_currency='EUR', - email_address='Thea_Ritchie76@hotmail.com', - id='', - metadata=shared.Metadata( - is_deleted=False, - ), + default_currency='GBP', + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', - phone='948.595.2034', - registration_number='digital', source_modified_date='2022-10-23T00:00:00.000Z', - status=shared.CustomerStatus.UNKNOWN, + status=shared.CustomerStatus.ARCHIVED, supplemental_data=shared.SupplementalData( content={ - "recusandae": { - "maiores": 'Mongolia', + "grey": { + "technology": 'East', }, }, ), - tax_number='discrete', ), - allow_sync_on_push_complete=False, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=522311, ) res = s.customers.create(req) if res.create_customer_response is not None: # handle response + pass ``` ### Parameters @@ -152,6 +128,7 @@ res = s.customers.get(req) if res.customer is not None: # handle response + pass ``` ### Parameters @@ -193,13 +170,13 @@ req = operations.ListCustomersRequest( order_by='-modifiedDate', page=1, page_size=100, - query='Northeast Metal Canada', ) res = s.customers.list(req) if res.customers is not None: # handle response + pass ``` ### Parameters @@ -244,72 +221,47 @@ req = operations.UpdateCustomerRequest( customer=shared.Customer( addresses=[ shared.Items( - city='Ann Arbor', - country='Montserrat', - line1='Reactive', - line2='Metal cheater Islands', - postal_code='43372', - region='Carolina syndicate', - type=shared.AccountingAddressType.BILLING, + type=shared.AccountingAddressType.DELIVERY, ), ], - contact_name='East', contacts=[ shared.Contact( address=shared.Items( - city='Olenfurt', - country='Paraguay', - line1='Home users Sharable', - line2='Lev Wooden', - postal_code='36848', - region='brightly', - type=shared.AccountingAddressType.DELIVERY, + type=shared.AccountingAddressType.UNKNOWN, ), - email='Josie49@yahoo.com', modified_date='2022-10-23T00:00:00.000Z', - name='possimus navigating Diesel', phone=[ shared.ContactPhone( number='+44 25691 154789', - type=shared.PhoneNumberType.PRIMARY, + type=shared.PhoneNumberType.LANDLINE, ), ], - status=shared.CustomerStatus.UNKNOWN, + status=shared.CustomerStatus.ARCHIVED, ), ], - customer_name='Reactive Global Northeast', - default_currency='USD', - email_address='Abe.Bogan@hotmail.com', - id='', - metadata=shared.Metadata( - is_deleted=False, - ), + default_currency='EUR', + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', - phone='(883) 732-4217 x6499', - registration_number='redundant ew', source_modified_date='2022-10-23T00:00:00.000Z', - status=shared.CustomerStatus.ACTIVE, + status=shared.CustomerStatus.ARCHIVED, supplemental_data=shared.SupplementalData( content={ - "asperiores": { - "quibusdam": 'Omnigender', + "redundant": { + "cheater": 'Islands', }, }, ), - tax_number='Volkswagen Specialist Bacon', ), - allow_sync_on_push_complete=False, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - customer_id='Copper port East', - force_update=False, - timeout_in_minutes=373959, + customer_id='withdrawal extend', ) res = s.customers.update(req) if res.update_customer_response is not None: # handle response + pass ``` ### Parameters diff --git a/sync-for-expenses/docs/sdks/expenses/README.md b/sync-for-expenses/docs/sdks/expenses/README.md index b9635482a..e1c63dd1b 100755 --- a/sync-for-expenses/docs/sdks/expenses/README.md +++ b/sync-for-expenses/docs/sdks/expenses/README.md @@ -40,7 +40,6 @@ req = operations.CreateExpenseTransactionRequest( type=shared.ContactRefType.SUPPLIER, ), currency='GBP', - currency_rate=Decimal('4865.89'), id='4d7c6929-7770-412b-91bb-44d3bc71d111', issue_date='2022-10-23T00:00:00.000Z', lines=[ @@ -73,6 +72,7 @@ res = s.expenses.create(req) if res.create_expense_response is not None: # handle response + pass ``` ### Parameters @@ -115,7 +115,6 @@ req = operations.UpdateExpenseTransactionRequest( type=shared.ContactRefType.SUPPLIER, ), currency='GBP', - currency_rate=Decimal('8574.78'), issue_date='2022-06-28T00:00:00.000Z', lines=[ shared.ExpenseTransactionLine( @@ -136,7 +135,7 @@ req = operations.UpdateExpenseTransactionRequest( ], merchant_name='Amazon UK', notes='APPLE.COM/BILL - 09001077498 - Card Ending: 4590', - type='New', + type='Van', ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', transaction_id='336694d8-2dca-4cb5-a28d-3ccb83e55eee', @@ -146,6 +145,7 @@ res = s.expenses.update(req) if res.update_expense_response is not None: # handle response + pass ``` ### Parameters @@ -191,6 +191,7 @@ res = s.expenses.upload_attachment(req) if res.attachment is not None: # handle response + pass ``` ### Parameters diff --git a/sync-for-expenses/docs/sdks/managedata/README.md b/sync-for-expenses/docs/sdks/managedata/README.md index 683a64700..8bc148d79 100755 --- a/sync-for-expenses/docs/sdks/managedata/README.md +++ b/sync-for-expenses/docs/sdks/managedata/README.md @@ -37,6 +37,7 @@ res = s.manage_data.get(req) if res.data_status_response is not None: # handle response + pass ``` ### Parameters @@ -77,6 +78,7 @@ res = s.manage_data.get_pull_operation(req) if res.pull_operation is not None: # handle response + pass ``` ### Parameters @@ -113,13 +115,13 @@ req = operations.ListPullOperationsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='Dock Elegant Buckinghamshire', ) res = s.manage_data.list_pull_operations(req) if res.pull_operations is not None: # handle response + pass ``` ### Parameters @@ -163,6 +165,7 @@ res = s.manage_data.refresh_all_data_types(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -198,7 +201,6 @@ s = codatsyncexpenses.CodatSyncExpenses( req = operations.RefreshDataTypeRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - connection_id='d6258093-be98-4f60-90e1-ca6bcd49fb9a', data_type=shared.DataType.INVOICES, ) @@ -206,6 +208,7 @@ res = s.manage_data.refresh_data_type(req) if res.pull_operation is not None: # handle response + pass ``` ### Parameters diff --git a/sync-for-expenses/docs/sdks/pushoperations/README.md b/sync-for-expenses/docs/sdks/pushoperations/README.md index 44a3682d2..d798817dc 100755 --- a/sync-for-expenses/docs/sdks/pushoperations/README.md +++ b/sync-for-expenses/docs/sdks/pushoperations/README.md @@ -35,6 +35,7 @@ res = s.push_operations.get(req) if res.push_operation is not None: # handle response + pass ``` ### Parameters @@ -71,13 +72,13 @@ req = operations.ListPushOperationsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='Northeast Metal Canada', ) res = s.push_operations.list(req) if res.push_operations is not None: # handle response + pass ``` ### Parameters diff --git a/sync-for-expenses/docs/sdks/suppliers/README.md b/sync-for-expenses/docs/sdks/suppliers/README.md index fb95acbb0..04b78accb 100755 --- a/sync-for-expenses/docs/sdks/suppliers/README.md +++ b/sync-for-expenses/docs/sdks/suppliers/README.md @@ -41,47 +41,31 @@ req = operations.CreateSupplierRequest( supplier=shared.Supplier( addresses=[ shared.SupplierAccountingAddress( - city='Jenafurt', - country='Sweden', - line1='innovative blue', - line2='grey technology East', - postal_code='30778', - region='quantify Polestar mobile', type=shared.AccountingAddressType.BILLING, ), ], - contact_name='Durham after', - default_currency='Intelligent Fish', - email_address='Ricardo.Hand41@gmail.com', - id='', - metadata=shared.Metadata( - is_deleted=False, - ), + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', phone='(877) 492-8687', - registration_number='Profound', source_modified_date='2022-10-23T00:00:00.000Z', status=shared.SupplierStatus.ACTIVE, - supplemental_data=shared.SupplierSupplementalData( + supplemental_data=shared.SupplementalData( content={ - "pariatur": { - "accusantium": 'Minivan', + "innovative": { + "blue": 'shred', }, }, ), - supplier_name='Senior Mouse West', - tax_number='Towels likewise', ), - allow_sync_on_push_complete=False, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - timeout_in_minutes=452224, ) res = s.suppliers.create(req) if res.create_supplier_response is not None: # handle response + pass ``` ### Parameters @@ -129,6 +113,7 @@ res = s.suppliers.get(req) if res.supplier is not None: # handle response + pass ``` ### Parameters @@ -170,13 +155,13 @@ req = operations.ListSuppliersRequest( order_by='-modifiedDate', page=1, page_size=100, - query='Northeast Metal Canada', ) res = s.suppliers.list(req) if res.suppliers is not None: # handle response + pass ``` ### Parameters @@ -221,49 +206,32 @@ req = operations.UpdateSupplierRequest( supplier=shared.Supplier( addresses=[ shared.SupplierAccountingAddress( - city='Ann Arbor', - country='Montserrat', - line1='Reactive', - line2='Metal cheater Islands', - postal_code='43372', - region='Carolina syndicate', - type=shared.AccountingAddressType.BILLING, + type=shared.AccountingAddressType.DELIVERY, ), ], - contact_name='East', - default_currency='Bicycle guestbook', - email_address='Alexys.Hayes81@yahoo.com', - id='', - metadata=shared.Metadata( - is_deleted=False, - ), + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', phone='(877) 492-8687', - registration_number='indexing', source_modified_date='2022-10-23T00:00:00.000Z', - status=shared.SupplierStatus.UNKNOWN, - supplemental_data=shared.SupplierSupplementalData( + status=shared.SupplierStatus.ACTIVE, + supplemental_data=shared.SupplementalData( content={ - "consectetur": { - "ullam": 'Jaguar', + "male": { + "Metal": 'cheater', }, }, ), - supplier_name='visionary Buckinghamshire frictionless', - tax_number='parse possimus', ), - allow_sync_on_push_complete=False, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - force_update=False, - supplier_id='7110701885', - timeout_in_minutes=427089, + supplier_id='13d946f0-c5d5-42bc-b092-97ece17923ab', ) res = s.suppliers.update(req) if res.update_supplier_response is not None: # handle response + pass ``` ### Parameters diff --git a/sync-for-expenses/docs/sdks/sync/README.md b/sync-for-expenses/docs/sdks/sync/README.md index 2741ed878..85eb885ba 100755 --- a/sync-for-expenses/docs/sdks/sync/README.md +++ b/sync-for-expenses/docs/sdks/sync/README.md @@ -38,6 +38,7 @@ res = s.sync.get(req) if res.company_sync_status is not None: # handle response + pass ``` ### Parameters @@ -77,6 +78,7 @@ res = s.sync.get_last_successful_sync(req) if res.company_sync_status is not None: # handle response + pass ``` ### Parameters @@ -116,6 +118,7 @@ res = s.sync.get_latest_sync(req) if res.company_sync_status is not None: # handle response + pass ``` ### Parameters @@ -160,6 +163,7 @@ res = s.sync.initiate_sync(req) if res.sync_initiated is not None: # handle response + pass ``` ### Parameters @@ -199,6 +203,7 @@ res = s.sync.list(req) if res.company_sync_statuses is not None: # handle response + pass ``` ### Parameters diff --git a/sync-for-expenses/docs/sdks/transactionstatus/README.md b/sync-for-expenses/docs/sdks/transactionstatus/README.md index d4a5a87f0..7e7574206 100755 --- a/sync-for-expenses/docs/sdks/transactionstatus/README.md +++ b/sync-for-expenses/docs/sdks/transactionstatus/README.md @@ -36,6 +36,7 @@ res = s.transaction_status.get(req) if res.transaction is not None: # handle response + pass ``` ### Parameters @@ -78,6 +79,7 @@ res = s.transaction_status.list(req) if res.transactions is not None: # handle response + pass ``` ### Parameters diff --git a/sync-for-expenses/files.gen b/sync-for-expenses/files.gen index 548a29107..ea47c34e9 100755 --- a/sync-for-expenses/files.gen +++ b/sync-for-expenses/files.gen @@ -69,6 +69,7 @@ src/codatsyncexpenses/models/shared/pushoperationstatus.py src/codatsyncexpenses/models/shared/datatype.py src/codatsyncexpenses/models/shared/account.py src/codatsyncexpenses/models/shared/accounttype.py +src/codatsyncexpenses/models/shared/supplementaldata.py src/codatsyncexpenses/models/shared/accountstatus.py src/codatsyncexpenses/models/shared/pushoperationchange.py src/codatsyncexpenses/models/shared/pushchangetype.py @@ -98,7 +99,6 @@ src/codatsyncexpenses/models/shared/accountmappinginfo.py src/codatsyncexpenses/models/shared/connections.py src/codatsyncexpenses/models/shared/createcustomerresponse.py src/codatsyncexpenses/models/shared/customer.py -src/codatsyncexpenses/models/shared/supplementaldata.py src/codatsyncexpenses/models/shared/customerstatus.py src/codatsyncexpenses/models/shared/metadata.py src/codatsyncexpenses/models/shared/contact.py @@ -246,6 +246,7 @@ docs/models/shared/accountmetadata.md docs/models/shared/accountvaliddatatypelinks.md docs/models/shared/account.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 @@ -279,7 +280,6 @@ docs/models/shared/accountmappinginfo.md docs/models/shared/connections.md docs/models/shared/createcustomerresponse.md docs/models/shared/customer.md -docs/models/shared/supplementaldata.md docs/models/shared/customerstatus.md docs/models/shared/metadata.md docs/models/shared/contactphone.md @@ -311,7 +311,6 @@ docs/models/shared/pushoperation.md docs/models/shared/pushoperations.md docs/models/shared/createsupplierresponse.md docs/models/shared/supplieraccountingaddress.md -docs/models/shared/suppliersupplementaldata.md docs/models/shared/supplier.md docs/models/shared/supplierstatus.md docs/models/shared/suppliers.md diff --git a/sync-for-expenses/gen.yaml b/sync-for-expenses/gen.yaml index d2fdd6b73..24a57c693 100644 --- a/sync-for-expenses/gen.yaml +++ b/sync-for-expenses/gen.yaml @@ -1,25 +1,26 @@ configVersion: 1.0.0 management: - docChecksum: 908430e8ef88caa5eeda9fb79d2ec363 + docChecksum: cd39427322ae650607fb0524405a4f11 docVersion: prealpha - speakeasyVersion: 1.93.3 - generationVersion: 2.146.1 + speakeasyVersion: 1.100.2 + generationVersion: 2.159.2 generation: sdkClassName: CodatSyncExpenses singleTagPerOp: false telemetryEnabled: true features: python: - core: 2.88.1 + 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: 3.1.0 + version: 4.0.0 author: Codat description: Push expenses to accounting platforms. + flattenGlobalSecurity: false maxMethodParams: 0 packageName: codat-sync-for-expenses diff --git a/sync-for-expenses/pylintrc b/sync-for-expenses/pylintrc index 2a6cf6912..1ed32214e 100755 --- a/sync-for-expenses/pylintrc +++ b/sync-for-expenses/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 diff --git a/sync-for-expenses/setup.py b/sync-for-expenses/setup.py index bd1a9ab02..35f05bc18 100755 --- a/sync-for-expenses/setup.py +++ b/sync-for-expenses/setup.py @@ -10,33 +10,31 @@ setuptools.setup( name="codat-sync-for-expenses", - version="3.1.0", + version="4.0.0", author="Codat", description="Push expenses to accounting platforms.", 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", + "certifi>=2023.7.22", + "charset-normalizer>=3.2.0", "dataclasses-json>=0.6.1", - "idna>=3.3", + "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/sync-for-expenses/src/codatsyncexpenses/manage_data.py b/sync-for-expenses/src/codatsyncexpenses/manage_data.py index 67e2c5e0e..452a2637d 100755 --- a/sync-for-expenses/src/codatsyncexpenses/manage_data.py +++ b/sync-for-expenses/src/codatsyncexpenses/manage_data.py @@ -3,7 +3,7 @@ from .sdkconfiguration import SDKConfiguration from codatsyncexpenses import utils from codatsyncexpenses.models import errors, operations, shared -from typing import Optional +from typing import Dict, Optional class ManageData: r"""Asynchronously retrieve data from an integration to refresh data in Codat.""" @@ -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.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) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/__init__.py b/sync-for-expenses/src/codatsyncexpenses/models/__init__.py index 889f8adcf..36628d6cc 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/__init__.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/__init__.py @@ -1,2 +1,3 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" +# __init__.py diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_account.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_account.py index bd4d5ba32..30c894086 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_account.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_account.py @@ -9,7 +9,6 @@ from typing import Optional - @dataclasses.dataclass class CreateAccountRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -25,7 +24,6 @@ class CreateAccountRequest: - @dataclasses.dataclass class CreateAccountResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_company.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_company.py index 11da1c1a3..3225796a8 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_company.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_company.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class CreateCompanyResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_connection.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_connection.py index a522f5055..4cea97fdf 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_connection.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_connection.py @@ -11,7 +11,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CreateConnectionRequestBody: platform_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('platformKey'), 'exclude': lambda f: f is None }}) @@ -20,7 +19,6 @@ class CreateConnectionRequestBody: - @dataclasses.dataclass class CreateConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -30,7 +28,6 @@ class CreateConnectionRequest: - @dataclasses.dataclass class CreateConnectionResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_customer.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_customer.py index eb382f3bd..314cb49ef 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_customer.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_customer.py @@ -9,7 +9,6 @@ from typing import Optional - @dataclasses.dataclass class CreateCustomerRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -25,7 +24,6 @@ class CreateCustomerRequest: - @dataclasses.dataclass class CreateCustomerResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_expense_transaction.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_expense_transaction.py index 066b00f25..d95ec0557 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_expense_transaction.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_expense_transaction.py @@ -9,7 +9,6 @@ from typing import Optional - @dataclasses.dataclass class CreateExpenseTransactionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -19,7 +18,6 @@ class CreateExpenseTransactionRequest: - @dataclasses.dataclass class CreateExpenseTransactionResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_partner_expense_connection.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_partner_expense_connection.py index e5a5f5cd4..9df550ec7 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_partner_expense_connection.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_partner_expense_connection.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class CreatePartnerExpenseConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -17,7 +16,6 @@ class CreatePartnerExpenseConnectionRequest: - @dataclasses.dataclass class CreatePartnerExpenseConnectionResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_supplier.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_supplier.py index c5d61460f..5f6b0a3cc 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/create_supplier.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/create_supplier.py @@ -9,7 +9,6 @@ from typing import Optional - @dataclasses.dataclass class CreateSupplierRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -25,7 +24,6 @@ class CreateSupplierRequest: - @dataclasses.dataclass class CreateSupplierResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/delete_company.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/delete_company.py index 8b3f3ff00..0c7da43c5 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/delete_company.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/delete_company.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class DeleteCompanyRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -16,7 +15,6 @@ class DeleteCompanyRequest: - @dataclasses.dataclass class DeleteCompanyResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/delete_connection.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/delete_connection.py index 47f92c398..568a81d83 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/delete_connection.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/delete_connection.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class DeleteConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -18,7 +17,6 @@ class DeleteConnectionRequest: - @dataclasses.dataclass class DeleteConnectionResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_company.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_company.py index 0ab4dc87c..9660394e9 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_company.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_company.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetCompanyRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -17,7 +16,6 @@ class GetCompanyRequest: - @dataclasses.dataclass class GetCompanyResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_company_configuration.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_company_configuration.py index 65c4c4f71..061c6ca65 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_company_configuration.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_company_configuration.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetCompanyConfigurationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -17,7 +16,6 @@ class GetCompanyConfigurationRequest: - @dataclasses.dataclass class GetCompanyConfigurationResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_connection.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_connection.py index c311165dd..c21ca84ed 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_connection.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_connection.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -19,7 +18,6 @@ class GetConnectionRequest: - @dataclasses.dataclass class GetConnectionResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_create_chartofaccounts_model.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_create_chartofaccounts_model.py index 002e61948..7961bde4f 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_create_chartofaccounts_model.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_create_chartofaccounts_model.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetCreateChartOfAccountsModelRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -19,7 +18,6 @@ class GetCreateChartOfAccountsModelRequest: - @dataclasses.dataclass class GetCreateChartOfAccountsModelResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_customer.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_customer.py index 36def54c0..da9681beb 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_customer.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_customer.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetCustomerRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -19,7 +18,6 @@ class GetCustomerRequest: - @dataclasses.dataclass class GetCustomerResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_data_status.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_data_status.py index 990782412..f6135ac0d 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_data_status.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_data_status.py @@ -5,8 +5,7 @@ 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 @@ -17,14 +16,13 @@ class GetDataStatusRequest: - @dataclasses.dataclass class GetDataStatusResponse: 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""" - data_status_response: Optional[dict[str, shared_datastatus.DataStatus]] = dataclasses.field(default=None) + 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.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_last_successful_sync.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_last_successful_sync.py index 7d5586644..54808eedc 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_last_successful_sync.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_last_successful_sync.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetLastSuccessfulSyncRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -17,7 +16,6 @@ class GetLastSuccessfulSyncRequest: - @dataclasses.dataclass class GetLastSuccessfulSyncResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_latest_sync.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_latest_sync.py index f4fd17f32..17e4554f5 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_latest_sync.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_latest_sync.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetLatestSyncRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -17,7 +16,6 @@ class GetLatestSyncRequest: - @dataclasses.dataclass class GetLatestSyncResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_mapping_options.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_mapping_options.py index ba737b219..d34081207 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_mapping_options.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_mapping_options.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetMappingOptionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -17,7 +16,6 @@ class GetMappingOptionsRequest: - @dataclasses.dataclass class GetMappingOptionsResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_pull_operation.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_pull_operation.py index 6f62c9006..09ba964b9 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_pull_operation.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_pull_operation.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetPullOperationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -19,7 +18,6 @@ class GetPullOperationRequest: - @dataclasses.dataclass class GetPullOperationResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_push_operation.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_push_operation.py index b92abb271..3b11bb84d 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_push_operation.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_push_operation.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetPushOperationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -19,7 +18,6 @@ class GetPushOperationRequest: - @dataclasses.dataclass class GetPushOperationResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_supplier.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_supplier.py index 18fd1a07f..03c3a6d9e 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_supplier.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_supplier.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetSupplierRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -19,7 +18,6 @@ class GetSupplierRequest: - @dataclasses.dataclass class GetSupplierResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_sync_by_id.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_sync_by_id.py index 73d5f57d9..f6dc0159b 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_sync_by_id.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_sync_by_id.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetSyncByIDRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -19,7 +18,6 @@ class GetSyncByIDRequest: - @dataclasses.dataclass class GetSyncByIDResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_sync_transaction.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_sync_transaction.py index 0bc1c7a68..2e9fe7446 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/get_sync_transaction.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/get_sync_transaction.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class GetSyncTransactionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -21,7 +20,6 @@ class GetSyncTransactionRequest: - @dataclasses.dataclass class GetSyncTransactionResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/initiate_sync.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/initiate_sync.py index 1e4f2dd3a..d855e9fc9 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/initiate_sync.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/initiate_sync.py @@ -9,7 +9,6 @@ from typing import Optional - @dataclasses.dataclass class InitiateSyncRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -19,7 +18,6 @@ class InitiateSyncRequest: - @dataclasses.dataclass class InitiateSyncResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_companies.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_companies.py index 7efaf0954..601c3326c 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_companies.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_companies.py @@ -8,7 +8,6 @@ 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 }}) @@ -23,7 +22,6 @@ class ListCompaniesRequest: - @dataclasses.dataclass class ListCompaniesResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_connections.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_connections.py index e85d21f0b..8c85c3ad3 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_connections.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_connections.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class ListConnectionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -25,7 +24,6 @@ class ListConnectionsRequest: - @dataclasses.dataclass class ListConnectionsResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_customers.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_customers.py index 7a97ea778..8a7091822 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_customers.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_customers.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class ListCustomersRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -25,7 +24,6 @@ class ListCustomersRequest: - @dataclasses.dataclass class ListCustomersResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_pull_operations.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_pull_operations.py index c8054ddd3..609e02e50 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_pull_operations.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_pull_operations.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class ListPullOperationsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -25,7 +24,6 @@ class ListPullOperationsRequest: - @dataclasses.dataclass class ListPullOperationsResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_push_operations.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_push_operations.py index cc074b37a..31aa99ee3 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_push_operations.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_push_operations.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class ListPushOperationsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -25,7 +24,6 @@ class ListPushOperationsRequest: - @dataclasses.dataclass class ListPushOperationsResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_suppliers.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_suppliers.py index 7e4f5bf9c..6b100113a 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_suppliers.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_suppliers.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class ListSuppliersRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -25,7 +24,6 @@ class ListSuppliersRequest: - @dataclasses.dataclass class ListSuppliersResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_sync_transactions.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_sync_transactions.py index 25ba0e578..42250e6e9 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_sync_transactions.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_sync_transactions.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class ListSyncTransactionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -23,7 +22,6 @@ class ListSyncTransactionsRequest: - @dataclasses.dataclass class ListSyncTransactionsResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_syncs.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_syncs.py index 1911a535f..da54b7875 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/list_syncs.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/list_syncs.py @@ -5,8 +5,7 @@ import requests as requests_http from ..shared import companysyncstatus as shared_companysyncstatus from ..shared import errormessage as shared_errormessage -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass @@ -17,14 +16,13 @@ class ListSyncsRequest: - @dataclasses.dataclass class ListSyncsResponse: 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_sync_statuses: Optional[list[shared_companysyncstatus.CompanySyncStatus]] = dataclasses.field(default=None) + company_sync_statuses: Optional[List[shared_companysyncstatus.CompanySyncStatus]] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/refresh_all_data_types.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/refresh_all_data_types.py index 502c69d86..526ab213e 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/refresh_all_data_types.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/refresh_all_data_types.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class RefreshAllDataTypesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -16,7 +15,6 @@ class RefreshAllDataTypesRequest: - @dataclasses.dataclass class RefreshAllDataTypesResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/refresh_data_type.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/refresh_data_type.py index 7ab552a45..ad5ef640d 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/refresh_data_type.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/refresh_data_type.py @@ -9,7 +9,6 @@ from typing import Optional - @dataclasses.dataclass class RefreshDataTypeRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -22,7 +21,6 @@ class RefreshDataTypeRequest: - @dataclasses.dataclass class RefreshDataTypeResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/set_company_configuration.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/set_company_configuration.py index 9a1e16378..3855cc61e 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/set_company_configuration.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/set_company_configuration.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class SetCompanyConfigurationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -18,7 +17,6 @@ class SetCompanyConfigurationRequest: - @dataclasses.dataclass class SetCompanyConfigurationResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/unlink_connection.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/unlink_connection.py index 0944011af..95d19d557 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/unlink_connection.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/unlink_connection.py @@ -12,7 +12,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class UnlinkConnectionUpdateConnection: 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 }}) @@ -21,7 +20,6 @@ class UnlinkConnectionUpdateConnection: - @dataclasses.dataclass class UnlinkConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -33,7 +31,6 @@ class UnlinkConnectionRequest: - @dataclasses.dataclass class UnlinkConnectionResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/update_company.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/update_company.py index 7b8b83bf5..6f159a98a 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/update_company.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/update_company.py @@ -9,7 +9,6 @@ from typing import Optional - @dataclasses.dataclass class UpdateCompanyRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -19,7 +18,6 @@ class UpdateCompanyRequest: - @dataclasses.dataclass class UpdateCompanyResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/update_customer.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/update_customer.py index f261b49ad..73d484a67 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/update_customer.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/update_customer.py @@ -9,7 +9,6 @@ from typing import Optional - @dataclasses.dataclass class UpdateCustomerRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -29,7 +28,6 @@ class UpdateCustomerRequest: - @dataclasses.dataclass class UpdateCustomerResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/update_expense_transaction.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/update_expense_transaction.py index eb6eba265..b244d2b84 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/update_expense_transaction.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/update_expense_transaction.py @@ -9,7 +9,6 @@ from typing import Optional - @dataclasses.dataclass class UpdateExpenseTransactionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -21,7 +20,6 @@ class UpdateExpenseTransactionRequest: - @dataclasses.dataclass class UpdateExpenseTransactionResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/update_supplier.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/update_supplier.py index cc75f5309..1e995b680 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/update_supplier.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/update_supplier.py @@ -9,7 +9,6 @@ from typing import Optional - @dataclasses.dataclass class UpdateSupplierRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -29,7 +28,6 @@ class UpdateSupplierRequest: - @dataclasses.dataclass class UpdateSupplierResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/operations/upload_expense_attachment.py b/sync-for-expenses/src/codatsyncexpenses/models/operations/upload_expense_attachment.py index 010df8e60..39386cf88 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/operations/upload_expense_attachment.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/operations/upload_expense_attachment.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class UploadExpenseAttachmentRequestBody: content: bytes = dataclasses.field(metadata={'multipart_form': { 'content': True }}) @@ -17,7 +16,6 @@ class UploadExpenseAttachmentRequestBody: - @dataclasses.dataclass class UploadExpenseAttachmentRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) @@ -31,7 +29,6 @@ class UploadExpenseAttachmentRequest: - @dataclasses.dataclass class UploadExpenseAttachmentResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/__init__.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/__init__.py index 5dec1f6aa..47bcf4090 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/__init__.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/__init__.py @@ -83,4 +83,4 @@ from .validation import * from .validationitem import * -__all__ = ["Account","AccountMappingInfo","AccountMappingInfoAccountType","AccountMappingInfoValidTransactionTypes","AccountMetadata","AccountStatus","AccountType","AccountValidDataTypeLinks","AccountingAddressType","Attachment","BankAccount","ClientRateLimitReachedWebhook","ClientRateLimitReachedWebhookData","ClientRateLimitResetWebhook","ClientRateLimitResetWebhookData","Companies","Company","CompanyConfiguration","CompanyRequestBody","CompanySyncStatus","Connection","ConnectionSourceType","Connections","Contact","ContactPhone","ContactRef","ContactRefType","CreateAccountResponse","CreateCustomerResponse","CreateExpenseRequest","CreateExpenseResponse","CreateSupplierResponse","Customer","CustomerDetails","CustomerStatus","Customers","DataConnectionError","DataConnectionStatus","DataStatus","DataStatusDataTypes","DataType","ErrorMessage","ExpenseTransaction","ExpenseTransactionBankAccountReference","ExpenseTransactionLine","ExpenseTransactionType","HalRef","InitiateSync","IntegrationType","Items","Links","MappingOptions","Metadata","PhoneNumberType","PullOperation","PullOperationStatus","PullOperations","PushChangeType","PushFieldValidation","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperations","PushOption","PushOptionChoice","PushOptionProperty","PushOptionType","PushValidationInfo","RecordRef","Security","SupplementalData","Supplier","SupplierAccountingAddress","SupplierDetails","SupplierStatus","SupplierSupplementalData","Suppliers","SyncCompleteWebhook","SyncCompleteWebhookData","SyncFailedWebhook","SyncFailedWebhookData","SyncInitiated","SyncStartedWebhook","SyncStartedWebhookData","TaxRateMappingInfo","TaxRateMappingInfoValidTransactionTypes","TrackingCategoryMappingInfo","Transaction","TransactionStatus","Transactions","UpdateCustomerResponse","UpdateExpenseRequest","UpdateExpenseRequestBankAccountReference","UpdateExpenseResponse","UpdateSupplierResponse","Validation","ValidationItem"] +__all__ = ["Account","AccountMappingInfo","AccountMappingInfoAccountType","AccountMappingInfoValidTransactionTypes","AccountMetadata","AccountStatus","AccountType","AccountValidDataTypeLinks","AccountingAddressType","Attachment","BankAccount","ClientRateLimitReachedWebhook","ClientRateLimitReachedWebhookData","ClientRateLimitResetWebhook","ClientRateLimitResetWebhookData","Companies","Company","CompanyConfiguration","CompanyRequestBody","CompanySyncStatus","Connection","ConnectionSourceType","Connections","Contact","ContactPhone","ContactRef","ContactRefType","CreateAccountResponse","CreateCustomerResponse","CreateExpenseRequest","CreateExpenseResponse","CreateSupplierResponse","Customer","CustomerDetails","CustomerStatus","Customers","DataConnectionError","DataConnectionStatus","DataStatus","DataStatusDataTypes","DataType","ErrorMessage","ExpenseTransaction","ExpenseTransactionBankAccountReference","ExpenseTransactionLine","ExpenseTransactionType","HalRef","InitiateSync","IntegrationType","Items","Links","MappingOptions","Metadata","PhoneNumberType","PullOperation","PullOperationStatus","PullOperations","PushChangeType","PushFieldValidation","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperations","PushOption","PushOptionChoice","PushOptionProperty","PushOptionType","PushValidationInfo","RecordRef","Security","SupplementalData","Supplier","SupplierAccountingAddress","SupplierDetails","SupplierStatus","Suppliers","SyncCompleteWebhook","SyncCompleteWebhookData","SyncFailedWebhook","SyncFailedWebhookData","SyncInitiated","SyncStartedWebhook","SyncStartedWebhookData","TaxRateMappingInfo","TaxRateMappingInfoValidTransactionTypes","TrackingCategoryMappingInfo","Transaction","TransactionStatus","Transactions","UpdateCustomerResponse","UpdateExpenseRequest","UpdateExpenseRequestBankAccountReference","UpdateExpenseResponse","UpdateSupplierResponse","Validation","ValidationItem"] diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/account.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/account.py index c634615ab..44bbd4427 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/account.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/account.py @@ -4,14 +4,14 @@ import dataclasses from ..shared import accountstatus as shared_accountstatus from ..shared import accounttype as shared_accounttype +from ..shared import supplementaldata as shared_supplementaldata from codatsyncexpenses 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 AccountMetadata: is_deleted: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDeleted') }}) @@ -21,7 +21,6 @@ class AccountMetadata: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountValidDataTypeLinks: 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,7 +64,7 @@ class AccountValidDataTypeLinks: 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') }}) + 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') }}) r"""The property from the account that can be linked.""" @@ -74,7 +73,6 @@ class AccountValidDataTypeLinks: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Account: r"""> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**. @@ -143,9 +141,14 @@ class Account: 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[AccountValidDataTypeLinks]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validDatatypeLinks') }}) + valid_datatype_links: Optional[List[AccountValidDataTypeLinks]] = 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](/sync-for-expenses-api#/schemas/ValidDataTypeLinks).""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/accountmappinginfo.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/accountmappinginfo.py index ab51c44f4..92f544e2c 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/accountmappinginfo.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/accountmappinginfo.py @@ -5,7 +5,7 @@ from codatsyncexpenses import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum -from typing import Optional +from typing import List, Optional class AccountMappingInfoAccountType(str, Enum): r"""Type of the account.""" @@ -27,7 +27,6 @@ class AccountMappingInfoValidTransactionTypes(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountMappingInfo: account_type: Optional[AccountMappingInfoAccountType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountType') }}) @@ -38,7 +37,7 @@ class AccountMappingInfo: r"""Unique identifier of account.""" name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of the account as it appears in the companies accounting software.""" - valid_transaction_types: Optional[list[AccountMappingInfoValidTransactionTypes]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validTransactionTypes') }}) + valid_transaction_types: Optional[List[AccountMappingInfoValidTransactionTypes]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validTransactionTypes') }}) r"""Supported transaction types for the account.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/attachment.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/attachment.py index fbef368aa..c913350f6 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/attachment.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/attachment.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Attachment: company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/bankaccount.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/bankaccount.py index a5261ca91..2ad68940c 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/bankaccount.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/bankaccount.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BankAccount: id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitreachedwebhook.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitreachedwebhook.py index 2182e360e..d60ab4d3c 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitreachedwebhook.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitreachedwebhook.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ClientRateLimitReachedWebhook: r"""Webhook request body for a client that has reached their rate limit.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitreachedwebhookdata.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitreachedwebhookdata.py index 6d6ac10ee..48ce6840d 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitreachedwebhookdata.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitreachedwebhookdata.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ClientRateLimitReachedWebhookData: daily_quota: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DailyQuota'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitresetwebhook.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitresetwebhook.py index 716ce015b..eeb34129a 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitresetwebhook.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitresetwebhook.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ClientRateLimitResetWebhook: r"""Webhook request body for a client that has had their rate limit reset.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitresetwebhookdata.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitresetwebhookdata.py index 156796ce0..cc406c1d4 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitresetwebhookdata.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/clientratelimitresetwebhookdata.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ClientRateLimitResetWebhookData: daily_quota: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DailyQuota'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/companies.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/companies.py index 51489dce1..fbdbc0849 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/companies.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/companies.py @@ -6,11 +6,10 @@ from ..shared import links as shared_links from codatsyncexpenses 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') }}) @@ -20,6 +19,6 @@ class Companies: r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) 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 }}) + 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/sync-for-expenses/src/codatsyncexpenses/models/shared/company.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/company.py index a20fb39a9..042ab10d1 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/company.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/company.py @@ -5,11 +5,10 @@ from ..shared import connection as shared_connection from codatsyncexpenses 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-expenses-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. @@ -47,7 +46,7 @@ class Company: """ 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 }}) 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 }}) + 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 }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/companyconfiguration.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/companyconfiguration.py index 9a99e0083..b0e933bb2 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/companyconfiguration.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/companyconfiguration.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CompanyConfiguration: bank_account: shared_bankaccount.BankAccount = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bankAccount') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/companyrequestbody.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/companyrequestbody.py index cdc393cd6..df9235d72 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/companyrequestbody.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/companyrequestbody.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CompanyRequestBody: name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/companysyncstatus.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/companysyncstatus.py index f39c6b6ec..3415bb73b 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/companysyncstatus.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/companysyncstatus.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CompanySyncStatus: company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/connection.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/connection.py index 0e7be0a86..43d71b6df 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/connection.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/connection.py @@ -7,7 +7,7 @@ from codatsyncexpenses 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-expenses-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source. @@ -71,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/sync-for-expenses/src/codatsyncexpenses/models/shared/connections.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/connections.py index 25c4dffa9..5bb865452 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/connections.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/connections.py @@ -6,11 +6,10 @@ from ..shared import links as shared_links from codatsyncexpenses 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') }}) @@ -20,6 +19,6 @@ class Connections: r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) 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 }}) + 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/sync-for-expenses/src/codatsyncexpenses/models/shared/contact.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/contact.py index febc199f8..308e6fed2 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/contact.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/contact.py @@ -7,11 +7,10 @@ from ..shared import phonenumbertype as shared_phonenumbertype from codatsyncexpenses 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 ContactPhone: number: Optional[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('number') }}) @@ -23,7 +22,6 @@ class ContactPhone: @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') }}) @@ -54,7 +52,7 @@ class Contact: """ 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[ContactPhone]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone') }}) + phone: Optional[List[ContactPhone]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone') }}) r"""An array of Phone numbers.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/contactref.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/contactref.py index 1610a7bee..e2ec795b1 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/contactref.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/contactref.py @@ -13,7 +13,6 @@ class ContactRefType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ContactRef: id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/createaccountresponse.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/createaccountresponse.py index cef828aed..602b7ee3b 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/createaccountresponse.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/createaccountresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsyncexpenses 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 CreateAccountResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -47,7 +46,7 @@ class CreateAccountResponse: r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) r"""Push status code.""" - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) + 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: diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/createcustomerresponse.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/createcustomerresponse.py index 45a33b02d..8d8056c5d 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/createcustomerresponse.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/createcustomerresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsyncexpenses 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 CreateCustomerResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -47,7 +46,7 @@ class CreateCustomerResponse: r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) r"""Push status code.""" - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) + 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: diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/createexpenserequest.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/createexpenserequest.py index 2fb2d1c75..8870029dd 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/createexpenserequest.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/createexpenserequest.py @@ -5,13 +5,12 @@ from ..shared import expensetransaction as shared_expensetransaction from codatsyncexpenses 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 CreateExpenseRequest: - items: Optional[list[shared_expensetransaction.ExpenseTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('items'), 'exclude': lambda f: f is None }}) + items: Optional[List[shared_expensetransaction.ExpenseTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('items'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/createexpenseresponse.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/createexpenseresponse.py index a9011c8b2..fda894c3c 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/createexpenseresponse.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/createexpenseresponse.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CreateExpenseResponse: dataset_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetId'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/createsupplierresponse.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/createsupplierresponse.py index e7253d523..863dcce89 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/createsupplierresponse.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/createsupplierresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsyncexpenses 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 CreateSupplierResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -47,7 +46,7 @@ class CreateSupplierResponse: r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) r"""Push status code.""" - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) + 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: diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/customer.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/customer.py index a362e7ffb..a7cfebc7f 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/customer.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/customer.py @@ -9,11 +9,10 @@ from ..shared import supplementaldata as shared_supplementaldata from codatsyncexpenses 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: r"""> View the coverage for customers in the Data coverage explorer. @@ -26,11 +25,11 @@ class Customer: """ status: shared_customerstatus.CustomerStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""Status of customer.""" - addresses: Optional[list[shared_items.Items]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses') }}) + addresses: Optional[List[shared_items.Items]] = 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') }}) 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') }}) + 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') }}) r"""Name of the customer as recorded in the accounting system, typically the company name.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/customerdetails.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/customerdetails.py index 1d9abb566..9f13bda73 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/customerdetails.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/customerdetails.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CustomerDetails: id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/customers.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/customers.py index 84a51c895..f6ddaf7a4 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/customers.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/customers.py @@ -6,11 +6,10 @@ from ..shared import links as shared_links from codatsyncexpenses 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 Customers: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) @@ -20,6 +19,6 @@ class Customers: r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) r"""Total number of items.""" - results: Optional[list[shared_customer.Customer]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_customer.Customer]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/dataconnectionerror.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/dataconnectionerror.py index ad9ed48d0..c8e7e7aa9 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/dataconnectionerror.py +++ b/sync-for-expenses/src/codatsyncexpenses/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 }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/datastatus.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/datastatus.py index d489a9fd0..774558ecf 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/datastatus.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/datastatus.py @@ -54,7 +54,6 @@ class DataStatusDataTypes(str, Enum): @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""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/errormessage.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/errormessage.py index 5aa96324b..3e6365dc5 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/errormessage.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/errormessage.py @@ -8,7 +8,6 @@ @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 }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/expensetransaction.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/expensetransaction.py index aeb64bd92..e949051da 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/expensetransaction.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/expensetransaction.py @@ -8,11 +8,10 @@ from dataclasses_json import Undefined, dataclass_json from decimal import Decimal from enum import Enum -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ExpenseTransactionBankAccountReference: id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) @@ -33,7 +32,6 @@ class ExpenseTransactionType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ExpenseTransaction: currency: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) @@ -92,7 +90,7 @@ class ExpenseTransaction: | **EUR** | €20 | 1.134 | $22.68 | | **RUB** | ₽20 | 0.015 | $0.30 | """ - lines: Optional[list[shared_expensetransactionline.ExpenseTransactionLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines'), 'exclude': lambda f: f is None }}) + lines: Optional[List[shared_expensetransactionline.ExpenseTransactionLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines'), 'exclude': lambda f: f is None }}) r"""Array of transaction lines.""" merchant_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('merchantName'), 'exclude': lambda f: f is None }}) r"""Name of the merchant where the purchase took place""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/expensetransactionline.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/expensetransactionline.py index 3c141ef7b..40be0402c 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/expensetransactionline.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/expensetransactionline.py @@ -6,11 +6,10 @@ from codatsyncexpenses 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 ExpenseTransactionLine: account_ref: shared_recordref.RecordRef = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef') }}) @@ -19,6 +18,6 @@ class ExpenseTransactionLine: tax_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Amount of tax for the line.""" tax_rate_ref: Optional[shared_recordref.RecordRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateRef'), 'exclude': lambda f: f is None }}) - tracking_refs: Optional[list[shared_recordref.RecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingRefs'), 'exclude': lambda f: f is None }}) + tracking_refs: Optional[List[shared_recordref.RecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingRefs'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/halref.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/halref.py index 10ddc8560..62ccb3637 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/halref.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/halref.py @@ -8,7 +8,6 @@ @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 }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/initiatesync.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/initiatesync.py index ad927eb1c..143b208c7 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/initiatesync.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/initiatesync.py @@ -4,13 +4,12 @@ import dataclasses from codatsyncexpenses 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 InitiateSync: - dataset_ids: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetIds') }}) + dataset_ids: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetIds') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/items.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/items.py index 18989a1d7..9c94cec7f 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/items.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/items.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Items: type: shared_accountingaddresstype.AccountingAddressType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/links.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/links.py index 2d8fff4f8..bfeb0ab08 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/links.py +++ b/sync-for-expenses/src/codatsyncexpenses/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/sync-for-expenses/src/codatsyncexpenses/models/shared/mappingoptions.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/mappingoptions.py index 44db4fcde..6a4856565 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/mappingoptions.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/mappingoptions.py @@ -7,20 +7,19 @@ from ..shared import trackingcategorymappinginfo as shared_trackingcategorymappinginfo from codatsyncexpenses 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 MappingOptions: - accounts: Optional[list[shared_accountmappinginfo.AccountMappingInfo]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts') }}) + accounts: Optional[List[shared_accountmappinginfo.AccountMappingInfo]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts') }}) r"""Array of available accounts for mapping.""" expense_provider: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('expenseProvider') }}) r"""Name of the expense integration.""" - tax_rates: Optional[list[shared_taxratemappinginfo.TaxRateMappingInfo]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRates') }}) + tax_rates: Optional[List[shared_taxratemappinginfo.TaxRateMappingInfo]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRates') }}) r"""Array of available tax rates for mapping.""" - tracking_categories: Optional[list[shared_trackingcategorymappinginfo.TrackingCategoryMappingInfo]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategories') }}) + tracking_categories: Optional[List[shared_trackingcategorymappinginfo.TrackingCategoryMappingInfo]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategories') }}) r"""Array of available tracking categories for mapping.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/metadata.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/metadata.py index 960b61ad4..493860ff8 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/metadata.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/metadata.py @@ -8,7 +8,6 @@ @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') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/pulloperation.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/pulloperation.py index 44889b741..2d7092c68 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/pulloperation.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/pulloperation.py @@ -36,7 +36,6 @@ class PullOperationStatus(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PullOperation: r"""Information about a queued, in progress or completed pull operation. diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/pulloperations.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/pulloperations.py index f60b28f08..6dbc9a2d2 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/pulloperations.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/pulloperations.py @@ -6,11 +6,10 @@ from ..shared import pulloperation as shared_pulloperation from codatsyncexpenses 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') }}) @@ -20,6 +19,6 @@ class PullOperations: r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) 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 }}) + 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/sync-for-expenses/src/codatsyncexpenses/models/shared/pushfieldvalidation.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushfieldvalidation.py index ee1bd240d..b04eea8f0 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushfieldvalidation.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushfieldvalidation.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushFieldValidation: details: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperation.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperation.py index 862b276b7..1e7d08a08 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperation.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperation.py @@ -8,11 +8,10 @@ from ..shared import validation as shared_validation from codatsyncexpenses 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') }}) @@ -46,7 +45,7 @@ class PushOperation: r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) r"""Push status code.""" - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) + 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: diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperationchange.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperationchange.py index b9c3a254e..593bb6c3d 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperationchange.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperationchange.py @@ -10,7 +10,6 @@ @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') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperationref.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperationref.py index 4c9f8ef24..a7b772e66 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperationref.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperationref.py @@ -9,7 +9,6 @@ @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 }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperations.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperations.py index 009c9d1c4..7454ed7c5 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperations.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoperations.py @@ -6,11 +6,10 @@ from ..shared import pushoperation as shared_pushoperation from codatsyncexpenses 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') }}) @@ -20,6 +19,6 @@ class PushOperations: r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) 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 }}) + 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/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoption.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoption.py index 439e293d0..571e8e12e 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoption.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoption.py @@ -8,11 +8,10 @@ from ..shared import pushvalidationinfo as shared_pushvalidationinfo from codatsyncexpenses 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 PushOption: display_name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName') }}) @@ -23,8 +22,8 @@ class PushOption: r"""The option type.""" description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) r"""A description of the property.""" - options: Optional[list[shared_pushoptionchoice.PushOptionChoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options') }}) - properties: Optional[dict[str, shared_pushoptionproperty.PushOptionProperty]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties') }}) + options: Optional[List[shared_pushoptionchoice.PushOptionChoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options') }}) + properties: Optional[Dict[str, shared_pushoptionproperty.PushOptionProperty]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties') }}) validation: Optional[shared_pushvalidationinfo.PushValidationInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoptionchoice.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoptionchoice.py index 5b3af1fb5..cf92fe45e 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoptionchoice.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoptionchoice.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOptionChoice: description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoptionproperty.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoptionproperty.py index d40e8f6ce..efbc9c9a3 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoptionproperty.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushoptionproperty.py @@ -7,11 +7,10 @@ from ..shared import pushvalidationinfo as shared_pushvalidationinfo from codatsyncexpenses 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 PushOptionProperty: description: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) @@ -22,8 +21,8 @@ class PushOptionProperty: r"""The property is required if `True`.""" type: shared_pushoptiontype.PushOptionType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""The option type.""" - options: Optional[list[shared_pushoptionchoice.PushOptionChoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options') }}) - properties: Optional[dict[str, PushOptionProperty]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties') }}) + options: Optional[List[shared_pushoptionchoice.PushOptionChoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options') }}) + properties: Optional[Dict[str, PushOptionProperty]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties') }}) validation: Optional[shared_pushvalidationinfo.PushValidationInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushvalidationinfo.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushvalidationinfo.py index f4bed61d7..4b100bbfd 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/pushvalidationinfo.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/pushvalidationinfo.py @@ -5,14 +5,13 @@ from ..shared import pushfieldvalidation as shared_pushfieldvalidation from codatsyncexpenses 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 PushValidationInfo: - information: Optional[list[shared_pushfieldvalidation.PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('information') }}) - warnings: Optional[list[shared_pushfieldvalidation.PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings') }}) + information: Optional[List[shared_pushfieldvalidation.PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('information') }}) + warnings: Optional[List[shared_pushfieldvalidation.PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/recordref.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/recordref.py index b08641300..8b98e09ba 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/recordref.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/recordref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class RecordRef: id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/security.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/security.py index a72246378..1d57f5faa 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/security.py +++ b/sync-for-expenses/src/codatsyncexpenses/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/sync-for-expenses/src/codatsyncexpenses/models/shared/supplementaldata.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/supplementaldata.py index 76c7d3b92..c65ba272a 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/supplementaldata.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/supplementaldata.py @@ -4,17 +4,16 @@ import dataclasses from codatsyncexpenses 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') }}) + content: Optional[Dict[str, Dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('content') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/supplier.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/supplier.py index 564313b52..95d12ce2f 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/supplier.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/supplier.py @@ -4,14 +4,14 @@ import dataclasses from ..shared import accountingaddresstype as shared_accountingaddresstype from ..shared import metadata as shared_metadata +from ..shared import supplementaldata as shared_supplementaldata from ..shared import supplierstatus as shared_supplierstatus from codatsyncexpenses import utils from dataclasses_json import Undefined, dataclass_json -from typing import Any, Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SupplierAccountingAddress: type: shared_accountingaddresstype.AccountingAddressType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) @@ -33,20 +33,6 @@ class SupplierAccountingAddress: @dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class SupplierSupplementalData: - 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') }}) - - - - -@dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Supplier: r"""> View the coverage for suppliers in the Data coverage explorer. @@ -57,7 +43,7 @@ class Supplier: """ status: shared_supplierstatus.SupplierStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""Status of the supplier.""" - addresses: Optional[list[SupplierAccountingAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses') }}) + addresses: Optional[List[SupplierAccountingAddress]] = 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') }}) r"""Name of the main contact for the supplier.""" @@ -74,7 +60,7 @@ class Supplier: registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber') }}) r"""Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.""" 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[SupplierSupplementalData] = 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. diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/supplierdetails.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/supplierdetails.py index 0a2874c75..5b1688721 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/supplierdetails.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/supplierdetails.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SupplierDetails: id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/suppliers.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/suppliers.py index 2f6a85258..d6bc04bb3 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/suppliers.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/suppliers.py @@ -6,11 +6,10 @@ from ..shared import supplier as shared_supplier from codatsyncexpenses 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 Suppliers: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) @@ -20,6 +19,6 @@ class Suppliers: r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) r"""Total number of items.""" - results: Optional[list[shared_supplier.Supplier]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_supplier.Supplier]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/synccompletewebhook.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/synccompletewebhook.py index c61a00b51..315f2690c 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/synccompletewebhook.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/synccompletewebhook.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncCompleteWebhook: r"""Webhook request body used to notify that a sync has completed.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/synccompletewebhookdata.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/synccompletewebhookdata.py index b9a47132b..5ca8ecf09 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/synccompletewebhookdata.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/synccompletewebhookdata.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncCompleteWebhookData: sync_date_range_finish_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('SyncDateRangeFinishUtc'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/syncfailedwebhook.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/syncfailedwebhook.py index a864fb36e..f82fac24d 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/syncfailedwebhook.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/syncfailedwebhook.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncFailedWebhook: r"""Webhook request body used to notify that a sync has failed.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/syncfailedwebhookdata.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/syncfailedwebhookdata.py index 4b583159b..ec3522c87 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/syncfailedwebhookdata.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/syncfailedwebhookdata.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncFailedWebhookData: failure_stage: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('FailureStage'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/syncinitiated.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/syncinitiated.py index 1c7b213e3..246b01a51 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/syncinitiated.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/syncinitiated.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncInitiated: sync_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncId'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/syncstartedwebhook.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/syncstartedwebhook.py index 02aa1d7d8..9e1bc1f29 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/syncstartedwebhook.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/syncstartedwebhook.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncStartedWebhookData: sync_date_range_finish_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('SyncDateRangeFinishUtc'), 'exclude': lambda f: f is None }}) @@ -62,7 +61,6 @@ class SyncStartedWebhookData: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SyncStartedWebhook: r"""Webhook request body used to notify that a sync has started.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/taxratemappinginfo.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/taxratemappinginfo.py index 8b978a300..8cc30382e 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/taxratemappinginfo.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/taxratemappinginfo.py @@ -6,7 +6,7 @@ from dataclasses_json import Undefined, dataclass_json from decimal import Decimal from enum import Enum -from typing import Optional +from typing import List, Optional class TaxRateMappingInfoValidTransactionTypes(str, Enum): PAYMENT = 'Payment' @@ -20,7 +20,6 @@ class TaxRateMappingInfoValidTransactionTypes(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TaxRateMappingInfo: code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('code') }}) @@ -33,7 +32,7 @@ class TaxRateMappingInfo: r"""Name of the tax rate in the accounting platform.""" total_tax_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalTaxRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Total (not compounded) sum of the components of a tax rate.""" - valid_transaction_types: Optional[list[TaxRateMappingInfoValidTransactionTypes]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validTransactionTypes') }}) + valid_transaction_types: Optional[List[TaxRateMappingInfoValidTransactionTypes]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validTransactionTypes') }}) r"""Supported transaction types for the account.""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/trackingcategorymappinginfo.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/trackingcategorymappinginfo.py index 0243b6621..aae15833a 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/trackingcategorymappinginfo.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/trackingcategorymappinginfo.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TrackingCategoryMappingInfo: has_children: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hasChildren'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/transaction.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/transaction.py index 7076d73cb..0d471ec97 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/transaction.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/transaction.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Transaction: integration_type: Optional[shared_integrationtype.IntegrationType] = dataclasses.field(default=shared_integrationtype.IntegrationType.EXPENSES, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('integrationType') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/transactions.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/transactions.py index 31dafb4e3..eaef82d9f 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/transactions.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/transactions.py @@ -6,11 +6,10 @@ from ..shared import transaction as shared_transaction from codatsyncexpenses 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 Transactions: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) @@ -20,6 +19,6 @@ class Transactions: r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) r"""Total number of items.""" - results: Optional[list[shared_transaction.Transaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_transaction.Transaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/updatecustomerresponse.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/updatecustomerresponse.py index d90070e60..642e2deeb 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/updatecustomerresponse.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/updatecustomerresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsyncexpenses 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 UpdateCustomerResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -47,7 +46,7 @@ class UpdateCustomerResponse: r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) r"""Push status code.""" - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) + 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: diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/updateexpenserequest.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/updateexpenserequest.py index ff0b8e04e..be02539c5 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/updateexpenserequest.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/updateexpenserequest.py @@ -7,11 +7,10 @@ from codatsyncexpenses import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Any, Optional +from typing import Any, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class UpdateExpenseRequestBankAccountReference: id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) @@ -21,7 +20,6 @@ class UpdateExpenseRequestBankAccountReference: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class UpdateExpenseRequest: issue_date: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('issueDate') }}) @@ -58,7 +56,7 @@ class UpdateExpenseRequest: | **EUR** | €20 | 1.134 | $22.68 | | **RUB** | ₽20 | 0.015 | $0.30 | """ - lines: Optional[list[shared_expensetransactionline.ExpenseTransactionLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines'), 'exclude': lambda f: f is None }}) + lines: Optional[List[shared_expensetransactionline.ExpenseTransactionLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines'), 'exclude': lambda f: f is None }}) r"""Array of transaction lines.""" merchant_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('merchantName'), 'exclude': lambda f: f is None }}) r"""Name of the merchant where the purchase took place""" diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/updateexpenseresponse.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/updateexpenseresponse.py index 85138f247..d5edf71c0 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/updateexpenseresponse.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/updateexpenseresponse.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class UpdateExpenseResponse: sync_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('syncId'), 'exclude': lambda f: f is None }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/updatesupplierresponse.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/updatesupplierresponse.py index 39baa2c3d..194339197 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/updatesupplierresponse.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/updatesupplierresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatsyncexpenses 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 UpdateSupplierResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -47,7 +46,7 @@ class UpdateSupplierResponse: r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) r"""Push status code.""" - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) + 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: diff --git a/sync-for-expenses/src/codatsyncexpenses/models/shared/validation.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/validation.py index 156285fe7..5941e6714 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/validation.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/validation.py @@ -5,15 +5,14 @@ from ..shared import validationitem as shared_validationitem from codatsyncexpenses 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') }}) - warnings: Optional[list[shared_validationitem.ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings') }}) + 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/sync-for-expenses/src/codatsyncexpenses/models/shared/validationitem.py b/sync-for-expenses/src/codatsyncexpenses/models/shared/validationitem.py index f3924baec..6b572e1db 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/shared/validationitem.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/shared/validationitem.py @@ -8,7 +8,6 @@ @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') }}) diff --git a/sync-for-expenses/src/codatsyncexpenses/models/webhooks/client_rate_limit_reached.py b/sync-for-expenses/src/codatsyncexpenses/models/webhooks/client_rate_limit_reached.py index 86623e9cf..20c411599 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/webhooks/client_rate_limit_reached.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/webhooks/client_rate_limit_reached.py @@ -6,7 +6,6 @@ from typing import Optional - @dataclasses.dataclass class ClientRateLimitReachedResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/webhooks/client_rate_limit_reset.py b/sync-for-expenses/src/codatsyncexpenses/models/webhooks/client_rate_limit_reset.py index ff28716a9..7e4b65419 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/webhooks/client_rate_limit_reset.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/webhooks/client_rate_limit_reset.py @@ -6,7 +6,6 @@ from typing import Optional - @dataclasses.dataclass class ClientRateLimitResetResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_complete.py b/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_complete.py index 315c6a38a..1c12d2a4f 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_complete.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_complete.py @@ -6,7 +6,6 @@ from typing import Optional - @dataclasses.dataclass class SyncCompleteResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_failed.py b/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_failed.py index b8dc4e1a0..2b6d068fd 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_failed.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_failed.py @@ -6,7 +6,6 @@ from typing import Optional - @dataclasses.dataclass class SyncFailedResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_started.py b/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_started.py index f51b1e720..03a077cdc 100755 --- a/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_started.py +++ b/sync-for-expenses/src/codatsyncexpenses/models/webhooks/sync_started.py @@ -6,7 +6,6 @@ from typing import Optional - @dataclasses.dataclass class SyncStartedResponse: content_type: str = dataclasses.field() diff --git a/sync-for-expenses/src/codatsyncexpenses/sdk.py b/sync-for-expenses/src/codatsyncexpenses/sdk.py index d80bb463b..a2aa0b421 100755 --- a/sync-for-expenses/src/codatsyncexpenses/sdk.py +++ b/sync-for-expenses/src/codatsyncexpenses/sdk.py @@ -15,6 +15,7 @@ from .transaction_status import TransactionStatus from codatsyncexpenses import utils from codatsyncexpenses.models import shared +from typing import Dict class CodatSyncExpenses: r"""Sync for Expenses: The API for Sync for Expenses. @@ -58,7 +59,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: @@ -71,7 +72,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 @@ -80,8 +81,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/sync-for-expenses/src/codatsyncexpenses/sdkconfiguration.py b/sync-for-expenses/src/codatsyncexpenses/sdkconfiguration.py index dff7a12d3..bb6c0a645 100755 --- a/sync-for-expenses/src/codatsyncexpenses/sdkconfiguration.py +++ b/sync-for-expenses/src/codatsyncexpenses/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 = [ @@ -19,14 +20,14 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = 'prealpha' - sdk_version: str = '3.1.0' - gen_version: str = '2.146.1' - user_agent: str = 'speakeasy-sdk/python 3.1.0 2.146.1 prealpha codat-sync-for-expenses' + sdk_version: str = '4.0.0' + gen_version: str = '2.159.2' + user_agent: str = 'speakeasy-sdk/python 4.0.0 2.159.2 prealpha codat-sync-for-expenses' 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/sync-for-expenses/src/codatsyncexpenses/sync.py b/sync-for-expenses/src/codatsyncexpenses/sync.py index 2118f6d44..226a960c6 100755 --- a/sync-for-expenses/src/codatsyncexpenses/sync.py +++ b/sync-for-expenses/src/codatsyncexpenses/sync.py @@ -3,7 +3,7 @@ from .sdkconfiguration import SDKConfiguration from codatsyncexpenses import utils from codatsyncexpenses.models import errors, operations, shared -from typing import Optional +from typing import List, Optional class Sync: r"""Trigger and monitor expense syncs to accounting software.""" @@ -247,7 +247,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[list[shared.CompanySyncStatus]]) + out = utils.unmarshal_json(http_res.text, Optional[List[shared.CompanySyncStatus]]) res.company_sync_statuses = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) diff --git a/sync-for-expenses/src/codatsyncexpenses/utils/retries.py b/sync-for-expenses/src/codatsyncexpenses/utils/retries.py index 2138c1b5e..25f49a1f2 100755 --- a/sync-for-expenses/src/codatsyncexpenses/utils/retries.py +++ b/sync-for-expenses/src/codatsyncexpenses/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/sync-for-expenses/src/codatsyncexpenses/utils/utils.py b/sync-for-expenses/src/codatsyncexpenses/utils/utils.py index 4388f3b74..ccfad9f7a 100755 --- a/sync-for-expenses/src/codatsyncexpenses/utils/utils.py +++ b/sync-for-expenses/src/codatsyncexpenses/utils/utils.py @@ -9,7 +9,8 @@ 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 @@ -19,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) @@ -69,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') @@ -93,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') @@ -145,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') @@ -174,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 @@ -196,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( @@ -222,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) @@ -237,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: @@ -269,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: @@ -303,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': @@ -313,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 @@ -330,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 @@ -348,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 @@ -379,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) @@ -424,7 +425,7 @@ def serialize_request_body(request: dataclass, request_field_name: str, nullable request_val) -def serialize_content_type(field_name: str, media_type: str, request: dataclass, encoder=None) -> 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, encoder), None if re.match(r'multipart\/.*', media_type) is not None: @@ -440,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: @@ -482,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 @@ -493,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 = [] @@ -514,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): @@ -533,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: @@ -557,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 @@ -584,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: @@ -597,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: @@ -651,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(): @@ -666,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: @@ -779,7 +780,7 @@ def decimaldecoder(val): def map_encoder(optional: bool, value_encoder: Callable): - def map_encode(val: dict): + def map_encode(val: Dict): if optional and val is None: return None @@ -793,7 +794,7 @@ def map_encode(val: dict): def map_decoder(value_decoder: Callable): - def map_decode(val: dict): + def map_decode(val: Dict): decoded = {} for key, value in val.items(): decoded[key] = value_decoder(value) @@ -804,7 +805,7 @@ def map_decode(val: dict): def list_encoder(optional: bool, value_encoder: Callable): - def list_encode(val: list): + def list_encode(val: List): if optional and val is None: return None @@ -818,7 +819,7 @@ def list_encode(val: list): def list_decoder(value_decoder: Callable): - def list_decode(val: list): + def list_decode(val: List): decoded = [] for value in val: decoded.append(value_decoder(value)) @@ -846,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']: @@ -863,3 +864,9 @@ 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